description: Tooltip for the main toolbar icon.

type: string


The popup appears when the user clicks the icon.


description: FIXME: String form is deprecated.


description: Icon for the main toolbar.

type: object


key: global

description: Whether this command should work while Chrome does not have focus. Keyboard shortcut suggestions for global commands are limited to Ctrl+Shift+[0..9]

type: boolean


description: This introduces some fairly strict policies that will make extensions more secure by default, and provides you with the ability to create and enforce rules governing the types of content that can be loaded and executed by your extensions and applications.

format: content-security-policy

default: script-src 'self'; object-src 'self'


key: resources

description: An array of resources to be exposed. Resources are specified as strings and may contain * for wildcard matches. For example, "/images/*" exposes everything in the extension's /images directory recursively while "*.png" exposes all PNG files.

type: array


key: matches

description: A list of URL match patterns specifying which pages can access the resources. Only the origin is used to match URLs; subdomains patterns (*.google.com) and paths are ignored.


description: A list of extension IDs, specifying which extensions can access the resources.


description: If true, only allow resources to be accessible through dynamic ID. The dynamic ID is generated per session. It's regenerated on browser restart or extension reload.


key: background

description: The background page is an HTML page that runs in the extension process. It exists for the lifetime of your extension, and only one instance of it at a time is active.


key: persistent

description: When false, makes the background page an event page (loaded only when needed).


key: page

description: Specify the HTML of the background page.


key: scripts

description: A background page will be generated by the extension system that includes each of the files listed in the scripts property.


Use browser actions to put icons in the main Google Chrome toolbar, to the right of the address bar. In addition to its icon, a browser action can also have a tooltip, a badge, and a popup.


Use the chrome.pageAction API to put icons inside the address bar. Page actions represent actions that can be taken on the current page, but that aren't applicable to all pages.


description: An array of strings specifying the paths (relative to the package root) of packaged resources that are expected to be usable in the context of a web page.


description: One integer specifying the version of the manifest file format your package requires.

type: number


key: name

description: The name of the extension


key: version

description: One to four dot-separated integers identifying the version of this extension.


description: Specifies the subdirectory of _locales that contains the default strings for this extension.

default: en


key: description

description: A plain text description of the extension


key: icons

description: One or more icons that represent the extension, app, or theme. Recommended format: PNG; also BMP, GIF, ICO, JPEG.


Used as the favicon for an extension's pages and infobar.


Used on the extension management page (chrome://extensions).


Used during installation and in the Chrome Web Store.


description: Override pages are a way to substitute an HTML file from your extension for a page that Google Chrome normally provides.


key: bookmarks

description: The page that appears when the user chooses the Bookmark Manager menu item from the Chrome menu or, on Mac, the Bookmark Manager item from the Bookmarks menu. You can also get to this page by entering the URL chrome://bookmarks.


key: history

description: The page that appears when the user chooses the History menu item from the Chrome menu or, on Mac, the Show Full History item from the History menu. You can also get to this page by entering the URL chrome://history.


key: newtab

description: The page that appears when the user creates a new tab or window. You can also get to this page by entering the URL chrome://newtab.


key: commands

description: Use the commands API to add keyboard shortcuts that trigger actions in your extension, for example, an action to open the browser action or send a command to the extension.


description: Content scripts are JavaScript files that run in the context of web pages.

enum: ISOLATED MAIN

default: ISOLATED


description: Specifies which pages this content script will be injected into.


description: Excludes pages that this content script would otherwise be injected into.


key: css

description: The list of CSS files to be injected into matching pages. These are injected in the order they appear in this array, before any DOM is constructed or displayed for the page.


key: js

description: The list of JavaScript files to be injected into matching pages. These are injected in the order they appear in this array.


key: world

description: The JavaScript world for a script to execute within.


description: Controls when the files in js are injected.


description: Controls whether the content script runs in all frames of the matching page, or only the top frame.


description: Applied after matches to include only those URLs that also match this glob. Intended to emulate the @include Greasemonkey keyword.


description: Applied after matches to exclude URLs that match this glob. Intended to emulate the @exclude Greasemonkey keyword.


description: Whether to insert the content script on about:blank and about:srcdoc.


A DevTools extension adds functionality to the Chrome DevTools. It can add new UI panels and sidebars, interact with the inspected page, get information about network requests, and more.


description: Declares which extensions, apps, and web pages can connect to your extension via runtime.connect and runtime.sendMessage.


key: items

description: The IDs of extensions or apps that are allowed to connect. If left empty or unspecified, no extensions or apps can connect.


description: The URL patterns for web pages that are allowed to connect. This does not affect content scripts. If left empty or unspecified, no web pages can connect.


description: Indicates that the extension would like to make use of the TLS channel ID of the web page connecting to it. The web page must also opt to send the TLS channel ID to the extension via setting includeTlsChannelId to true in runtime.connect's connectInfo or runtime.sendMessage's options.


description: You can use this API to enable users to upload files to your website.


key: id

description: Used by event handling code to differentiate between multiple file handlers


description: What the button will display.


description: Filetypes to match.


The URL of the homepage for this extension.


key: incognito

description: Specify how this extension will behave if allowed to run in incognito mode.

enum: spanning split not_allowed

default: spanning


description: Allows your extension to handle keystrokes, set the composition, and manage the candidate window.

required: name type id description language layouts


key: key

description: This value can be used to control the unique ID of an extension, app, or theme when it is loaded during development.


The version of Chrome that your extension, app, or theme requires, if any.


description: One or more mappings from MIME types to the Native Client module that handles each type.


key: path

description: The location of a Native Client manifest (a .nmf file) within the extension directory.


The MIME type for which the Native Client module will be registered as content handler.


description: Use the Chrome Identity API to authenticate users: the getAuthToken for users logged into their Google Account and the launchWebAuthFlow for users logged into a non-Google account.


description: You need to register your app in the Google APIs Console to get the client ID.


description: Whether the app or extension is expected to work offline. When Chrome detects that it is offline, apps with this field set to true will be highlighted on the New Tab page.


key: omnibox

description: The omnibox API allows you to register a keyword with Google Chrome's address bar, which is also known as the omnibox.


key: keyword

description: The keyword that will trigger your extension.


Use the chrome.permissions API to request declared optional permissions at run time rather than install time, so users understand why the permissions are needed and grant only those that are necessary.


To allow users to customize the behavior of your extension, you may wish to provide an options page. If you do, a link to it will be provided from the extensions management page at chrome://extensions. Clicking the Options link opens a new tab pointing at your options page.


description: To allow users to customize the behavior of your extension, you may wish to provide an options page. If you do, an Options link will be shown on the extensions management page at chrome://extensions which opens a dialogue containing your options page.


key: page

description: The path to your options page, relative to your extension's root.


description: If true, a Chrome user agent stylesheet will be applied to your options page. The default value is false, but we recommend you enable it for a consistent UI with Chrome.


description: If true, your extension's options page will be opened in a new tab rather than embedded in chrome://extensions. The default is false, and we recommend that you don't change it. This is only useful to delay the inevitable deprecation of the old options UI! It will be removed soon, so try not to use it. It will break.


key: permissions

description: Permissions help to limit damage if your extension or app is compromised by malware. Some permissions are also displayed to users before installation, as detailed in Permission Warnings.


key: requirements

description: Technologies required by the app or extension. Hosting sites such as the Chrome Web Store may use this list to dissuade users from installing apps or extensions that will not work on their computer.


description: The '3D' requirement denotes GPU hardware acceleration.


key: features

description: List of the 3D-related features your app requires.


key: plugins

description: Indicates if an app or extension requires NPAPI to run. This requirement is enabled by default when the manifest includes the 'plugins' field.


key: sandbox

description: Defines an collection of app or extension pages that are to be served in a sandboxed unique origin, and optionally a Content Security Policy to use with them.

default: sandbox allow-scripts allow-forms


description: The short name is typically used where there is insufficient space to display the full name.


If you publish using the Chrome Developer Dashboard, ignore this field. If you host your own extension or app: URL to an update manifest XML file.


description: Register itself as a speech engine.

enum: start word sentence marker end error


key: voices

description: Voices the extension can synthesize.


description: Identifies the name of the voice and the engine used.


key: lang

description: Almost always, a voice can synthesize speech in just a single language. When an engine supports more than one language, it can easily register a separate voice for each language.


key: gender

description: If your voice corresponds to a male or female voice, you can use this parameter to help clients choose the most appropriate voice for their application.


description: Events sent to update the client on the progress of speech synthesis.


description: In addition to the version field, which is used for update purposes, version_name can be set to a descriptive version string and will be used for display purposes if present.


key: background

description: The background page is an HTML page that runs in the extension process. It exists for the lifetime of your extension, and only one instance of it at a time is active.


description: The service worker js file.


key: action

description: Used to control the toolbar button for your extension in Chrome's UI.


This policy covers pages in your extension, including html files and service workers.


description: This policy covers any sandboxed extension pages that your extension uses.


description: An array of objects that declare resource access rules. Each object maps an array of extension resources to an array of URLs and/or extension IDs that can access those resources.


key: manifest

description: A stable URL that describes the latest release version of your manifest file. This URL is used for automatic system installation in the Foundry VTT setup screen. This manifest URL is consulted during the system update check to see whether a new version is available for download. It is important that this address remain stable, otherwise updates will not be detected.


key: initiative

description: Specifies the default initiative formula if applicable to the system.


key: gridDistance

description: Integer specifying the default size of a grid space.


key: gridUnits

description: A label that specifies the default unit of measure used by the system.

examples: ft m


key: primaryTokenAttribute

description: An attribute path within the system data model that points to an object that contains both a `value` and a `max` key. The prototype Token will automatically set its primary attribute to this value.


key: secondaryTokenAttribute

description: An attribute path within the system data model that points to an object that contains both a `value` and a `max` key. The prototype Token will automatically set its secondary attribute to this value.


key: typescript

description: Is project written in Typescript or not


key: exceptionHandlerNamespace

description: Http server exception handler namespace


key: assetsDriver

description: The driver to use for assets bundling

enum: encore vite fake


description: Schema for package definitions.

enum:
.NET
1С:Enterprise
AWK
Ada
Angular
Ansible
Antlers
Apex
Arduino
Assembly
Astro
Azure Pipelines
Bash
Bazel
Beancount
Bicep
Blade
BrighterScript
C
C#
C++
CMake
CQL
CSS
Clarity
Clojure
ClojureScript
CodeQL
Crystal
Csh
Cucumber
Cue
D
DOT
Dart
Dhall
Django
Docker
Drools
Elixir
Elm
Ember
Emmet
Erg
Erlang
F#
Fennel
Flow
Flux
Fortran
Gleam
Glimmer
Go
Gradle
GraphQL
Groovy
HAML
HTML
Handlebargs
Handlebars
Haskell
Haxe
Helm
Hoon
JSON
JSX
Java
JavaScript
Jinja
Jq
Jsonnet
Julia
Kotlin
Ksh
LESS
LaTeX
Lelwel
Liquid
Lua
Luau
Markdown
Metamath Zero
Mksh
Move
Mustache
Nginx
Nickel
Nim
Nix
Nunjucks
OCaml
Odin
OneScript
OpenAPI
OpenCL
OpenEdge
OpenFOAM
OpenSCAD
PHP
Perl
PowerShell
Prisma
Progress
Protobuf
Puppet
PureScript
Python
R
Raku
ReScript
Reason
Robot Framework
Ruby
Rust
SCSS
SQL
Salt
Sass
Scala
Sh
Shell
Slint
Smithy
Standard ML
Snakemake
Solidity
Sphinx
Starlark
Stylelint
Svelte
SystemVerilog
TOML
Teal
Terraform
Text
Twig
TypeScript
Typst
V
Vala
Veryl
VimScript
Visualforce
Vue
WGSL
XML
YAML
YARA
Zig
Zsh

enum: Compiler DAP Formatter LSP Linter Runtime

required: id download

required: id build

required: id asset

required: constraint asset

required: target file

format: uri

required: name description homepage licenses languages categories source


description: List of platforms supported by the cargo package.


description: Extra gem packages required by the main package to function.


description: List of platforms supported by the gem package.


key: run

description: The shell script to run. Platform sensitive (bash on Unix, powershell on Windows).


key: staged

description: Whether to run the build script in a staging location (defaults to true).


description: Extra golang packages required by the main package to function.


description: Extra npm packages required by the main package to function.


description: Extra pypi packages required by the main package to function.


description: List of platforms supported by the pypi package.


key: lsp

description: A URL to where the LSP JSON schema can be downloaded from. If the provided URL is a VSCode package.json you MUST prefix the url with vscode:


key: name

description: The package name. MUST be unique within the registry it belongs to.


key: description

description: The description of the package. Usually sourced upstream.


key: homepage

description: A URL to the package's homepage.


key: helmDefaults

description: Default values to set for args along with dedicated keys that can be set by contributors, cli args take precedence over these.


key: historyMax

description: limit the maximum number of revisions saved per release. Use 0 for no limit.


key: devel

description: if used with charts museum allows to pull unstable charts for deployment, for example: if 1.2.3 and 1.2.4-dev versions exist and set to true, 1.2.4-dev will be pulled (default false)


key: skipDeps

description: When set to `true`, skips running `helm dep up` and `helm dep build` on this release's chart.


key: apiVersions

description: Configure a fixed list of API versions to pass to 'helm template' via the --api-versions flag with the below:


key: environments

description: The list of environments managed by helmfile.


key: commonLabels

description: these labels will be applied to all releases in a Helmfile. Useful in templating if you have a helmfile per environment or customer and don't want to copy the same label to each release


key: helmBinary

description: Path to alternative helm binary (--helm-binary)


key: releases

description: Helmfile runs various helm commands to converge the current state in the live cluster to the desired state defined here.


key: homepageTrigger

description: The Google Workspace add-on manifest configuration for homepage triggers.


key: enabled

description: Whether or not homepage (non-contextual) cards are enabled in Calendar. Defaults to true.


key: runFunction

description: The name of the function to run when this trigger fires. You must implement this function in your add-on project. This function must build and return an array of Card objects.


key: runtimeVersion

description: Version of the server to use when executing this project.

default: STABLE


key: timeZone

description: The script time zone in one of the available ZoneId values such as "America/Denver".


key: dependencies

description: A list of advanced services and libraries.

required: userSymbol serviceId version

default: Sheets

default: sheets

required: userSymbol libraryId version


key: enabledAdvancedServices

description: The list of advanced services enabled for use by the script project.


key: items

description: A single advanced service.


key: userSymbol

description: The identifier used to refer to this service in the code of the Apps Script project.


key: serviceId

description: The identifier of the service that is shown in the API discovery document (e.g., drive).


key: version

description: The enabled version of the service (e.g., "v1").


key: libraries

description: The list of libraries used by the script project.


description: A single library.


description: The label that is used in the script project code to refer to this library.


key: libraryId

description: The script ID of the library's script project. You can find a script ID in the library script's URL or in the script editor by selecting **File > Project properties**.


description: The version of the library that is used by the script. This is either a version number or stable, meaning the last version created.


key: developmentMode

description: If true, version is ignored and the script uses the current library project saved code, even if that code has not been saved to a new version.


key: webapp

description: The script project's web app configuration. Only used if the project is deployed as a web app.

enum: MYSELF DOMAIN ANYONE ANYONE_ANONYMOUS

default: MYSELF


key: access

description: The levels of permission for running the web app.


key: executeAs

description: The identity under which the web app executes.


key: exceptionLogging

description: The location where exceptions are logged.


key: oauthScopes

description: The definition of authorization scopes used by the script project.


key: urlFetchWhitelist

description: A list of HTTPS URL prefixes. If present, any URL endpoint fetched must match one of the prefixes in this list. This can help to protect user data.

format: hostname


key: executionApi

description: The script project's API executable configuration. Only used if the project is deployed for API execution.


description: Determines who has permission to run the script from the API.


key: sheets

description: Defines manifest values specific to Sheets.

default: My Macro

default: myFunction

required: menuName functionName defaultShortcut


key: macros

description: A list of defined macros and their associated properties.


description: A defined macros and it's associated properties.


key: menuName

description: The name of the macro as it appears in the Google Sheets UI.


key: functionName

description: The name of the Apps Script function that executes the macro. By default this matches the menuName for functions automatically created, but this is not a requirement.


key: defaultShortcut

description: Defines the keyboard shortcut that executes the macro. This must be of the form Ctrl+Alt+Shift+Number, where Number is a single-digit. Macros without shortcuts can only be executed from the Tools > Macros menu.


key: dataStudio

description: Data Studio add-on manifest.

required: name logoUrl company supportUrl description


key: name

description: Display name for add-on.


key: logoUrl

description: URL for logo image of add-on.


key: company

description: Company name for the add-on.


key: supportUrl

description: URL for support information of the add-on.


key: description

description: Short description about the add-on.


key: sources

description: List of sources or services that can be accessed with this add-on.


key: items

description: A single source type.


key: templates

description: Map of template name to report ID.


key: shortDescription

description: Even shorter description used in gallery cards. Only a maximum of 114 characters will be shown on the card.


key: authType

description: List of AuthTypes supported.


description: Types of Authorization supported by the add-on.


key: privacyPolicyUrl

description: Url for privacy policy information about the add-on.


key: termsOfServiceUrl

description: Url for terms of service information about the add-on.


key: addOns

description: G Suite Add-ons

required: logoUrl name

enum: METADATA READ WRITE READ_WRITE


key: common

description: Common properties between all G Suite add-on types.


description: The add-on name.


description: The logo URL.


key: layoutProperties

description: Layout properties.


key: primaryColor

description: The color of toolbar. Defaults to grey (#424242).


key: secondaryColor

description: The default color of buttons. Defaults to the primary color (if it is set); otherwise defaults to blue (#2196F3).


key: homepageTrigger

description: Homepage trigger data


key: enabled

description: Whether or not homepage (non-contextual) cards are enabled. Defaults to true.


key: runFunctions

description: The name of the function to run


key: universalActions

description: Universal add-on actions


description: Actions


key: label

description: The action label.


key: openLink

description: The link's URL


key: runFunction

description: Required for each defined universal action if openLink is not present. If provided, the name of the Apps Script function that executes when the user selects this action.


key: openLinkUrlPrefixes

description: Link prefixes.


key: items

description: A link prefix.


key: useLocaleFromApp

description: Use the locale from the host application?


key: gmail

description: Gmail add-on metadata.


key: contextualTriggers

description: Contextual triggers.


description: A contextual trigger.


key: onTriggerFunction

description: The name of the Apps Script function that executes when this contextual trigger fires (that is, when a message is opened in Gmail). The function specified here must build and return an array of Card objects.


key: unconditional

description: Used to specify that the contextual trigger is fired for all Gmail messages. This is currently the only option, so this should always be an empty object.


description: The trigger function specification for creating the add-on homepage in the Gmail host.


description: Whether or not homepage (non-contextual) cards are enabled in Gmail. Defaults to true.


description: The name of the function to run when this trigger fires. You must implement this function in your add-on project. This function must build and return an array of Card objects.


key: calendar

description: Calendar add-on metadata.


description: The trigger function specification for creating the add-on homepage in the Calendar host.


description: Whether or not homepage (non-contextual) cards are enabled in Calendar. Defaults to true.


key: eventOpenTrigger

description: When a Calendar event is opened


description: Event hander function


key: eventUpdateTrigger

description: When a Calendar event is updated


key: eventAccess

description: Handler access to Calendar event


key: sheets

description: Configurations for the Google Workspace Add-on's appearance and behavior within the Sheets host application.


key: onFileScopeGrantedTrigger

description: A configuration for a contextual trigger that fires when the add-on presents the request file scope dialog.


key: ports

description: List of exposed ports.

type: number string

enum: open-browser open-preview notify ignore

enum: private public

default: private

enum: http https


key: port

description: The port number (e.g. 1337) or range (e.g. 3000-3999) to expose.


key: onOpen

description: What to do when a service on this port was detected. 'notify' (default) will show a notification asking the user what to do. 'open-browser' will open a new browser tab. 'open-preview' will open in the preview on the right of the IDE. 'ignore' will do nothing.


key: visibility

description: Whether the port visibility should be private or public. 'private' (default) will only allow users with workspace access to access the port. 'public' will allow everyone with the port URL to access the port.


key: name

description: Port name.


key: protocol

description: The protocol of workspace port.


key: description

description: A description to identify what is this port used for.


key: tasks

description: List of tasks to run on start. Each task will open a terminal in the IDE.

deprecationMessage: Deprecated. Please use `init` task instead. See https://www.gitpod.io/docs/config-start-tasks.

enum: bottom main left right

enum: split-left split-right tab-before tab-after


description: Name of the task. Shown on the tab of the opened terminal.


key: before

description: A shell command to run before `init` and the main `command`. This command is executed on every start and is expected to terminate. If it fails, the following commands will not be executed.


key: init

description: A shell command to run between `before` and the main `command`. This command is executed only on after initializing a workspace with a fresh clone, but not on restarts and snapshots. This command is expected to terminate. If it fails, the `command` property will not be executed.


key: prebuild

description: A shell command to run after `before`. This command is executed only on during workspace prebuilds. This command is expected to terminate. If it fails, the workspace build fails.


key: command

description: The main shell command to run after `before` and `init`. This command is executed last on every start and doesn't have to terminate.


key: env

description: Environment variables to set.


key: openIn

description: The panel/area where to open the terminal. Default is 'bottom' panel.


key: openMode

description: The opening mode. Default is 'tab-after'.


key: image

description: The Docker image to run your workspace in.

type: object string

default: gitpod/workspace-full


key: file

description: Relative path to a docker file.


key: context

description: Relative path to the context path (optional). Should only be set if you need to copy files into the image.


key: additionalRepositories

description: List of additional repositories that are part of this project.


key: url

description: The url of the git repository to clone. Supports any context URLs.


key: checkoutLocation

description: Path to where the repository should be checked out relative to `/workspace`. Defaults to the simple repository name.


key: mainConfiguration

description: The main repository, containing the dev environment configuration.


key: workspaceLocation

description: Path to where the IDE's workspace should be opened. Supports vscode's `*.code-workspace` files.


key: gitConfig

description: Git config values should be provided in pairs. E.g. `core.autocrlf: input`. See https://git-scm.com/docs/git-config#_values.


key: github

description: Configures Gitpod's GitHub app

type: boolean object

type: boolean string


key: prebuilds

description: Set to true to enable workspace prebuilds, false to disable them. Defaults to true.


key: master

description: Enable prebuilds for the default branch (typically master). Defaults to true.


key: branches

description: Enable prebuilds for all branches. Defaults to false.


key: pullRequests

description: Enable prebuilds for pull-requests from the original repo. Defaults to true.


key: pullRequestsFromForks

description: Enable prebuilds for pull-requests from any repo (e.g. from forks). Defaults to false.


key: addBadge

description: Add a Review in Gitpod badge to pull requests. Defaults to true.


key: addCheck

description: Add a commit check to pull requests. Set to 'fail-on-error' if you want broken prebuilds to block merging. Defaults to true.


key: addLabel

description: Add a label to a PR when it's prebuilt. Set to true to use the default label (prebuilt-in-gitpod) or set to a string to use a different label name. This is a beta feature and may be unreliable. Defaults to false.


key: vscode

description: Configure VS Code integration


key: extensions

description: List of extensions which should be installed for users of this workspace. The identifier of an extension is always '${publisher}.${name}'. For example: 'vscode.csharp'.


key: jetbrains

description: Configure JetBrains integration

deprecationMessage: The 'jetbrains' property is experimental.


key: plugins

description: List of plugins which should be installed for all JetBrains product for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.


key: intellij

description: Configure IntelliJ integration


key: goland

description: Configure GoLand integration


key: pycharm

description: Configure PyCharm integration


key: phpstorm

description: Configure PhpStorm integration


key: rubymine

description: Configure RubyMine integration


key: webstorm

description: Configure WebStorm integration


key: rider

description: Configure Rider integration


key: clion

description: Configure CLion integration


key: experimentalNetwork

description: Experimental network configuration in workspaces (deprecated). Enabled by default

deprecationMessage: The 'experimentalNetwork' property is deprecated.


key: coreDump

description: Configure the default action of certain signals is to cause a process to terminate and produce a core dump file, a file containing an image of the process's memory at the time of termination. Disabled by default.

deprecationMessage: The 'coreDump' property is experimental.


key: softLimit

description: upper limit on the size of the core dump file that will be produced if it receives a core dump signal


key: hardLimit

description: the hard limit acts as a ceiling for the soft limit. For more details please check https://man7.org/linux/man-pages/man2/getrlimit.2.html


description: List of plugins which should be installed for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.


key: prebuilds

description: Enable warming up of JetBrains backend in prebuilds.

enum: stable latest both


key: version

description: Whether only stable, latest or both versions should be warmed up. Default is stable only.


key: vmoptions

description: Configure JVM options, for instance '-Xmx=4096m'.


key: workflows

description: You can use codemagic.yaml to define several workflows for building a project. Each workflow describes the entire build pipeline from triggers to publishing. For example, you may want to have separate workflows for developing, testing and publishing the app.

errorMessage: Incorrect type. Expected a dictionary


key: InstanceType

description: Build machine type to use for the build.


key: DistributionType

description: An enumeration.


key: profile

description: Profile reference found in Team settings -> Code signing identities


description: Name of the variable containing the profile path


key: certificate

description: Certificate reference found in Team settings -> Code signing identities


description: Name of the variable containing the certificate path


description: Type of certificates and profiles to fetch from Code signing identities

errorMessage: Incorrect distribution type. Expected one of ad_hoc, app_store, development, enterprise


description: Bundle identifier of certificates and profiles to fetch from Code signing identities


description: Provisioning profiles to fetch from Code signing identities

errorMessage: Incorrect type. Expected list of strings or dictionaries


key: certificates

description: Certificates to fetch from Code signing identities


key: keystore

description: Keystore reference found in Team settings -> Code signing identities


description: Name of the variable containing the keystore path


description: Name of the variable containing the keystore password


description: Name of the variable containing the key alias


description: Name of the variable containing the key password


description: Define the channel name, version (e.g. v1.13.4) or 'fvm' if using Flutter Version Management.

type: integer


key: flavor

description: The name of the flavor to use when using FVM.


key: vars

description: Define your environment variables.

errorMessage: Incorrect type. Expected a dictionary with integer, float, boolean or nonempty string as values


key: groups

description: Define environment variable group names that have been configured in app or team settings.

errorMessage: Incorrect type. Expected a list of nonempty strings


description: iOS code signing identities configured under Team settings


description: Android code signing identities configured under Team settings

errorMessage: Incorrect type. Expected a list


key: xcode

description: Define latest, edge or version (e.g. 11.2).

default: latest

errorMessage: Incorrect type. Expected an integer, float or nonempty string


key: cocoapods

description: Define default or version (e.g. 1.9.1).

default: default


key: node

description: Define default, latest, current, lts, carbon (or another stream), nightly or version (e.g. 12.4.0).


key: npm

description: Define default, latest, next, lts or version (e.g. 6.13.7).


key: ndk

description: Define default or revision (e.g. r19c).


key: java

description: Define default, or platform version (e.g. 11).


key: ruby

description: Define default, or platform version (e.g. 2.5.1).


key: flutter

errorMessage: Incorrect type. Expected an integer, float, nonempty string or dictionary


key: unity

description: Define exact version (e.g. 2020.3.15f2).

errorMessage: Incorrect type. Expected a nonempty string


description: Specify the name of the App Store Connect API key to be used from team or personal integrations to authenticate actions for code signing and publishing.


description: For example, you may consider caching the following paths: "$FLUTTER_ROOT/.pub-cache" for Dart cache, "$HOME/.gradle/caches" for gradle cache, "$HOME/Library/Caches/CocoaPods" for CocoaPods cache.


key: TriggeringEvent

description: Currently supported events are push, pull_request.

enum: push pull_request tag


key: pattern

description: The pattern can also be passed with an environment variable.

errorMessage: Incorrect type. Expected an integer, float, boolean or nonempty string


key: include

description: If set to false, the matching branches will not be watched for triggering events.


key: source

description: The variable is ignored for events other than pull_request.


description: If set to false, the matching tags will not be watched for triggering events.


key: events

description: Currently supported events are push, pull_request, tag.


description: A branch pattern can match the name of a particular branch, or you can use wildcard symbols to create a pattern that matches several branches. Note that for pull request builds you have to specify whether the watched branch is the source or the target of the pull request.

errorMessage: Incorrect type. Expected a not empty list of dictionaries


description: A tag pattern can match the name of a particular tag, or you can use wildcard symbols to create a pattern that matches several tags.


description: To avoid running builds on outdated commits, set cancel_previous_builds to true to automatically cancel all ongoing and queued builds triggered by webhooks on push or pull request commit when a more recent build has been triggered for the same branch.


key: changeset

description: List of paths or path patterns to watch for changes, proceed if changes are detected.


key: condition

description: Check if condition evaluates to true before proceeding with building workflow or script.


key: ScriptOnFailure

description: The only supported action is to proceed directly to publishing.


key: script

description: By default the script will be run in the Bash shell. You can run the script in other languages by defining a shebang line in the beginning.


key: name

description: A descriptive script name can be provided to be shown in the UI. If not passed, the first line of your script will be shown in the UI for the script block.


description: You can display test results visually in the build overview. The value can be an absolute path, or a path relative to $CM_BUILD_DIR (in this case the patterns will be searched recursively). Supported test report formats are Junit XML and .JSON for Flutter's --machine report.


description: If set to true, the workflow will continue to run even if the script fails.


key: when

description: All conditions below should be met in order for script to continue.


description: Specify directory where this script will be executed. It overrides global workflow working directory.


key: success

description: Set to false to not receive a notification when a build succeeds.


key: failure

description: Set to false to not receive a notification when a build fails.


key: recipients

description: Provide valid email addresses here.

format: email


key: notify

description: Allows to turn on or turn off email notification on build success or failure.


key: channel

description: To allow publishing to private channels, invite the Codemagic Slack app to the channels by writing @codemagic in the channel.


description: When you set notify_on_build_start to true, the channel will be notified when a build starts.


description: Allows to turn on or turn off slack notification on build success or failure.


key: AppStoreConnectAuth

description: An enumeration.


key: AppStoreReleaseType

description: An enumeration.

enum: MANUAL AFTER_APPROVAL SCHEDULED


key: auth

description: Accepted value: integration. When defined, the API key info inherited from integrations is used for authenticating with App Store Connect. If you omit this key-value pair, you must define API key, key identifier and issuer identifier explicitly.


description: App Store Connect API key in .p8 format that is used for authenticating application packages validation and upload to App Store Connect. It is required for TestFlight submission.

errorMessage: Incorrect type. Expected a string in the form of an encrypted value, environment variable or plain text


description: App Store Connect API key identifier that is used for authenticating application packages validation and upload to App Store Connect. It is required for TestFlight submission.


description: App Store Connect API key issuer identifier that is used for authenticating application packages validation and upload to App Store Connect. It is required for TestFlight submission.


description: The email address used to log in to App Store Connect. It can also be passed with an environment variable.

errorMessage: Incorrect type. Expected a string in the form of an encrypted value, environment variable or plain text email


key: password

description: App-specific passwords allow you to sign in to your account securely when you use third-party apps with your Apple ID. e.g. ujlw-ypqu-dgzw-vyog. The plain or encrypted password can also be passed with en environment variable.

errorMessage: Incorrect type. Expected a string in the form of an encrypted value, environment variable or plain text password


description: Submit published build to Testflight. Requires authentication using App Store Connect API key.


description: Expire previously submitted build that is in review before submitting published build to Testflight. Requires authentication using App Store Connect API key.


description: Published build will be made available to the specified Beta groups in App Store Connect. TestFlight submission is required in order to release builds to the groups of beta testers.


description: Submit published build to App Store review. Requires authentication using App Store Connect API key.


description: Cancel previous submissions before submitting application package to App Store review. Requires authentication using App Store Connect API key.


description: Choose when to release the app. You can either manually release the app at a later date on the App Store Connect website, or the app version can be automatically released right after it has been approved by App Review.

errorMessage: Incorrect release type. Expected one of MANUAL, AFTER_APPROVAL, SCHEDULED


description: Specify earliest return date for scheduled release type. Timezone aware ISO8601 timestamp, for example 2021-11-10T14:55:41+00:00.

errorMessage: Not a valid timezone aware ISO8601 timestamp

format: date-time


key: copyright

description: The name of the person or entity that owns the exclusive rights to your app, preceded by the year the rights were obtained (for example, "2008 Acme Inc."). Do not provide a URL.

errorMessage: Incorrect type. Expected a string in the form of an environment variable or plain text


key: credentials

description: The encrypted JSON key file or the encrypted contents of the JSON key file. The value can also be passed with an environment variable.


key: track

description: Codemagic enables you to automatically publish your app to Google Play.


description: If your application supports in-app updates, set the release priority by specifying an integer in range [0, 5]. Otherwise, in_app_update_priority can be omitted.


description: Codemagic supports staged releases, allowing users to choose which fraction of the testers or users get access to the application. To release to everyone, omit the rollout_fraction field.


description: Indicates that the changes in this edit will not be reviewed until they are explicitly sent for review from the Google Play Console UI.


description: Indicates that the artifacts generated in the build will be uploaded to Google Play as a draft release.


key: FirebaseAndroidArtifactType

description: An enumeration.

enum: aab apk


description: Firebase application id found in Firebase application settings.


key: groups

description: Test groups that the application should be distributed to.


description: Artifact type (aab/apk) to prioritize when uploading to Firebase App Distribution, by default app bundles are prioritized.

errorMessage: Incorrect artifact type. Expected 'apk' or 'aab'


description: Firebase access token generated using Firebase CLI; to receive the token use firebase login:ci with Firebase CLI installed.


description: The content of service account file that has "Firebase App Distribution Admin" role.


key: ios

description: Codemagic enables you to automatically publish your iOS app to Firebase App Distribution.


key: android

description: Codemagic enables you to automatically publish your Android app to Firebase App Distribution.


description: Store ID set up on Microsoft Partner Center.


description: Directory (tenant) ID in Azure AD portal.


description: Application (client) ID in Azure AD portal.


description: The value of the Azure AD app key.


key: email

description: If the build finishes successfully, release notes (if passed) and the generated artifacts will be published to the provided email address(es). If the build fails, an email with a link to build logs will be sent.

errorMessage: Incorrect type. Expected a dictionary


key: slack

description: Integrate Slack publishing into your Codemagic build pipeline to get notified when a build starts and receive build artifacts or logs when the build finishes. To set up publishing to Slack, you first need to connect your Slack workspace in User integrations for personal apps and in Team integrations for team apps.


description: Codemagic enables you to automatically publish your iOS app to App Store Connect for beta testing with TestFlight or distributing the app to users via App Store.


description: Codemagic enables you to automatically publish your app to the internal, alpha, beta and production tracks on Google Play. In order to do so, you will need to set up a service account in Google Play Console and add the JSON key file to your Codemagic configuration file.


key: firebase

description: Codemagic enables you to automatically publish your app to Firebase App Distribution. In order to do so, set up an account and project on Firebase and provide Codemagic with your Firebase token, Firebase app id and test groups.


description: Codemagic enables you to automatically publish your app to Microsoft Store. In order to do so, set up an account and project on Microsoft Partner Center and provide Codemagic with your store id, client id, client secret and tenant id.


key: scripts

description: Add scripts to publish to any other service.

errorMessage: Incorrect type. Expected a not empty list of strings (inline script) or dictionaries (scripts with additional fields)


key: name

description: Workflow name displayed in the Codemagic UI.


Build machine type to use for the build.


description: By default, Codemagic builds are set to time out after 60 minutes. You can decrease or increase the maximum build duration.


key: environment

description: Environment contains all the environment variables and enables to specify the version of Flutter, Xcode, CocoaPods, Node, npm, ndk, Java and Ruby used for building. This is also where you can add credentials and API keys required for code signing. Make sure to encrypt the values of variables that hold sensitive data.


key: integrations

description: Allows using info from the integrations connected in Codemagic UI. Currently supported: app_store_connect.


key: cache

description: Define the paths to be cached and stored on Codemagic.


key: triggering

description: Triggering defines the events for automatic build triggering and watched branches. If no events are defined, you can start builds only manually.


key: when

description: All conditions below should be met in order for build to continue.


description: Specify the default directory to run script commands. Each script will be executed inside the specified directory, unless the working directory is specified for the script itself.


description: Scripts specify what kind of application is built. This is where you can specify the commands to test, build and code sign your project. You can also run shell (sh) scripts directly in your .yaml file, or run scripts in other languages by defining the language with a shebang line or by launching a script file present in your repository.


key: artifacts

description:
Configure the paths and names of the artifacts you would like to use in the following steps, e.g. for publishing, or have available for download on the build page. All paths are relative to the clone directory, but absolute paths are supported as well. You can also use environment variables in artifact patterns.
The pattern can match several files or folders. If it picks up files or folders with the same name, the top level file or folder name will be suffixed with _{number}.
If one of the patterns includes another pattern, duplicate artifacts are not created.
apk, aab, aar, ipa, app, proguard mapping (mapping.txt), flutter_drive.log, jar, zip, xarchive and dSYM.zip files will be available as separate items in the Artifacts section on the build page. The rest of the artifacts will be included in an archive with the following name pattern: {project-name}_{version}_artifacts.zip.

errorMessage: Incorrect type. Expected a not empty list of strings, integers, floats or booleans


key: publishing

description: The matching artifacts will be published to the services you have configured. The available integrations currently are email, Slack, Google Play and App Store Connect. It is also possible to publish elsewhere with custom publishing scripts.


key: labels

description: Define label names to easily filter builds in UI. You can use environment variable as well.

errorMessage: Incorrect type. Expected a list of nonempty strings


key: filters

description: A policy file contains one or more filters. Each filter has a header that lists the generator target platforms and their options. The filter ACL rules appear in the terms section.


description:
A policy file contains one or more filters. Each filter has a header that lists the generator target platforms and their options. The filter ACL rules appear in the terms section.

filters_include_only defines a list of filters that will not be directly converted into an ACL, but can be included by other files.


key: terms

description:
A policy include file contains a single list of terms. Other policy files can insert this list using the include directive. This file can include other files, but be careful not to exceed the include depth limit of 5.

Each entry in this list is a term and must have a 'name' property defined.

Common lists of terms shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file.


key: header

description: The filter header lists the generator target platforms and their options. Other filter-level settings can be defined in the header.


key: targets

description: aclgen will generate an ACL for each target platforms identified here.


description:
The ACL rules for this filter. Each entry in this list is a term and must have a 'name' property defined.

Common lists of terms shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file.


key: include

description: Common filters shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file. The path will be resolved relative to the --base_directory given to aclgen, which is './policies/' by default.


description: Common lists of terms shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file. The path will be resolved relative to the --base_directory given to aclgen, which is './policies/' by default.


key: files

description: If no 'files' or 'include' property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by 'exclude'. When a 'files' property is specified, only those files and those specified by 'include' are included.


key: exclude

description: Specifies a list of files to be excluded from compilation. The 'exclude' property only affects the files included via the 'include' property and not the 'files' property. Glob patterns require TypeScript version 2.0 or later.


description: Specifies a list of glob patterns that match files to be included in compilation. If no 'files' or 'include' property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by 'exclude'. Requires TypeScript version 2.0 or later.


key: compileOnSave

description: Enable Compile-on-Save for this project.


key: extends

description: Path to base configuration file to inherit from (requires TypeScript version 2.1 or later), or array of base files, with the rightmost files having the greater priority (requires TypeScript version 5.0 or later).


key: force

description: Build all projects, including those that appear to be up to date


key: verbose

description: Enable verbose logging


key: incremental

description: Save .tsbuildinfo files to allow for incremental compilation of projects.


description: Have recompiles in projects that use `incremental` and `watch` mode assume that changes within a file will only affect files directly depending on it.


key: traceResolution

description: Log paths used during the `moduleResolution` process.


key: watchOptions

description: Settings for the watch mode in TypeScript.


key: watchFile

description: Specify how the TypeScript watch mode works.


key: watchDirectory

description: Specify how directories are watched on systems that lack recursive file-watching functionality.


key: fallbackPolling

description: Specify what approach the watcher should use if the system runs out of native file watchers.


key: synchronousWatchDirectory

description: Synchronously call callbacks and update the state of directory watchers on platforms that don`t support recursive watching natively.


key: excludeFiles

description: Remove a list of files from the watch mode's processing.


key: excludeDirectories

description: Remove a list of directories from the watch process.


key: compilerOptions

description: Instructs the TypeScript compiler how to compile .ts files.

default: .tsbuildinfo

enum: preserve react react-jsx react-jsxdev react-native

default: React

default: react

enum: classic node node16 nodenext bundler

default: classic

enum: crlf lf

pattern: ^(CRLF|LF|crlf|lf)$

enum: fixedPollingInterval priorityPollingInterval dynamicPriorityPolling fixedInterval priorityInterval dynamicPriority fixedChunkSize

enum: useFsEvents fixedPollingInterval dynamicPriorityPolling fixedChunkSizePolling

default: useFsEvents

enum: fixedPollingInterval priorityPollingInterval dynamicPriorityPolling useFsEvents useFsEventsOnParentDirectory fixedChunkSizePolling


key: allowArbitraryExtensions

description: Enable importing files with any extension, provided a declaration file is present.


key: allowImportingTsExtensions

description: Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set.


key: charset

description: No longer supported. In early versions, manually set the text encoding for reading files.


key: composite

description: Enable constraints that allow a TypeScript project to be used with project references.


key: customConditions

description: Conditions to set in addition to the resolver-specific defaults when resolving imports.


key: declaration

description: Generate .d.ts files from TypeScript and JavaScript files in your project.


key: declarationDir

description: Specify the output directory for generated declaration files.


key: diagnostics

description: Output compiler performance information after building.


key: disableReferencedProjectLoad

description: Reduce the number of projects loaded automatically by TypeScript.


key: noPropertyAccessFromIndexSignature

description: Enforces using indexed accessors for keys declared using an indexed type


key: emitBOM

description: Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.


key: emitDeclarationOnly

description: Only output d.ts files and not JavaScript files.


key: exactOptionalPropertyTypes

description: Differentiate between undefined and not present when type checking


key: incremental

description: Enable incremental compilation. Requires TypeScript version 3.4 or later.


key: tsBuildInfoFile

description: Specify the folder for .tsbuildinfo incremental compilation files.


key: inlineSourceMap

description: Include sourcemap files inside the emitted JavaScript.


key: inlineSources

description: Include source code in the sourcemaps inside the emitted JavaScript.


key: jsx

description: Specify what JSX code is generated.


key: reactNamespace

description: Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit.


key: jsxFactory

description: Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'


key: jsxFragmentFactory

description: Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.


key: jsxImportSource

description: Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx`.


key: listFiles

description: Print all of the files read during the compilation.


key: mapRoot

description: Specify the location where debugger should locate map files instead of generated locations.


key: module

description: Specify what module code is generated.


key: moduleResolution

description: Specify how TypeScript looks up a file from a given module specifier.


key: newLine

description: Set the newline character for emitting files.


key: noEmit

description: Disable emitting file from a compilation.


key: noEmitHelpers

description: Disable generating custom helper functions like `__extends` in compiled output.


key: noEmitOnError

description: Disable emitting files if any type checking errors are reported.


key: noImplicitAny

description: Enable error reporting for expressions and declarations with an implied `any` type..


key: noImplicitThis

description: Enable error reporting when `this` is given the type `any`.


key: noUnusedLocals

description: Enable error reporting when a local variables aren't read.


key: noUnusedParameters

description: Raise an error when a function parameter isn't read


key: noLib

description: Disable including any library files, including the default lib.d.ts.


key: noResolve

description: Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project.


key: noStrictGenericChecks

description: Disable strict checking of generic signatures in function types.


key: skipDefaultLibCheck

description: Skip type checking .d.ts files that are included with TypeScript.


key: skipLibCheck

description: Skip type checking all .d.ts files.


key: outFile

description: Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output.


key: outDir

description: Specify an output folder for all emitted files.


key: preserveConstEnums

description: Disable erasing `const enum` declarations in generated code.


key: preserveSymlinks

description: Disable resolving symlinks to their realpath. This correlates to the same flag in node.


key: preserveValueImports

description: Preserve unused imported values in the JavaScript output that would otherwise be removed


key: preserveWatchOutput

description: Disable wiping the console in watch mode


key: pretty

description: Enable color and formatting in output to make compiler errors easier to read


key: removeComments

description: Disable emitting comments.


key: rootDir

description: Specify the root folder within your source files.


key: isolatedModules

description: Ensure that each file can be safely transpiled without relying on other imports.


key: sourceMap

description: Create source map files for emitted JavaScript files.


key: sourceRoot

description: Specify the root path for debuggers to find the reference source code.


key: suppressExcessPropertyErrors

description: Disable reporting of excess property errors during the creation of object literals.


key: suppressImplicitAnyIndexErrors

description: Suppress `noImplicitAny` errors when indexing objects that lack index signatures.


key: stripInternal

description: Disable emitting declarations that have `@internal` in their JSDoc comments.


key: target

description: Set the JavaScript language version for emitted JavaScript and include compatible library declarations.


key: useUnknownInCatchVariables

description: Default catch clause variables as `unknown` instead of `any`.


key: watch

description: Watch input files.


key: fallbackPolling

description: Specify the polling strategy to use when the system runs out of or doesn't support native file watchers. Requires TypeScript version 3.8 or later.


key: watchDirectory

description: Specify the strategy for watching directories under systems that lack recursive file-watching functionality. Requires TypeScript version 3.8 or later.


key: watchFile

description: Specify the strategy for watching individual files. Requires TypeScript version 3.8 or later.


key: experimentalDecorators

description: Enable experimental support for TC39 stage 2 draft decorators.


key: emitDecoratorMetadata

description: Emit design-type metadata for decorated declarations in source files.


key: allowUnusedLabels

description: Disable error reporting for unused labels.


key: noImplicitReturns

description: Enable error reporting for codepaths that do not explicitly return in a function.


key: noUncheckedIndexedAccess

description: Add `undefined` to a type when accessed using an index.


key: noFallthroughCasesInSwitch

description: Enable error reporting for fallthrough cases in switch statements.


key: noImplicitOverride

description: Ensure overriding members in derived classes are marked with an override modifier.


key: allowUnreachableCode

description: Disable error reporting for unreachable code.


key: forceConsistentCasingInFileNames

description: Ensure that casing is correct in imports.


key: generateCpuProfile

description: Emit a v8 CPU profile of the compiler run for debugging.


key: baseUrl

description: Specify the base directory to resolve non-relative module names.


key: paths

description: Specify a set of entries that re-map imports to additional lookup locations.


key: items

description: Path mapping to be computed relative to baseUrl option.


key: plugins

description: Specify a list of language service plugins to include.


key: name

description: Plugin name.


key: rootDirs

description: Allow multiple folders to be treated as one when resolving modules.


key: typeRoots

description: Specify multiple folders that act like `./node_modules/@types`.


key: types

description: Specify type package names to be included without being referenced in a source file.


key: traceResolution

description: Enable tracing of the name resolution process. Requires TypeScript version 2.0 or later.


key: allowJs

description: Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.


key: noErrorTruncation

description: Disable truncating types in error messages.


key: allowSyntheticDefaultImports

description: Allow 'import x from y' when a module doesn't have a default export.


key: noImplicitUseStrict

description: Disable adding 'use strict' directives in emitted JavaScript files.


key: listEmittedFiles

description: Print the names of emitted files after a compilation.


key: disableSizeLimit

description: Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server.


key: lib

description: Specify a set of bundled library declaration files that describe the target runtime environment.


key: strictNullChecks

description: When type checking, take into account `null` and `undefined`.


key: maxNodeModuleJsDepth

description: Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`.


key: importHelpers

description: Allow importing helper functions from tslib once per project, instead of including them per-file.


key: importsNotUsedAsValues

description: Specify emit/checking behavior for imports that are only used for types.

default: remove

enum: remove preserve error


key: alwaysStrict

description: Ensure 'use strict' is always emitted.


key: strict

description: Enable all strict type checking options.


key: strictBindCallApply

description: Check that the arguments for `bind`, `call`, and `apply` methods match the original function.


key: downlevelIteration

description: Emit more compliant, but verbose and less performant JavaScript for iteration.


key: checkJs

description: Enable error reporting in type-checked JavaScript files.


key: strictFunctionTypes

description: When assigning functions, check to ensure parameters and the return values are subtype-compatible.


key: strictPropertyInitialization

description: Check for class properties that are declared but not set in the constructor.


key: esModuleInterop

description: Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility.


key: allowUmdGlobalAccess

description: Allow accessing UMD globals from modules.


key: keyofStringsOnly

description: Make keyof only return strings instead of string, numbers or symbols. Legacy option.


key: useDefineForClassFields

description: Emit ECMAScript-standard-compliant class fields.


key: declarationMap

description: Create sourcemaps for d.ts files.


key: resolveJsonModule

description: Enable importing .json files


key: resolvePackageJsonExports

description: Use the package.json 'exports' field when resolving package imports.


key: resolvePackageJsonImports

description: Use the package.json 'imports' field when resolving imports.


description: Have recompiles in '--incremental' and '--watch' assume that changes within a file will only affect files directly depending on it. Requires TypeScript version 3.8 or later.


key: extendedDiagnostics

description: Output more detailed compiler performance information after building.


key: listFilesOnly

description: Print names of files that are part of the compilation and then stop processing.


key: disableSourceOfProjectReferenceRedirect

description: Disable preferring source files instead of declaration files when referencing composite projects


key: disableSolutionSearching

description: Opt a project out of multi-project reference checking when editing.


key: verbatimModuleSyntax

description: Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting.


key: typeAcquisition

description: Auto type (.d.ts) acquisition options for this project. Requires TypeScript version 2.1 or later.


key: enable

description: Enable auto type acquisition


key: include

description: Specifies a list of type declarations to be included in auto type acquisition. Ex. ["jquery", "lodash"]


key: exclude

description: Specifies a list of type declarations to be excluded from auto type acquisition. Ex. ["jquery", "lodash"]


key: references

description: Referenced projects. Requires TypeScript version 3.0 or later.


key: items

description: Project reference.


key: path

description: Path to referenced tsconfig or to folder containing tsconfig.


description: The hemtt.json or hemtt.toml file is used to configure your HEMTT Project. All examples are done using JSON, but both files support every feature of HEMTT. hemtt.toml will be used if both files are present.

examples: tracers particles

examples: hearing zeus

examples: echo {{addon}} took {{time}} ms to build.

required: name prefix author


key: name

description: Long name of your project.


key: prefix

description: Prefix used for CBA macros and the release directory name.


key: author

description: Author of the project.


key: version

description: HEMTT will look for ```addons/main/script_version.hpp``` and use it for the version number. If you are not using the CBA project structure or do not have that file you can add a version number in the HEMTT project file.


key: files

description: HEMTT will copy the files to the release directory after a successful release build. Supports glob patterns.


description: HEMTT will include matching relative or absolute paths when building.


description: HEMTT will exclude matching files when building.


key: optionals

description: HEMTT will build the specified addons from the ./optionals folder.


description: HEMTT will by default build optionals into their own mod folders, which can be directly launched by the user. This can be turned off to build optional PBOs directly into optionals folder.


key: skip

description: HEMTT will skip building the specified addons.


key: headerexts

description: HEMTT will apply specified header extensions to each PBO. Supports templating.


key: modname

description: HEMTT will use the specified mod name (without @) to form @mod folder. Supports templating.


key: keyname

description: HEMTT will use the specified key name for .bikey and .biprivatekey names. Supports templating.


key: signame

description: HEMTT will use the specified signature name as part of the full signature (.bisign) name. Supports templating.


key: sigversion

description: HEMTT will use the specified signature version. Currently Supported: V2, V3 (Experimental).


description: If set to true, HEMTT will use (and re-use) releases/keys/{keyname}.biprivatekey. It will be generated if it doesn't exist. The default behaviour is to generate a new private key each time and discard it immediately. HEMTT strongly recommends that you only re-use the key if you are making a client-side mod where it will not matter if clients are running different versions of the mod.


description: steps_windows and steps_linux can be used to run different steps on the respective platforms.


description: All output is hidden by default. Setting show_output will display the command being executed and its output.


key: foreach

description: Scripts can be ran for each addons. Inside prebuild the script will be ran for each addon that HEMTT will build, including addons that will be skipped if they are already built. Inside postbuild and releasebuild only addons that were successfully built with be used, excluding addons that were skipped for being up to date.


key: parallel

description: Requires foreach to be true. If a script is thread safe parallel can be used to process multiple addons at a time.


key: types

description: Array of strings defining the entity subtypes defined by the schema.


key: templates

description: Template schemas that can be reused by entity subtypes.


key: additionalProperties

description: Definition of a template schema.


description: Custom property defined for this schema.


description: Definition of an entity subtype.


description: Array of strings specifying which template schemas to apply to this type.


key: Actor

description: The top level data schema for Actor types.


key: Item

description: The top level data schema for Item types.


description: BigQuery lets you specify a table's schema when you load data into a table or when you create an empty table. A table schema is a JSON file.

enum: INT64 INTEGER FLOAT64 FLOAT NUMERIC BIGNUMERIC BOOL BOOLEAN STRING BYTES DATE DATETIME TIME TIMESTAMP STRUCT RECORD GEOGRAPHY

enum: NULLABLE REQUIRED REPEATED

required: name type

enum: STRUCT RECORD

required: fields type name


key: autoindent

description:
Whether to use the same indentation as a previous line
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: autosave

description:
A delay between automatic saves
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: autosu

description:
Whether attempt to use super user privileges
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: backup

description:
Whether to backup all open buffers
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: backupdir

description:
A directory to store backups
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: basename

description:
Whether to show a basename instead of a full path
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: clipboard

description:
A way to access the system clipboard
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

enum: external terminal internal

default: external


key: colorcolumn

description:
A position to display a column
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: colorscheme

description:
A color scheme
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

enum: atom-dark bubblegum cmc-16 cmc-tc darcula default dracula-tc dukedark-tc dukelight-tc dukeubuntu-tc geany gotham gruvbox gruvbox-tc material-tc monokai-dark monokai one-dark railscast simple solarized solarized-tc sunny-day twilight zenburn


key: cursorline

description:
Whether to highlight a line with a cursor with a different color
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: diffgutter

description:
Whether to display diff inticators before lines
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: divchars

description:
Divider chars for vertical and horizontal splits
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: divreverse

description:
Whether to use inversed color scheme colors for splits
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: encoding

description:
An encoding used to open and save files
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: eofnewline

description:
Whether to add a missing trailing new line
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: fastdirty

description:
Whether to use a fast algorithm to determine whether a file is changed
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: fileformat

description:
A line ending format
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

enum: unix dos

default: unix


key: filetype

description:
A filetype for the current buffer
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

default: unknown


key: hlsearch

description:
Whether to highlight all instances of a searched text after a successful search
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: incsearch

description:
Whether to enable an incremental search in `Find` prompt
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: ignorecase

description:
Whether to perform case-insensitive searches
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: indentchar

description:
An indentation character
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: infobar

description:
Whether to enable a line at the bottom where messages are printed
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: keepautoindent

description:
Whether add a whitespace while using autoindent
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: keymenu

description:
Whether to display nano-style key menu at the bottom
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: matchbrace

description:
Whether to underline matching braces
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: mkparents

description:
Whether to create missing directories
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: mouse

description:
Whether to enable mouse support
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: paste

description:
Whether to treat characters sent from the terminal in a single chunk as a paste event
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: parsecursor

description:
Whether to extract a line number and a column to open files with from file names
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: permbackup

description:
Whether to permanently save backups
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: pluginchannels

description:
A file with list of plugin channels
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: pluginrepos

description:
Plugin repositories
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: items

description:
A pluging repository
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: readonly

description:
Whether to forbid buffer editing
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: rmtrailingws

description:
Whether to remove trailing whitespaces
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: ruler

description:
Whether to display line numbers
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: relativeruler

description:
Whether to display relative line numbers
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: savecursor

description:
Whether to save cursor position in files
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: savehistory

description:
Whether to save command history between closing and re-opening editor
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: saveundo

description:
Whether to save undo after closing file
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: scrollbar


key: scrollmargin

description:
A margin at which a view starts scrolling when a cursor approaches an edge of a view
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: scrollspeed

description:
Line count to scroll for one scroll event
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: smartpaste

description:
Whether to add a leading whitespace while pasting multiple lines
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: softwrap

description:
Whether to wrap long lines
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: splitbottom

description:
Whether to create a new horizontal split below the current one
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: splitright

description:
Whether to create a new vertical split right of the current one
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: statusformatl

description:
Format string of left-justified part of the statusline
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

default: $(filename) $(modified)($(line),$(col)) $(status.paste)| ft:$(opt:filetype) | $(opt:fileformat) | $(opt:encoding)


key: statusformatr

description:
Format string of right-justified part of the statusline
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

default: $(bind:ToggleKeyMenu): bindings, $(bind:ToggleHelp): help


key: statusline

description:
Whether to display a status line
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

default: sudo


key: sucmd

description:
A super user command
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

examples: sudo doas


key: syntax

description:
Whether to enable a syntax highlighting
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: tabmovement

description:
Whether to navigate spaces at the beginning of lines as if they are tabs
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: tabhighlight

description:
Whether to invert tab character colors
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: tabreverse

description:
Whether to reverse tab bar colors
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: tabsize

description:
A tab size
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: tabstospaces

description:
Whether to use spaces instead of tabs
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: useprimary

description:
Whether to use primary clipboard to copy selections in the background
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: wordwrap

description:
Whether to wrap long lines by words
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


key: xterm

description:
Whether to assume that the current terminal is `xterm`
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options


description: All paths are required to be in **Unix format** (foo/bar), the build system normalizes them for other platforms internally

enum: dce exception termination

enum: native bytecode js

enum: classic automatic

enum: reset prefix append

required: name sources


key: module-format

description: es6-global generate relative `require` paths instead of relying on NodeJS' module resolution. Default: commonjs.


key: suffix-spec

description: suffix of generated js files, default to [.js]


key: in-source

description: Default: false.


key: namespace-spec

description: true to use the package name as namespace, false to not use


description: provide customized namespace name


key: analysis

description: The types of analysis to activate. `dce` means dead code analysis, `exception` means exception analysis, and `termination` is to check for infinite loops.


key: suppress

description: Paths for any folders you'd like to exclude from analysis. Useful for bindings and similar. Example: `["src/bindings"]`.


key: unsuppress

description: Any specific paths inside suppressed folders that you want to unsuppress. Example: ["src/bindings/SomeBinding.res"].


key: transitive

description: specify whether transitively dead items should be reported (default: false)


key: react-jsx-version

description: backward compatible mode, true means on with the default to be version 1 (the default value is subject to change)


key: rule-generator

description: The shell command is running in *dev* time, and you generated could should be checked in, the depedency is tracked properly during dev time,example: `{ "name" : "ocamllex", "command" : "ocamllex.opt $in -o $out"}`


key: build-generator

description: Note that we will add the directory path accordingly


key: dir

description: name of the directory


key: files

description: if files are empty, the build system will populate it automatically. Useful for initial build


key: slow-re

description: Regex to glob the patterns, syntax is documented [here](http://caml.inria.fr/pub/docs/manual-ocaml/libref/Str.html), for better incremental build performance, we'd suggest listing files explicitly


key: excludes

description: Files to be excluded


key: generators

description: (WIP) Files generated in dev time


key: public

description: Default: export all modules. It is recommended for library developers to hide some files/interfaces


description: Selected modules, for example, [Module_a, Module_b]


key: subdirs

description: More source directories


description: true means traverse to all subdirs


key: group

description: Not implemented yet


description: A _unique_ name for each directory to refer as an internal dependency later


key: hierachy

description: When true, all subdirs are considered as a whole as dependency


key: items

description: internal dependencies, if unspecified, all existing listed source files are considered potential dependencies


key: sources

description: Example: `"src"` or `["src", "test"]` or `[{"dir": "src", "subdirs": [...]}]`


description: A list of source items


description: A single source item


key: kind

description: The compiler to use for the target


key: main

description: Name of the main module used as entry point for this target. 'entry-point' isn't used when this project is built as a dependency.


key: entries

description: A list of buildable targets


key: gentype-specs

description: path to gentype, path resolution is similar to ReScript


key: react-jsx

description: Whether to apply the [RescriptReact](https://github.com/rescript-lang/rescript-react)-specific JSX PPX transformation.


key: version

description: Whether to apply the specific version of JSX PPX transformation


key: module

description: JSX module, currently only support the React.


key: mode

description: JSX transformation mode


Build the given dependencies in JSX V3 compatibility mode.


key: bsc-flags

description: Default: `["-no-alias-deps"]`


description: (Not implemented yet)


description: The semantic version of the ReScript library


key: name

description: Package name


key: namespace

description: can be true/false or a customized name


description: Source code location


key: ignored-dirs

description: a list of directories that bsb will not look into


key: bs-dependencies

description: ReScript dependencies of the library, like in package.json. Currently searches in `node_modules`


key: bs-dev-dependencies

description: ReScript dev dependencies of the library, like in package.json. Currently searches in `node_modules`


key: pinned-dependencies

description: Those dependencies are pinned (since version 8.4)


key: generators

description: (WIP) Pre defined rules


key: cut-generators

description: Ignore generators, cut the dependency on generator tools


key: jsx

description: Configuration for the JSX transformation.


key: uncurried

description: Configuration for the uncurried mode.


key: reason

description: ReScript comes with [Reason](http://reasonml.github.io/) by default. Specific configurations here.


key: gentypeconfig

description: gentype config, see cristianoc/genType for more details


description: Flags passed to bsc.exe


key: warnings

description: warning numbers and whether to turn it into error or not


key: number

description: Default: -40+6+7+27+32..39+44+45 [Here](https://caml.inria.fr/pub/docs/manual-ocaml/comp.html#sec270) for the meanings of the warning flags


key: error

description: True means warn is error(default)


description: Same as warning number but different set


key: ppx-flags

description: PPX macros to pass to compiler. The syntax is package_name/binary, for example: `reason/reactjs_jsx_ppx_3.native`. Currenly searches in `node_modules`


key: pp-flags

description: preprocessors to pass to compiler. The syntax is package_name/binary, for example: `pp/syntax.exe`. Currenly searches in `node_modules`


key: js-post-build

description: (Experimental) post-processing hook. bsb will invoke `cmd ${file}` whenever a `${file}` is changed


key: package-specs

description: ReScript can currently output to [Commonjs](https://en.wikipedia.org/wiki/CommonJS), and [ES6 modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import)


key: entries

description: (internal) Used by bsb to build to different targets: native (ocamlopt), bytecode (ocamlc) or JS (bsc)


key: use-stdlib

description: (Experimental) whether to use the OCaml standard library. Default: true


key: external-stdlib

description: Use the external stdlib library instead of the one shipped with the compiler package


key: bs-external-includes

description: (Not needed usually) external include directories, which will be applied `-I` to all compilation units


key: reanalyze

description: Configure reanalyze, a static code analysis tool for ReScript.


key: dataTypes

description: To use data_types, the definitions version must be cloudify_dsl_1_2 or higher.


key: description

description: Description for the data type.


key: properties

description: Dictionary of the data type properties.


description: Parent data type.


key: inputProperty

description: inputs are parameters that are injected into a blueprint when a deployment is created. These parameters can be referenced by using the get_input intrinsic function.

enum: string integer float boolean list dict regex

type: number string array boolean integer object


description: An optional description for the input.


key: type

description: The required data type of the input. Not specifying a data type means the type can be anything, including a list, an array or a dictionary. Valid types: string, integer, float, boolean, list, dict, regex or a custom data type.


key: default

description: An optional default value for the input.


key: required

description: a boolean value to indicate whether the input is required must be passed or not.


key: inputPropertyConstraints

description: The constraints the input value must comply with. Read more details about the format and usage of the constraints in the Constraints section below.

type: number string boolean integer


key: nodeTemplates

description: node_templates represent the actual instances of node types that eventually represent the running application/service, as described in the blueprint. node_templates are more commonly referred to as nodes. Nodes can comprise more than one instance. For example, you might define a node that contains two VMs. Each VM is a node_instance.


description: The node-type of this node template.


description: The properties of the node template, matching its node type properties schema.


key: instances

description: Instances configuration. (Deprecated. Replaced with capabilities.scalable)


key: interfaces

description: Used for a mapping plugins to interfaces operation, or for specifying inputs for already-mapped node type operations.


key: relationships

description: Used for specifying the relationships that this node template has with other node templates.


key: capabilities

description: Used for specifying the node template capabilities (Supported since: cloudify_dsl_1_3.) Only the scalable capability is supported.


description:
Indicate whether the resource exists or if Cloudify should create the resource,
true if you are bringing an existing resource, false if you want cloudify to create it.


description:
The GCP resource ID of the external resource, if
use_external_resource is true. Otherwise it is an empty string.


description: A dictionary of values to pass to authenticate with the GCP API.


key: name

description: Optional project name. By default it will be instance id.


description:
Tells the deployment to use the public IP (if available) of the resource
for Cloudify Agent connections


description: The ID of the image in your GCP account.


description:
The instance's type. All available instance types can be found here:
https://cloud.google.com/compute/docs/machine-types


description: Optional instance name. By default it will be instance id.


key: zone

description: Optional zone name. If not given, this instance will be deployedin default zone.


key: tags

description:
Optional tags. If not given, this instance will have a tag only with
its name.


description: Disable project-wide ssh keys for this Instance


description: Is the VM allowed to send packets with source address different to its own?


key: scopes

description:
Optional scopes. If not will set by default:
'https://www.googleapis.com/auth/devstorage.read_write',
'https://www.googleapis.com/auth/logging.write'


description:
A script which will be run when the Instance is first started
example:
  type: string
  script: |
    yum install some stuff
    systemctl start it
or:
  type: file
  script: <path to script file>


description:
Should the Instance be created with an externally-accessible
IP address. This will be an ephemeral IP.
If you would like to use an IP address which can be transferred
to another Instance then connect this Instance to an `Address`
node using the
`cloudify.gcp.relationships.instance_connected_to_ip`
relationship.


description: Additional instance settings.


A Microsoft Azure Active Directory endpoint.


A Microsoft Azure Active Directory Resource Manager.


A Microsoft Azure Active Directory Resource Id.


Connection certificate verify.


A Microsoft Azure subscription ID. This is a unique
user account in Azure. This can be found in the
Subscriptions tab on your dashboard.


A Microsoft Azure tenant ID. This can be found in the Azure Active Directory dashboard by accessing
your directory. Open the Application Endpoints
dialog and your tenant ID will be in the URL for
the OAUTH2.0 TOKEN ENDPOINT.


A Microsoft Azure client ID. This can be found in
the Azure Active Directory dashboard by accessing
your directory. View the Applications tab and select
the application used to access Azure APIs.  Your
client ID can be found by expanding the ACCESS WEB
APIS IN OTHER APPLICATIONS tab.


A Microsoft Azure client secret key. This can be found
or generated in the same location as your client ID.


When scaling resources, a unique name must be sent to
the Azure API. Since names are left to the user to
manage (the service does not generate unique IDs),
this plugin will attempt to append characters or
numbers to the end of the resource name when resources
are scaled out. This value should be a character, or
characters, that will separate the base name from the
generated unique characters.  For instance, if the
base name of a resource is "myvm", the separator is
set to "_", and a scale workflow attempts to create
another resource, the resulting name could be
something like "myvm_1". This field can be left blank.


A string of characters (ASCII) to be used when
generating unique suffix data when scaling resources.
See "scale_name_separator" for more information.


key: certificate

description: Certificate private key.


key: thumbprint

description: Certificate thumbprint.


An alternative cloud environment.


description: See https://msdn.microsoft.com/en-us/library/mt163564.aspx


key: accountType

description: An storage account type (case sensitive)


description: Container for the resource.

default: vhds


key: size

description: Size of the Page Blob (Azure disk) in GiB. Maximum of 1023 GiB allowed.


If set to true, the resource's "delete" lifecycle will purge the
Azure Data Disk from the Azure Storage Account. If false, the
Data Disk is left as-is in the Storage Account.


description: See https://msdn.microsoft.com/en-us/library/mt163661.aspx


description: See https://msdn.microsoft.com/en-us/library/mt163645.aspx

required: protocol sourceAddressPrefix destinationAddressPrefix access priority direction


description: See https://msdn.microsoft.com/en-us/library/mt163656.aspx


description: See https://msdn.microsoft.com/en-us/library/mt163621.aspx


description: See https://msdn.microsoft.com/en-us/library/mt502548.aspx


key: privateIPAddress

description: Static, private IP Address


key: privateIPAllocationMethod

description:
Defines how a private IP address is assigned. Options
are Static or Dynamic


description: See https://msdn.microsoft.com/en-us/library/mt163590.aspx


key: publicIPAllocationMethod

description:
Defines whether the IP address is stable or dynamic.
Options are Static or Dynamic


key: idleTimeoutInMinutes

description:
Specifies the timeout (in minutes) for the TCP idle connection.
The value can be set between 4 and 30 minutes


key: domainNameLabel

description:
The concatenation of the domain name label and the regionalized
DNS zone make up the fully qualified domain name associated
with the public IP address.


key: reverseFqdn

description:
A fully qualified domain name that resolves to this
public IP address.


description: See https://msdn.microsoft.com/en-us/library/mt163607.aspx


key: sku

description: dict to represent sku [for now we only provide name]


description: check the parameters from this link : https://www.shorturl.at/wHTU2

default: Spot

default: Deallocate


set true if you want to consider spot instance params


key: priority

description: Possible values include: 'Regular', 'Low', 'Spot'


description: the only supported value is 'Deallocate'


description: See https://msdn.microsoft.com/en-us/library/mt163574.aspx

default: Tcp

required: port intervalInSeconds numberOfProbes


required: protocol frontendPort backendPort


default: Default


description: See https://docs.microsoft.com/en-us/rest/api/aks/managedclusters


description: A dict containing resource tags


description: An array to pass an array of dict for agent profile


description: A dict to define linux profile with user name and public keys


description: A dict to define network profile loadbalancer,outbound,IPs


description: A dict to define windows profile with user name and password


description: A dict to define service service_principal_profile [client_id, secret]


description: A dict to define addons to the managed cluster


key: metadata

description: Metadata (dict) for the File Share


key: quota

description: Quote, in GiB, for the maximum size of the file share


If true, causes the operation to raise a NonRecoverableError if
the file share already exists. If false, issues a warning and
continues execution.


description: See https://msdn.microsoft.com/en-us/library/mt459110.aspx

required: nextHopType addressPrefix


description: See https://msdn.microsoft.com/en-us/library/mt163668.aspx