key: host

description: Postgres host address to connect to


key: port

description: Postgres port to connect to

type: integer


key: database

description: Name of the database

type: string


key: username

description: Username with access to the database


key: password

description: User's database password


key: redis

description: Monitor redis health

type: array

type: object

required: host port


key: uri

description: redis uri connection configuration


description: The hostname or IP address of the redis server


description: Port number used for the redis


description: Password used for the redis AUTH, if set.


description: Username used for the redis AUTH, if set.


key: mongo

description: Monitor MongoDB health


description: The hostname or IP address of the MongoDB server


description: Port number used for the MongoDB


description: Password used for the MongoDB AUTH, if set.


description: Username used for the MongoDB AUTH, if set.


key: mariadb

description: Monitor MariaDB/Mysql health

required: host port username password database

default: Name of the database


description: The hostname or IP address of the database server


description: Port number used by your database server


description: User with access to the database


description: User password for authentication


key: requests

description: The http or ping request to probe for

enum: GET POST DELETE PUT PATCH

default: GET

type: boolean


key: method

description: The http method


key: url

description: The remote URL address to probe


key: timeout

description: Set the timeout for the request in milliseconds, default is 10 seconds


key: saveBody

description: Should response body be saved in the database


key: ping

description: If defined and to true, the request is an ICMP ping


key: allowUnauthorized

description: If defined and to true, the request will ignore SSL certificate validity


key: socket

description: Socket is a TCP type request

required: host port data


key: host

description: Address to your host


key: port

description: Host port to connect to


key: data

description: Data payload for the request


key: alerts

description: The condition which will trigger an alert and the subsequent notification

required: assertion message

default: response.status != 200

default: Http Response status code is not 200!

required: query message


key: assertion

description: An expression that will trigger an alert when its is logically true. See the assertions here: https://monika.hyperjump.tech/guides/alerts#alert-query


key: message

description: Message that will be sent to the notification channel


key: query

description: Note: Query is deprecated, please use assertion


key: body

description: The data bytes transmitted in an HTTP transaction message immediately following the headers if there are any


key: headers

description: A list of strings sent and received by both the client program and server on every HTTP request and response


key: Accept

description: Media type(s) that is/are acceptable for the response


key: Accept-Charset

description: Character sets that are acceptable


key: Accept-Encoding

description: List of acceptable encodings


key: Authorization

description: Authentication credentials for HTTP authentication


key: Cache-Control

description: Used to specify directives that must be obeyed by all caching mechanisms along the request-response chain


key: Cookie

description: An HTTP cookie previously sent by the server with Set-Cookie


key: Connection

description: General header that allows the sender or client to specify options that are desired for that particular connection


key: Content-Type

description: The Media type of the body of the request (used with POST and PUT requests


key: Keep-Alive

description: General header used to inform how long a persistent connection should stay open


key: Origin

description: Initiates a request for cross-origin resource sharing (asks server for Access-Control-* response fields)


key: Referer

description: This is the address of the previous web page (referrer) from which a link to the currently requested page was followed


key: User-Agent

description: The user agent string of the user agent


key: probes

description: Probe is a description of the target, methods, timing and payloads to begin monitoring/probing a target.

examples: get-user login-check web-heatlh-check


key: id

description: Unique string identification of the probe


key: name

description: A human-readible probe name


key: description

description: Description of the probe

default: Ensure connectivity to github is successful


key: notifications

description: Alerts of incidents and recoveries will be sent via these notification channels

required: id type

const: desktop

required: id type data

const: discord

const: workplace

const: google-chat

const: lark

const: mailgun

required: recipients apiKey domain

const: teams

const: monika-notif

const: pagerduty

required: key probeID

const: sendgrid

required: sender recipients apiKey

const: slack

const: smtp

required: recipients hostname port

default: statuspage

const: statuspage

required: pageID apiKey

const: telegram


description: Unique notification id


key: data

description: Data for your payload


key: url

description: The URL of the Discord Webhook that will receive notification


description: Data for your payload


description: Thread id is the set of numbers at the end of the url


description: Workplace access token for custom integration


description: The webhook URL for your google chat


description: The webhook URL for your lark suite


description: Data for your payload


key: recipients

description: An array of email addresses that will receive the e-mail from Monika


key: apiKey

description: Mailgun account API key, mailgun registered key to identify your account


key: domain

description: The domain to set in Mailgun


description: Your teams webhook URL


description: Your Monika notification URL


description: Unique pagerduty notif id


key: items

description: Data for your payload


key: key

description: Pagerduty integration key


key: probeID

description: Monika Probe ID


description: Unique sendgrid notification id


description: Data for your payload


key: sender

description: A string of email addresses that has been verified in your sendgrid account


description: Sendgrid account api key, sendgrid registered key to identify your account


description: Unique slack notification id


description: Data for your payload


description: The URL webhook for Slack


description: Unique smtp notification id


description: Data for your payload


description: An array of email address that will receive the email from Monika


key: hostname

description: The smtp host that you will be using for sending the email


key: port

description: The port allowed to be used for sending mail in your host


key: username

description: Registered username on your smtp server


key: password

description: The password set for your username


key: id

description: Notification identity number


description: Data for your payload


description: Statuspage API key


key: pageID

description: Statuspage page ID


description: Unique telegram notification id


description: Data for your payload


description: The ID of the group where the bot should send the messages


description: Token for your telegram bot


description: Unique webhook notification id


description: Data for your payload


description: The URL of the server that will receive the webhook notification


description: Unique whatsapp notification id


description: Data for your payload

required: recipients url username password


description: An array of phone numbers registered for WhatsApp, should start with your controu code number


description: Your WhatsApp API username


description: Your Whatsapp API user password


description: Unique Dingtalk notification id


description: Data for your payload


description: the token of your Dingtalk account


description: Unique Pushover notification id


description: Data for your payload

required: token user


key: token

description: Pushover application token


key: user

description: Pushover user key


description: Unique Gotify notification id


key: data

description: Data for your payload

required: token url


description: Gotify application token


key: url

description: Gotify base url


description: Unique opsgenie notification id


key: geniekey

description: Opsgenie application token


description: Unique notification id


description: Data for your payload


description: Pushbullet application token.


key: deviceID

description: Pushbullet device identifier (optional)


description: The type of notification

default: instatus


description: Data for your payload

required: apiKey pageID


key: apiKey

description: Instatus API key


description: Instatus Page ID


description: Database internal configuration

type: number


description: Maximum Monika database size


description: Delete strategy when limit reached


description: Schedule to trim the db in crontab


key: status-notification

description: Sends status notification periodically according to a cron schedule. Set to false to disable.


key: certificate

description: Check validity of your TLS certificate(s).


key: domains

description: The list of domains to check


key: domain

description: Hostname to check


key: options

description: Custom HTTPs Options


key: reminder

description: The number of days to send notification to user before the domain expires


key: buildConfig

description: Build section defines configuration values for the build command.


key: globalMetadata

description: Contains metadata that will be applied to every file, in key-value pair format.


key: fileMetadata

description: Contains metadata that will be applied to specific files.


key: forcePostProcess

description: Force to re-process the documentation in post processors. It will be cascaded from force option.


key: debug

description: Run in debug mode. With debug mode, raw model and view model will be exported automatically when it encounters error when applying templates. If not specified, it is false.


key: debugOutput

description: The output folder for files generated for debugging purpose when in debug mode. If not specified, it is ${TempPath}/docfx.


key: port

description: Specify the port of the hosted website.


key: exportRawModel

description: If set to true, data model to run template script will be extracted in `.raw.json` extension.


key: rawModelOutputFolder

description: Specify the output folder for the raw model. If not set, the raw model will be generated to the same folder as the output documentation.


key: exportViewModel

description: If set to true, data model to apply template will be extracted in `.view.json` extension.


key: viewModelOutputFolder

description: Specify the output folder for the view model. If not set, the view model will be generated to the same folder as the output documentation.


key: dryRun

description: If set to true, template will not be actually applied to the documents. This option is always used with `--exportRawModel` or `--exportViewModel`, so that only raw model files or view model files are generated.


key: maxParallelism

description: Set the max parallelism, 0 (default) is same as the count of CPU cores.


key: lruSize

description: Set the LRU cached model count (approximately the same as the count of input files). By default, it is 8192 for 64bit and 3072 for 32bit process. With LRU cache enabled, memory usage decreases and time consumed increases. If set to 0, Lru cache is disabled.


key: markdownEngineName

description: Set the name of markdown engine, default is dfm, and another build-in engine is gfm.


key: markdownEngineProperties

description: Set the parameters for markdown engine.


key: noLangKeyword

description: Disable default lang keyword, e.g. `null`.


key: keepFileLink

description: If set to true, DocFX does not copy file to the output folder. Instead, it saves a link_to_path property inside manifest.json.


key: cleanupCacheHistory

description: If set to true, cleans up historical cache data when building.


key: metadataConfig

description: Metadata section defines an array of source projects and their output folder.


key: dest

description: Defines the output folder of the generated metadata files.


key: disableDefaultFilter

description: If set to true, disables default API visibility filter rule.


key: force

description: If set to true, it would disable incremental build.


key: shouldSkipMarkup

description: If set to true, DocFX would not render triple-slash-comments in source code as markdown.


key: filter

description: Defines the filter configuration file.


key: useCompatibilityFileName

description: If set to true, DocFX would keep ` in comment id instead of replacing it with -.


key: fileMappingContent

description: Contains all the files to generate documentation, including metadata `yml` files and conceptual `md` files.


key: fileMappingResource

description: Contains all the resource files that conceptual and metadata files dependent on, e.g. image files.


key: fileMappingOverwrite

description: Contains all the conceptual files which contains yaml header with `uid` and is intended to override the existing metadata `yml` files.


key: fileMappingExternalReferences

description: [Obsoleted] Contains `rpk` files that define the external references.


key: fileMappingSrc

description: Defines the source projects to have metadata generated.


key: name

description: The name of current item, the value is not used for now.


key: src

description: Defines the root folder for the source files, it has the same meaning as `cwd`


key: cwd

description: [Obsoleted] Defines the root folder for the source files, it has the same meaning as `src`


description: The destination folder for the files if copy/transform is used.


key: version

description:
Version name for the current file-mapping item.
If not set, treat the current file-mapping item as in default version.
Mappings with the same version name will be built together.
Cross reference doesn't support cross different versions.


key: rootTocPath

description:
The Root TOC Path used for navbar in current version, relative to output root.
If not set, will use the toc in output root in current version if exists.


key: case

description:
Pattern match will be case sensitive.
By default the pattern is case insensitive.


key: noNegate

description:
Disable pattern begin with `!` to mean negate.
By default the usage is enabled.


key: noExpand

description: Disable `{a,b}c` => `["ac", "bc"]`. By default the usage is enabled.


key: noEscape

description:
Disable the usage of `\` to escape values.
By default the usage is enabled.


key: noGlobStar

description:
Disable the usage of `**` to match everything including `/` when it is the beginning of the pattern or is after `/`.
By default the usage is enable.


key: dot

description:
Allow files start with `.` to be matched even if `.` is not explicitly specified in the pattern.
By default files start with `.` will not be matched by `*` unless the pattern starts with `.`.


key: xref

description: Specifies the urls of xrefmap used by content files. Currently, it supports following scheme: http, https, ftp, file, embedded.


key: globalMetadataFiles

description: Specify a list of JSON file path containing globalMetadata settings, as similar to `{"key":"value"}`.


key: fileMetadataFiles

description: Specify a list of JSON file path containing fileMetadata settings, as similar to `{"key":"value"}`.


key: template

description: The latter ones will override the former ones if the name of the file inside the template collides. If omitted, embedded default template will be used.


key: theme

description: The themes applied to the documentation. Theme is used to customize the styles generated by `template`. It can be a string or an array. The latter ones will override the former ones if the name of the file inside the template collides. If omitted, no theme will be applied, the default theme inside the template will be used.


key: files

description: The file glob pattern collection, with path relative to property `src`/`cwd` if value is set.


key: exclude

description: The file glob pattern collection for files that should be excluded, with path relative to property `src`/`cwd` if value is set.


key: disableGitFeatures

description: If set to true, DocFX would not fetch Git related information for articles.


description:
A CLI of the current application
https://bashly.dannyb.co/usage/getting-started/

examples: cli upload profile.png -u admin -p s3cr3t

examples: This will appear at the end of the --help message

examples: Additional arguments or flags for AWS CLI

examples: <alias> <arrayvar> <binding> <builtin> <command> <directory> <disabled> <enabled> <export> <file> <function> <group> <helptopic> <hostname> <job> <keyword> <running> <service> <setopt> <shopt> <signal> <stopped> <user> <variable>


key: argument

description:
A positional argument of the current script or sub-command
https://bashly.dannyb.co/configuration/argument/


key: name

description:
A name of the current positional argument
https://bashly.dannyb.co/configuration/argument/#name


key: help

description:
A description of the current positional argument
https://bashly.dannyb.co/configuration/argument/#help


key: default

description:
A default value of the current positional argument
https://bashly.dannyb.co/configuration/argument/#default


key: required

description:
Whether the current positional argument is required
https://bashly.dannyb.co/configuration/argument/#required


key: allowed

description:
Valid values of the current positional argument
https://bashly.dannyb.co/configuration/argument/#allowed


key: items

description: A valid value of the current positional argument


key: repeatable

description:
Whether the current positional argument can be repeated
https://bashly.dannyb.co/configuration/argument/#repeatable


key: validate

description:
A validation function of the current positional argument
https://bashly.dannyb.co/configuration/argument/#validate


key: flag

description:
A flag of the current script or sub-command
https://bashly.dannyb.co/configuration/flag/


key: long

description:
A long form of the current flag
https://bashly.dannyb.co/configuration/flag/#long


key: short

description:
A short form of the current flag
https://bashly.dannyb.co/configuration/flag/#short


description:
A description of the current flag
https://bashly.dannyb.co/configuration/flag/#help


key: arg

description:
An argument name of the current flag
https://bashly.dannyb.co/configuration/flag/#arg


description:
A default value of the current flag
https://bashly.dannyb.co/configuration/flag/#default


description:
Whether the current flag is required
https://bashly.dannyb.co/configuration/flag/#required


description:
Valid values of the current flag
https://bashly.dannyb.co/configuration/flag/#allowed


key: conflicts

description:
Mutually exclusive flags of the current flag
https://bashly.dannyb.co/configuration/flag/#conflicts


description: A mutually exclusive flag of the current flag


key: completions

description:
Completions of the current flag
https://bashly.dannyb.co/configuration/flag/#completions


description: A completion of the current flag


key: private

description:
Whether the current flag is hidden from help
https://bashly.dannyb.co/configuration/flag/#private


description:
Whether the current flag can be repeated
https://bashly.dannyb.co/configuration/flag/#repeatable


description:
A validation function of the current flag
https://bashly.dannyb.co/configuration/flag/#validate


key: name-property

description:
A name of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#name


key: sub-command-alias-property

description:
An alias of the current sub-command
https://bashly.dannyb.co/configuration/command/#alias


description:
Aliases of the current sub-command
https://bashly.dannyb.co/configuration/command/#alias


description: An alias of the current sub-command


key: help-property

description:
A description of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#help


key: args-property

description:
Arguments of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#args


key: flags-property

description:
Flags of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#flags


key: commands-property

description:
Subcommands of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#commands


key: root-version-property

description:
A version of the current script
https://bashly.dannyb.co/configuration/command/#version


key: sub-command-default-property

description:
Whether to use the current command as a fallback when CLI used incorrectly
https://bashly.dannyb.co/configuration/command/#default


key: environment-variables-name-property

description:
A name of the current environment variable
https://bashly.dannyb.co/configuration/environment-variable/#name


key: environment-variables-help-property

description:
A description of the current environment variable
https://bashly.dannyb.co/configuration/environment-variable/#help


key: environment-variables-default-property

description:
A default value of the current environment variable
https://bashly.dannyb.co/configuration/environment-variable/#default


key: environment-variables-private-property

description:
Whether the current environment variable is hidden from help
https://bashly.dannyb.co/configuration/environment-variable/#private


key: environment-variables-required-property

description:
Whether the current environment variable is required
https://bashly.dannyb.co/configuration/environment-variable/#required


key: environment-variables-property

description:
Environment variables of the current application
https://bashly.dannyb.co/configuration/environment-variable/#environment-variable


key: items

description:
An environment variable of the current application
https://bashly.dannyb.co/configuration/environment-variable/#environment-variable


key: examples-property

description:
An example of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#examples


description:
Examples of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#examples


key: footer-property

description:
A description footer for the current script or sub-command
https://bashly.dannyb.co/configuration/command/#footer


key: sub-command-group-property

description:
A group of the current sub-command
https://bashly.dannyb.co/configuration/command/#group


key: catch-all-property

description:
Whether to allow additional arguments or flags for the current command
https://bashly.dannyb.co/configuration/command/#catch_all


key: label

description:
A label for the current argument or flag
https://bashly.dannyb.co/configuration/command/#catch_all


key: help

description:
A description for the current argument or flag
https://bashly.dannyb.co/configuration/command/#catch_all


key: required

description:
Whether the current argument or flag is required
https://bashly.dannyb.co/configuration/command/#catch_all


key: completions-property

description:
Completions of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#completions


description: A completion of the current script or sub-command


key: dependencies-command-property

description:
Dependencies of the current script or sub-command
https://bashly.dannyb.co/configuration/dependency/#command


description:
A dependency of the current script or sub-command
https://bashly.dannyb.co/configuration/dependency/#command


key: dependencies-help-property

description:
A help for the current dependency
https://bashly.dannyb.co/configuration/dependency/#help


key: dependencies-property

description:
Dependencies of the current script or sub-command
https://bashly.dannyb.co/configuration/dependency/#dependency


description:
A dependency of the current script or sub-command
https://bashly.dannyb.co/configuration/dependency/#dependency


key: sub-command-expose-property

description:
Whether to expose the current sub-command if it has sub-commands
https://bashly.dannyb.co/configuration/command/#expose


key: root-extensible-property

description:
Whether to delegate the current unknown command to an external executable
https://bashly.dannyb.co/configuration/command/#extensible


key: filename-property

description:
A partial file path of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#filename


key: filters-property

description:
Filters of the current script or sub-command
https://bashly.dannyb.co/configuration/command/#filters


description: A filter of the current script or sub-command


key: function-property

description:
An internal function for the current script or sub-command
https://bashly.dannyb.co/configuration/command/#function


key: sub-command-private-property

description:
Whether hide the current sub-command from help
https://bashly.dannyb.co/configuration/command/#private


key: sub-command-import-property

description:
A file import for the current sub-command
https://bashly.dannyb.co/configuration/command/#import


key: command-property

description:
A command of the current application
https://bashly.dannyb.co/configuration/command/#command


description: A Backport config schema

required: name checked

required: repoName repoOwner targetBranchChoices


key: repoName

description:
A repo name for the current project
https://github.com/sqren/backport/blob/main/docs/config-file-options.md#reponame-required


key: repoOwner

description:
A repo owner for the current project
https://github.com/sqren/backport/blob/main/docs/config-file-options.md#repoowner-required


key: targetBranchChoices

description:
Target branches for the current project
https://github.com/sqren/backport/blob/main/docs/config-file-options.md#targetbranchchoices-required


key: items

description:
A target branch for the current project
https://github.com/sqren/backport/blob/main/docs/config-file-options.md#targetbranchchoices-required


key: name


key: checked

description:
Whether to pre-select a target branch for the current project
https://github.com/sqren/backport/blob/main/docs/config-file-options.md#targetbranchchoices-required


key: upsteam

description: Identifier for the GitHub project as `{owner}/{repoName}`


key: branches

description: Branches to backport to


key: labels

description: Labels that will be added to the pull request


key: all

description: Whether to only show the current user's commits or commits from anyone


description: Package name, including 'vendor-name/' prefix.


key: description

description: Short package description.


key: license

description: License name. Or an array of license names.

type: string array


key: type

description: Package type, either 'library' for common packages, 'composer-plugin' for plugins, 'metapackage' for empty packages, or a custom type ([a-z0-9-]+) defined by whatever project this package applies to.


key: abandoned

description: Indicates whether this package has been abandoned, it can be boolean or a package name/URL pointing to a recommended alternative. Defaults to false.

type: boolean string


key: version

description: Package version, see https://getcomposer.org/doc/04-schema.md#version for more info on valid schemes.


key: default-branch

description: Internal use only, do not specify this in composer.json. Indicates whether this version is the default branch of the linked VCS repository. Defaults to false.


key: non-feature-branches

description: A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.


description: A tag/keyword that this package relates to.


key: readme

description: Relative path to the readme document.


key: time

description: Package release date, in 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS' or 'YYYY-MM-DDTHH:MM:SSZ' format.


key: homepage

description: Homepage URL for the project.

format: uri


key: email

description: Email address for support.

format: email


key: issues

description: URL to the issue tracker.


key: forum

description: URL to the forum.


key: wiki

description: URL to the wiki.


key: irc

description: IRC channel for support, as irc://server/channel.


key: chat

description: URL to the support chat.


key: source

description: URL to browse or download the sources.


key: docs

description: URL to the documentation.


key: rss

description: URL to the RSS feed.


key: security

description: URL to the vulnerability disclosure policy (VDP).


key: funding

description: A list of options to fund the development and maintenance of the package.


key: type

description: Type of funding or platform through which funding is possible.


key: url

description: URL to a website with details on funding and a way to fund the package.


description: A key to store comments in

type: array string


key: require

description: This is an object of package name (keys) and version constraints (values) that are required to run this package.


key: require-dev

description: This is an object of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).


key: replace

description: This is an object of package name (keys) and version constraints (values) that can be replaced by this package.


key: conflict

description: This is an object of package name (keys) and version constraints (values) that conflict with this package.


key: provide

description: This is an object of package name (keys) and version constraints (values) that this package provides in addition to this package's name.


key: suggest

description: This is an object of package name (keys) and descriptions (values) that this package suggests work well with it (this will be suggested to the user during installation).


key: repositories

description: A set of additional repositories where packages can be found.

type: object array


key: minimum-stability

description: The minimum stability the packages must have to be install-able. Possible values are: dev, alpha, beta, RC, stable.

enum: dev alpha beta rc RC stable


key: prefer-stable

description: If set to true, stable packages will be preferred to dev packages when possible, even if the minimum-stability allows unstable packages.


key: autoload-dev

description: Description of additional autoload rules for development purpose (eg. a test suite).


description: This is an object of namespaces (keys) and the directories they can be found into (values, can be arrays of paths) by the autoloader.


description: This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.


key: classmap

description: This is an array of paths that contain classes to be included in the class-map generation process.


key: files

description: This is an array of files that are always required on every request.


key: target-dir

description: DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.


key: include-path

description: DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.


key: bin

description: A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).


key: archive

description: Options for creating package archives for distribution.


key: name

description: A base name for archive.


key: exclude

description: A list of patterns for paths to exclude or include if prefixed with an exclamation mark.


key: config

description: Composer options.

type: string boolean

type: object boolean

type: string object

required: username token

enum: git http https

required: username password

type: string integer

enum: auto full proxy symlink

required: consumer-key consumer-secret


key: platform

description: This is an object of package name (keys) and version (values) that will be used to mock the platform packages on this machine, the version can be set to false to make it appear like the package is not present.


key: allow-plugins

description: This is an object of {"pattern": true|false} with packages which are allowed to be loaded as plugins, or true to allow all, false to allow none. Defaults to {} which prompts when an unknown plugin is added.


key: process-timeout

description: The timeout in seconds for process executions, defaults to 300 (5mins).


key: use-include-path

description: If true, the Composer autoloader will also look for classes in the PHP include path.


key: use-parent-dir

description: When running Composer in a directory where there is no composer.json, if there is one present in a directory above Composer will by default ask you whether you want to use that directory's composer.json instead. One of: true (always use parent if needed), false (never ask or use it) or "prompt" (ask every time), defaults to prompt.


key: preferred-install

description: The install method Composer will prefer to use, defaults to auto and can be any of source, dist, auto, or an object of {"pattern": "preference"}.


key: audit

description: Security audit configuration options


key: ignored

description: A set of advisory ids, remote ids or CVE ids that should be ignored and not reported as part of an audit.


key: notify-on-install

description: Composer allows repositories to define a notification URL, so that they get notified whenever a package from that repository is installed. This option allows you to disable that behaviour, defaults to true.


key: github-protocols

description: A list of protocols to use for github.com clones, in priority order, defaults to ["https", "ssh", "git"].


key: github-oauth

description: An object of domain name => github API oauth tokens, typically {"github.com":"<token>"}.


key: gitlab-oauth

description: An object of domain name => gitlab API oauth tokens, typically {"gitlab.com":{"expires-at":"<expiration date>", "refresh-token":"<refresh token>", "token":"<token>"}}.


key: expires-at

description: The expiration date for this GitLab token


key: refresh-token

description: The refresh token used for GitLab authentication


key: token

description: The token used for GitLab authentication


key: gitlab-token

description: An object of domain name => gitlab private tokens, typically {"gitlab.com":"<token>"}, or an object with username and token keys.


key: username

description: The username used for GitLab authentication


key: gitlab-protocol

description: A protocol to force use of when creating a repository URL for the `source` value of the package metadata. One of `git` or `http`. By default, Composer will generate a git URL for private repositories and http one for public repos.


key: bearer

description: An object of domain name => bearer authentication token, for example {"example.com":"<token>"}.


key: disable-tls

description: Defaults to `false`. If set to true all HTTPS URLs will be tried with HTTP instead and no network level encryption is performed. Enabling this is a security risk and is NOT recommended. The better way is to enable the php_openssl extension in php.ini.


key: secure-http

description: Defaults to `true`. If set to true only HTTPS URLs are allowed to be downloaded via Composer. If you really absolutely need HTTP access to something then you can disable it, but using "Let's Encrypt" to get a free SSL certificate is generally a better alternative.


key: secure-svn-domains

description: A list of domains which should be trusted/marked as using a secure Subversion/SVN transport. By default svn:// protocol is seen as insecure and will throw. This is a better/safer alternative to disabling `secure-http` altogether.


key: cafile

description: A way to set the path to the openssl CA file. In PHP 5.6+ you should rather set this via openssl.cafile in php.ini, although PHP 5.6+ should be able to detect your system CA file automatically.


key: capath

description: If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.


key: http-basic

description: An object of domain name => {"username": "...", "password": "..."}.


description: The username used for HTTP Basic authentication


key: password

description: The password used for HTTP Basic authentication


key: store-auths

description: What to do after prompting for authentication, one of: true (store), false (do not store) or "prompt" (ask every time), defaults to prompt.


key: vendor-dir

description: The location where all packages are installed, defaults to "vendor".


key: bin-dir

description: The location where all binaries are linked, defaults to "vendor/bin".


key: data-dir

description: The location where old phar files are stored, defaults to "$home" except on XDG Base Directory compliant unixes.


key: cache-dir

description: The location where all caches are located, defaults to "~/.composer/cache" on *nix and "%LOCALAPPDATA%\Composer" on windows.


key: cache-files-dir

description: The location where files (zip downloads) are cached, defaults to "{$cache-dir}/files".


key: cache-repo-dir

description: The location where repo (git/hg repo clones) are cached, defaults to "{$cache-dir}/repo".


key: cache-vcs-dir

description: The location where vcs infos (git clones, github api calls, etc. when reading vcs repos) are cached, defaults to "{$cache-dir}/vcs".


key: cache-ttl

description: The default cache time-to-live, defaults to 15552000 (6 months).


key: cache-files-ttl

description: The cache time-to-live for files, defaults to the value of cache-ttl.


key: cache-files-maxsize

description: The cache max size for the files cache, defaults to "300MiB".


key: cache-read-only

description: Whether to use the Composer cache in read-only mode.


key: bin-compat

description: The compatibility of the binaries, defaults to "auto" (automatically guessed), can be "full" (compatible with both Windows and Unix-based systems) and "proxy" (only bash-style proxy).


key: discard-changes

description: The default style of handling dirty updates, defaults to false and can be any of true, false or "stash".


key: autoloader-suffix

description: Optional string to be used as a suffix for the generated Composer autoloader. When null a random one will be generated.


key: optimize-autoloader

description: Always optimize when dumping the autoloader.


key: prepend-autoloader

description: If false, the composer autoloader will not be prepended to existing autoloaders, defaults to true.


key: classmap-authoritative

description: If true, the composer autoloader will not scan the filesystem for classes that are not found in the class map, defaults to false.


key: apcu-autoloader

description: If true, the Composer autoloader will check for APCu and use it to cache found/not-found classes when the extension is enabled, defaults to false.


key: github-domains

description: A list of domains to use in github mode. This is used for GitHub Enterprise setups, defaults to ["github.com"].


key: github-expose-hostname

description: Defaults to true. If set to false, the OAuth tokens created to access the github API will have a date instead of the machine hostname.


key: gitlab-domains

description: A list of domains to use in gitlab mode. This is used for custom GitLab setups, defaults to ["gitlab.com"].


key: bitbucket-oauth

description: An object of domain name => {"consumer-key": "...", "consumer-secret": "..."}.


key: consumer-key

description: The consumer-key used for OAuth authentication


key: consumer-secret

description: The consumer-secret used for OAuth authentication


key: access-token

description: The OAuth token retrieved from Bitbucket's API, this is written by Composer and you should not set it nor modify it.


key: access-token-expiration

description: The generated token's expiration timestamp, this is written by Composer and you should not set it nor modify it.


key: use-github-api

description: Defaults to true.  If set to false, globally disables the use of the GitHub API for all GitHub repositories and clones the repository as it would for any other repository.


key: archive-format

description: The default archiving format when not provided on cli, defaults to "tar".


key: archive-dir

description: The default archive path when not provided on cli, defaults to ".".


key: htaccess-protect

description: Defaults to true. If set to false, Composer will not create .htaccess files in the composer home, cache, and data directories.


key: sort-packages

description: Defaults to false. If set to true, Composer will sort packages when adding/updating a new dependency.


key: lock

description: Defaults to true. If set to false, Composer will not create a composer.lock file.


key: platform-check

description: Defaults to "php-only" which checks only the PHP version. Setting to true will also check the presence of required PHP extensions. If set to false, Composer will not create and require a platform_check.php file as part of the autoloader bootstrap.


key: extra

description: Arbitrary extra data that can be used by plugins, for example, package of type composer-plugin may have a 'class' key defining an installer class name.


key: scripts

description: Script listeners that will be executed before/after some events.


key: pre-install-cmd

description: Occurs before the install command is executed, contains one or more Class::method callables or shell commands.


key: post-install-cmd

description: Occurs after the install command is executed, contains one or more Class::method callables or shell commands.


key: pre-update-cmd

description: Occurs before the update command is executed, contains one or more Class::method callables or shell commands.


key: post-update-cmd

description: Occurs after the update command is executed, contains one or more Class::method callables or shell commands.


key: pre-status-cmd

description: Occurs before the status command is executed, contains one or more Class::method callables or shell commands.


key: post-status-cmd

description: Occurs after the status command is executed, contains one or more Class::method callables or shell commands.


key: pre-package-install

description: Occurs before a package is installed, contains one or more Class::method callables or shell commands.


key: post-package-install

description: Occurs after a package is installed, contains one or more Class::method callables or shell commands.


key: pre-package-update

description: Occurs before a package is updated, contains one or more Class::method callables or shell commands.


key: post-package-update

description: Occurs after a package is updated, contains one or more Class::method callables or shell commands.


key: pre-package-uninstall

description: Occurs before a package has been uninstalled, contains one or more Class::method callables or shell commands.


key: post-package-uninstall

description: Occurs after a package has been uninstalled, contains one or more Class::method callables or shell commands.


key: pre-autoload-dump

description: Occurs before the autoloader is dumped, contains one or more Class::method callables or shell commands.


key: post-autoload-dump

description: Occurs after the autoloader is dumped, contains one or more Class::method callables or shell commands.


key: post-root-package-install

description: Occurs after the root-package is installed, contains one or more Class::method callables or shell commands.


key: post-create-project-cmd

description: Occurs after the create-project command is executed, contains one or more Class::method callables or shell commands.


key: scripts-descriptions

description: Descriptions for custom commands, shown in console help.


key: authors

description: List of authors that contributed to the package. This is typically the main maintainers, not the full list.


key: name

description: Full name of the author.


key: email

description: Email address of the author.


key: homepage

description: Homepage URL for the author.


key: role

description: Author's role in the project.


key: autoload

description: Description of how the package can be autoloaded.


description: This is an object of namespaces (keys) and the directories they can be found in (values, can be arrays of paths) by the autoloader.


description: This is an object of namespaces (keys) and the PSR-4 directories they can map to (values, can be arrays of paths) by the autoloader.


key: classmap

description: This is an array of paths that contain classes to be included in the class-map generation process.


key: files

description: This is an array of files that are always required on every request.


key: exclude-from-classmap

description: This is an array of patterns to exclude from autoload classmap generation. (e.g. "exclude-from-classmap": ["/test/", "/tests/", "/Tests/"]


description: Package name, including 'vendor-name/' prefix.


key: target-dir

description: DEPRECATED: Forces the package to be installed into the given subdirectory path. This is used for autoloading PSR-0 packages that do not contain their full path. Use forward slashes for cross-platform compatibility.


key: bin

description: A set of files, or a single file, that should be treated as binaries and symlinked into bin-dir (from config).


key: include-path

description: DEPRECATED: A list of directories which should get added to PHP's include path. This is only present to support legacy projects, and all new code should preferably use autoloading.


description: Spec directory path relative to the current working dir when jasmine is executed.


description: Array of filepaths (and globs) relative to spec_dir to include and exclude.


key: helpers

description: Array of filepaths (and globs) relative to spec_dir to include before jasmine specs


key: env-items

description: Configuration of the Jasmine environment


key: autoCleanClosure

description: Clean closures when a suite is done running (done by clearing the stored function reference). This prevents memory leaks, but you won't be able to run jasmine multiple times.


key: failSpecWithNoExpectations

description: Whether to fail the spec if it ran no expectations. By default a spec that ran no expectations is reported as passed. Setting this to true will report such spec as a failure.


key: hideDisbaled

description: Whether or not reporters should hide disabled specs from their output. Currently only supported by Jasmine's HTMLReporter.


key: random

description: Whether to randomize spec execution order.


key: seed

description: Seed to use as the basis of randomization. Null causes the seed to be determined randomly at the start of execution.


key: stopOnSpecFailure

description: Whether to stop execution of the suite after the first spec failure.


key: stopSpecOnExpectationFailure

description: Whether to cause specs to only have one expectation failure.


key: verboseDeprication

description: Whether or not to issue warnings for certain deprecated functionality every time it's used. If not set or set to false, deprecation warnings for methods that tend to be called frequently will be issued only once or otherwise throttled to to prevent the suite output from being flooded with warnings.


key: File

description: Relative path to a file, case sensitive.

format: uri-reference


key: URL

description: A public URL.


key: Flags

description: Flag data.


key: minimum

description: The module will not function for versions earlier than this.


key: verified

description: The module has been verified to be compatible up to this version.


key: maximum

description: The module will not function for newer versions than this.


key: id

description: Dependency entries require the id attribute. If only an id is provided, additional details about the module will be discovered from the Foundry VTT website listing.


key: type

description: The type attribute instructs FoundryVTT that the dependency may be on a different type of package. By default dependencies are assumed to be a module, so if you want to depend on a system or world you should be explicit.

default: module

enum: module system world


key: manifest

description: The manifest attribute provides an explicit manifest url to be used for downloading the dependency. If a manifest is not provided, the dependency package must exist in the Foundry website directory.


key: compatibility

description: As above, the compatibility of a dependency can be defined, ensuring that the dependency will not be installed if it does not meet the defined requirements.


key: reason

description: (undocumented, intended to be used by core Foundry in the future)


description: Choose a unique package identifier. This must be an all lower-case string with no special characters and should use hyphens (not underscores) to separate multiple terms. This name must match exactly with the name of the parent directory within which you create the package.


key: title

description: Provide a human readable title for the package which is displayed as the visible name for the package in the Setup menu and elsewhere.

examples:
Simple World-Building
Unfulfilled Rolls


key: description

description: This field can contain a more lengthy description of the package. This text can be used to describe the functionality, list contact information, provide recommendations to contributors or testers, or any other information you feel is important to provide. This field can contain HTML to structure and style your text. For a system, this is also a good place to include any special licensing or attribution information that you need to distribute.

examples: A minimalist game system which provides configurable Actor and Item templates to support free-form system agnostic game-play.

examples: A module to integrate World Anvil with Foundry Virtual Tabletop.


key: authors

description: An array listing each author as an object that contains a name and potentially some contact details.


key: name

description: The only required field for an author.  This can be your username, your full name, etc.


key: ko-fi

description: (Manifest+ field)


key: patreon

description: (Manifest+ field)


key: reddit

description: (Manifest+ field)


key: twitter

description: (Manifest+ field)


key: url

description: A public URL that links to the repository or documentation pages for the package. This link will be displayed for users to allow them to find more information about your package. If your package is hosted in version control like GitHub or GitLab, linking to the repository in this field is a good choice.


key: license

description: A path to a license file relative to the root package folder or a publicly accessible URL which contains the software license that applies to this package.


key: readme

description: A path to a read-me file relative to the root package folder or a publicly accessible URL which contains instructions or information about the package.


key: bugs

description: A publicly accessible URL where issues, suggestions, and bug reports may be filed.


key: changelog

description: A publicly accessible URL where update and release notes about the package may be found.


key: media


key: version

description: The package version number can be a number or a string which denotes the version of your module/system/world. When making changes to your package, incrementing the version number in your manifest file is used to signal to users that an update is available. We discuss some supported options for versioning in the Introduction to Development article.


key: compatibility

description: The compatibility field is an object key for capturing the sub-fields which defines the limits of your package's compatibility based on Foundry Virtual Tabletop version.


key: scripts

description: A less common way of including Javascript with the increasing adoption of ESModules, this field allows you to define an array of JavaScript file paths which should be included whenever this package is being used. Each listed script path should be relative to the package root directory. All scripts which exist will be automatically included in the game session and loaded in their listed order.


key: esmodules

description: The preferred method for including Javascript with your project. This field allows you to define an array of JS files which use the newer ES6 modules specification. As with scripts, this should be declared as an array. These files are identified separately in the manifest so they may be correctly loaded as a module rather than a script.


key: styles

description: You can designate an array of CSS files which should be included in the game session whenever this package is used. Each listed stylesheet path should be relative to the package root directory. All stylesheets which exist will be automatically included in the game session and loaded in their listed order.


key: languages

description: A list of localization files that Foundry can use to translate strings.

examples: en fr de zh-tw

examples:
English
Français
Deutsch
简体中文（Simplified Chinese）

required: lang path


key: items

description: The language definition


key: lang

description: A language code in lower-case letters, for example "en" for English. See https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes


key: name

description: The formal and readable name for the language, for example "English".


key: path

description: A path relative to the root directory of the manifest where localization strings are provided in JSON format.


key: system

description: (undocumented)


key: module

description: (undocumented)


key: packs

description: Packages may come bundled with Compendium packs which include game content for various Document types. Compendium packs are defined as objects which have their own internal metadata structure.

examples: abomination-vaults-bestiary fxmaster

examples:
TokenMagic Portfolio
Premade Items

enum: Actor Cards Adventure Item Journal JournalEntry Macro Playlist RollTable Table Scene

deprecationMessage: Use type instead. Deprecated since V9.

required: name label path type


description: The definition of a Compendium pack.


description: Name of the Compendium pack. This should be a lowercase string with no special characters other than hyphens.


key: label

description: Human readable label of the Compendium pack. This is displayed in the Compendium sidebar.


description: The relative path to the Compendium .db file. Best practice is to put these in the /packs subdirectory. Required until V11; afterwards, can be omitted if pack resides in `package-id/packs/`.


key: private

description: (undocumented, will hide pack from non-GMs)


key: type

description: Each Compendium pack must designate which type of Entity it contains.


description: The id of the system/s the Compendium pack is created for. This ensures Foundry knows this Compendium only works for that system. This may be a string or an array of strings. Important: Actor, Item, and Adventure compendium packs MUST define a system field.


key: relationships

description: Packages can require modules, systems, or worlds be installed to allow their use. If a package has been installed with dependencies, but its dependencies are missing, it cannot be enabled.


key: systems

description: Will only allow the package to activated within Worlds which are running one of these systems and with a compatible version.


key: requires

description: If a package has been installed with dependencies, but its dependencies are missing, it cannot be enabled.


key: recommends

description: (undocumented, intended to be used by core Foundry in the future)


key: conflicts


description: The definition of a dependency package.


key: id

description: ID of the package this package depends on.


description: The type of dependency.


key: manifest

description: Provides an explicit URL to the dependency's manifest to be able to install the package. If not provided, Foundry will check the website package list.


key: socket

description: A package may request for a specialized socket namespace to be provided. If set to true, a socket event will be handled by the server with the name `system.${id}` (for a system) or `module.${id}` (for a module), and will transact a arbitrary data object by broadcasting that data to all connected clients. This allows the package to have a reserved channel for messaging events which are needed to coordinate actions across multiple connected clients.


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/module 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: download

description: A public URL that provides a zip archive of the package for the manifest version which points to it. The archive at this URL is retrieved during the installation or update process. If you are using version control for your package - it is recommended to manage download archives using the tags and releases features which are supported by most git repositories.


key: protected

description: (undocumented, used for premium packages)


key: exclusive

description: (undocumented)


key: persistentStorage


key: documentTypes

description: (intended to be used by core Foundry in the future, see Module Sub-Types article)


key: manifestPlusVersion

description: (Manifest+ field)


key: includes

description: (Manifest+ field)


key: deprecated

description: (Manifest+ field)


description: (Manifest+ field)


key: WebJobs

description: A list of Azure Webjobs.


description: This is the fallback to the latest version (the first one in this schema) in case no version is specified.


description:
Build tool with support for containerization
https://no0dles.gitbook.io/hammerkit/build-file

required: image cmds

enum: checksum modify-date none

required: context selector ports

required: type name

enum: deployment service pod


key: buildFileEnvs

description:
Environment values for the current build task
https://no0dles.gitbook.io/hammerkit/build-file/environment-variables


key: additionalProperties

description: environment variable


key: buildFileTasks

description:
Task for the current build file
https://no0dles.gitbook.io/hammerkit/task


key: buildFileServices

description:
Services for the current build file
https://no0dles.gitbook.io/hammerkit/service


key: buildFileIncludes

description:
Includes to other build files
https://no0dles.gitbook.io/hammerkit/build-file/includes


key: buildFileReferences

description:
References to other build files
https://no0dles.gitbook.io/hammerkit/build-file/references


key: task


key: localTask

description: Task that gets executed in the local shell in the current directory


key: cmds

description: Commands for the current task


key: containerTask

description:
Container task for the current build file
https://no0dles.gitbook.io/hammerkit/task/container


key: shell

description: Define which shell is used to execute the commands


key: image

description: Container image for the current task to run commands in


key: ports

description: A list of ports that get exposed on the host from the container <localPort>:<targetPort>


key: items

description: <localPort>:<targetPort>


key: mounts

description:
File paths that get mounted into the container
https://no0dles.gitbook.io/hammerkit/task/container#adding-mounts


key: taskCommand

description: Command to be executed for the current task


description: Command to be executed in sub directory for the current task


key: cmd

description: Command to be executed for the task


key: path

description: Path below build file path


key: taskDescription

description: Description for the current task


key: taskExtend

description:
Extension task as a base template
https://no0dles.gitbook.io/hammerkit/task/extending


key: taskCache

description:
compare type for detecting changes in source files
https://no0dles.gitbook.io/hammerkit/task/caching


key: taskContinuous

description:
The task runs continuous and does not end without cancellation
https://no0dles.gitbook.io/hammerkit/task/watching#continuous-tasks


key: taskLabels

description:
A map of label values for the current task
https://no0dles.gitbook.io/hammerkit/labels


key: additionalProperties

description: label value


key: taskEnvs

description:
Environment values for the current build file
https://no0dles.gitbook.io/hammerkit/build-file/environment-variables


description: environment value


key: taskNeeds

description:
Service needs that need to get ready before the current task
https://no0dles.gitbook.io/hammerkit/task/needs


key: taskDeps

description:
Task dependencies that get executed before the current task
https://no0dles.gitbook.io/hammerkit/task/dependencies


key: taskSrc

description:
Source files and folders for the current task
https://no0dles.gitbook.io/hammerkit/task#source


key: taskGenerates

description:
Generated files and folders for the current task

https://no0dles.gitbook.io/hammerkit/task#generate


key: service

description: A daemon in the background


key: kubernetesService

description:
Kubernetes service for the current build file
https://no0dles.gitbook.io/hammerkit/service/kubernetes


key: kubeconfig

description:
Kube config for the current service
https://no0dles.gitbook.io/hammerkit/service/kubernetes#config


key: context

description:
Kubernetes context for the current service
https://no0dles.gitbook.io/hammerkit/service/kubernetes#config


key: ports

description: A list of ports that get exposed on the host from the service <localPort>:<targetPort>


key: items

description: <localPort>:<targetPort>


key: selector

description:
Selector to specify which resource gets forwarded to
https://no0dles.gitbook.io/hammerkit/service/kubernetes


key: type

description: resource type for the current service


key: name

description: resource name for the kubernetes resource


key: containerService

description:
Container service for the current build file
https://no0dles.gitbook.io/hammerkit/service/kubernetes


key: labels

description:
A map of label values for the current service
https://no0dles.gitbook.io/hammerkit/labels


key: envs

description:
Environment values for the current service
https://no0dles.gitbook.io/hammerkit/build-file/environment-variables


key: additionalProperties

description: environment value


key: healthcheck

description:
Check to detect if the service is started and ready
https://no0dles.gitbook.io/hammerkit/service/container#healthcheck


key: cmd

description: task to check if the service is healthy


key: image

description: Container image for the current service to run commands in


description:
A list of ports that get exposed on the host from the container <localPort>:<targetPort>
https://no0dles.gitbook.io/hammerkit/service/container#mounts


key: volumes

description:
A list of volumes that get attached to the container <name>:<containerPath>
https://no0dles.gitbook.io/hammerkit/service/container#mounts


description: <name>:<containerPath>


key: mounts

description:
File paths that get mounted into the container <localPath>:<containerPath>
https://no0dles.gitbook.io/hammerkit/service/container#mounts


description: <localPath>:<containerPath>


key: choices

description: A list of predefined choices


key: text

description: The displayed text


key: value

description: The value that the form returns for this choice


key: dataType

description: The option data type

const: string

const: number

const: boolean


key: defaultValue

description: The value used to pre-populate the option


key: dependsOn

description: The dependency that controls this options visibility


key: description

description: A tooltip to accompany the input


key: inputType

description: The HTML input type used to display the option

enum: text textarea checkbox select radio


key: label

description: A human-readable version of the name identifying the option


key: name

description: A unique, camelCase name


key: required

description: Whether the user is required to enter a value in the UI


key: validationRegex

description: A regex that validates the string representation of the option value when set


key: applyTo

description: The path patterns used to filter which files to apply the Transforms to


key: condition

description: The SpEL expression that determines if this Transform should execute


description: The transform name


key: transformations

description: A list of child Transforms to apply sequentially


key: chain


key: exclude

description: The path patterns used to filter which files to exclude


key: include

description: The path patterns used to filter which files to include


key: let

description: A list of additional variables and their values


key: merge

description: A list of child Transforms to be executed in parallel


key: onConflict

description: How conflict is handled when an operation produces multiple files at the same path


description: The options name


key: value

description: The desired options value to compare against


key: expression

description: The SpEL expression to evaluate to compute the symbol value


description: The name under which the new symbol will be added


key: patterns


key: noShadow

description: Whether shadowing should be turned off


key: symbols


key: index

description: The variable's name to be assigned to the index of the current element on each iteration


key: on

description: A SpEL expression that evaluates a list that contains the elements to be iterated over


key: var

description: The name of the variable to be assigned to the current element on each iteration


key: name

description: The transform name


key: sources


key: condition


key: options

description: Keys and values that depend on the class of the recipe


key: recipe

description: Full qualified classname of the recipe


key: regex

description: The replacement rule using a single regular expression


key: pattern

description: The regular expression that determines text that will be replaced


key: with

description: The SpEL expression that evaluates to the text that will replace the previous string


key: substitutions

description: The replacement rules using literal text tokens


key: text

description: The text that will be replaced


key: matchOrFail

description: Whether an error should occur if the regex doesn't match


description: The regular expression used to match each input files path


key: rewriteTo

description: The SpEL expression of the location that the file will be rewritten to


key: strategy


key: encoding

description: The encuding to use, as recognized by the java java.nio.charset.Charset class


key: allowList

description: A list of variable names that are allowed to be passed to YTT


key: denyList

description: A list of variable names that are denied from being passed to YTT


key: extraArgs

description: A list of SpEL expressions whose results are additional command line arguments


key: name

description: The transform name


key: accelerator

description: The metadata (non-behavioral) part of an App Accelerator's accelerator.yaml file


key: description

description: A more detailed description


key: displayName

description: A human-readable name


key: iconUrl

description: A URL pointing to an icon image


key: imports

description: The list of fragment to import


key: expose

description: The list of fragment options to make available as accelerator options


key: as

description: The alias to use as the name of the option


key: dependsOn

description: The dependency that controls this options visibility


description: The original name of the option


key: exposeTypes

description: The list of fragment types to make available as accelerator types


description: The alias to use as the name of the type


description: The original name of the type


description: The name of the fragment to import


key: options

description: The list of options passed to the UI to create input text boxes


key: tags

description: A list of tags used to filter accelerators


key: types

description: The definitions of custom types


description: The capitalized name of this custom type


key: struct

description: A sequence of option definitions


description: A helm test suite is a collection of tests with the same purpose and scope defined in one single file.

required: path value

required: path pattern

required: path content


key: suite

description: The suite name to show on test result output.


key: tests

description: Where you define your test jobs to run


key: it

description: Define the name of the test with TDD style or any message you like.


key: values

description: The values files used to renders the chart, think it as the -f, --values options of helm install. The file path should be the relative path from the test suite file itself.


key: set

description: Set the values directly in the suite file. The key is the value path with the format just like --set option of helm install, for example image.pullPolicy. The value is anything you want to set to the path specified by the key, which can be even an array or an object.


key: template

description: The template file(s) which render the manifest to be tested, default to the list of template file defined in templates of suite file, unless template is defined in the assertion(s).


key: asserts

description: The assertions to validate the rendered chart.


key: not

description: Set to true to assert contrarily, default to false.


description: The template file which render the manifest to be asserted, default to the list of template files defined in templates of the suite file, unless the template is in the testjob.


key: equal

description: Assert the value of the specified path is equal to the value.


key: value

description: The expected value.


description: Decode the base64 before checking.


key: equalRaw

description: Assert equal to the raw value.


description: Assert the expected value in a NOTES.txt file.


key: exists

description: Assert if the specified path exists.


key: notExists

description: Assert if the specified path NOT exists.


key: notEqual

description: Assert the value of specified path NOT equal to the value.


description: The value expected not to be.


key: notEqualRaw

description: Assert equal NOT to the value.


description: Assert the expected value in a NOTES.txt file not to be.


key: matchRegex

description: Assert the value of specified path match pattern.


key: pattern

description: The regex pattern to match (without quoting /).


key: matchRegexRaw

description: Assert the value match pattern.


description: The regex pattern to match (without quoting /) in a NOTES.txt file.


key: notMatchRegex

description: Assert the value of specified path NOT match pattern.


description: The regex pattern NOT to match (without quoting /).


key: notMatchRegexRaw

description: Assert the value NOT match pattern.


description: The regex pattern NOT to match (without quoting /) in a NOTES.txt file.


key: contains

description: Assert the array as the value of specified path contains the content.


key: content

description: The content to be contained.


key: count

description: The count of content to be contained.


key: any

description: Ignores any other values within the found content.


key: notContains

description: Assert the array as the value of specified path NOT contains the content.


description: The content NOT to be contained.


key: isNullOrEmpty

description: Assert the value of specified path is null or empty (null, "", 0, [], {}).


key: isNotNullOrEmpty

description: Assert the value of specified path is NOT null or empty (null, "", 0, [], {}).


key: isKind

description: Assert the kind value of manifest.


key: of

description: Expected kind of manifest.


key: isAPIVersion

description: Assert the apiVersion value of manifest.


description: Expected apiVersion of manifest.


key: isSubset

description: Assert the object as the value of specified path that contains the content.


key: isNotSubset

description: Assert the object as the value of specified path that NOT contains the content.


key: hasDocuments

description: Assert the documents count rendered by the template specified. The documentIndex option is ignored here.


description: Expected count of documents rendered.


key: lengthEqual


description: Expected count of spec rendered.


key: notLengthEqual

description: Assert the count rendered by the template specified to be equal. The documentIndex option is ignored here.


key: containsDocument

description: Asserts the documents rendered by the kind and apiVersion specified.


key: kind

description: Expected kind of manifest.


key: apiVersion

description: Expected apiVersion of manifest.


key: name

description: The value of the metadata.name.


key: namespace

description: The value of the metadata.namespace.


key: matchSnapshot

description: Assert the value of path is the same as snapshotted last time.


key: matchSnapshotRaw

description: Assert the value in the NOTES.txt is the same as snapshotted last time.


key: failedTemplate

description: Assert the value of errorMessage is the same as the human readable template error.


key: errorMessage

description: The (human readable) errorMessage that should occur.


key: notFailedTemplate

description: Assert that no failure occurs while templating.


key: paths

description: The set of paths to assert.Map keys in path containing periods (.) are supported with the use of a jq-like syntax.


key: path

description: The set path to assert. Map keys in path containing periods (.) are supported with the use of a jq-like syntax.


key: capabilities

description: Define the {{ .Capabilities }} object.


key: majorVersion

description: The kubernetes major version, default to the major version which is set by helm.


key: minorVersion

description: The kubernetes minor version, default to the minor version which is set by helm.


key: apiVersions

description: A set of versions, default to the versionset used by the defined kubernetes version.


key: chart

description: Define the {{ .Chart }} object.


key: version

description: The semantic version of the chart, default to the version set in the Chart.


key: appVersion

description: The app-version of the chart, default to the app-version set in the Chart.


key: documentIndex

description: The index of rendered documents (divided by ---) to be tested, default to -1, which results in asserting all documents (see Assertion). Generally you can ignored this field if the template file render only one document.


key: release

description: Define the {{ .Release }} object.


key: name

description: The release name, default to "RELEASE-NAME".


key: namespace

description: The namespace which release be installed to, default to "NAMESPACE".


key: revision

description: The revision of current build, default to 0.


key: upgrade

description: Whether the build is an upgrade, default to false.


key: templates

description: The template files scope to test in this suite. The full chart will be rendered, however only the listed templates are filtered for validation. Template files that are put in a templates sub-folder can be addressed with a linux path separator. Also the templates/ can be omitted. Partial templates (which are prefixed with and _) are added automatically even if it is in a templates sub-folder, you don't need to add them again.


key: values

description: The test values to apply for rendering of this chart.


key: networks

description: Policy files can reference the networks in this section by name. A network is a list of IP addresses or CIDR IP address ranges and may contain other networks.


key: services

description: Policy files can reference the services in this section by name. A service is a list of port/protocol pairs (e.g. port: 80, protocol: tcp) and can include port ranges. A service can include other services.


key: comment

description: Attach a comment directly to a value. This comment may be included in generated output on platforms that support it.


key: address

description: Specifies an IP address or CIDR IP address range expression.


key: fqdn

description: Specifies a fully qualified domain name with two or more labels.


key: port

description: Specifies a port or port range.


key: protocol

description: Specifies a protocol by name or number.


key: networkDefinition

description:
Defines a named network, composed of IP addresses, IP address ranges, and references to other networks.
An object with the "address" property adds that address or address range to the network.
An object with the "name" property includes the contents of that network into this one.
A single string also includes the content of that network into this one.


key: items

description: Include another network by name.


description: Include another network by name.


key: serviceDefinition

description: Defines a named service, composed of portocol, port pairs and/or references to other services.

required: port protocol


description: Include another service by name.


description: Include another service by name.


key: spacefile

description: Space app configuration

required: v micros


key: v

description: Version number of the Spacefile


key: icon

description: Path to an icon image file (PNG or WebP file of 512x512 pixels)


description: Display name of the app


key: micros

description: List of Micros in the app


key: micro

description: Micro configuration

enum: static react svelte vue next nuxt svelte-kit python3.9 python3.8 nodejs16 custom

required: name src engine

const: static

enum: static react vue svelte


key: name

description: Name of the Micro


key: src

description: Relative path to the root directory of the Micro


key: engine

description: Runtime engine for the Micro


key: primary

description: If the Micro should be the entry point for the app


key: path

description: Path relative to the hostname this Micro should receive requests on


key: serve

description: Directory path relative to the Micro's path that should be served for the static Micro


key: commands

description: Commands to run before packaging the Micro


key: include

description: Files and directories in the Micro's source directory that should be part of the final app package


key: run

description: Command to start the Micro


key: dev

description: Command to start the Micro in development mode


description: Routes that will be available publicly


key: public

description: If the Micro should be available to the public


key: actions

description: Tasks that run on triggers like a schedule


key: presets

description: Presets to use for the Micro


key: env

description: Environment variables that the user can set for a Micro


description: Enable the use of API keys to access private routes of a Micro


description: Environment variable


description: Name of the environment variable


key: description

description: Human readable description


key: default

description: Default value of the environment variable


key: action

description: Action configuration

default: schedule

required: id name trigger default_interval


key: id

description: Unique identifier for the action (needs to be unique across the app)


key: name

description: Human readable name for the action (needs to be unique across the app)


description: Human readable description for the action


key: trigger

description: Trigger for the action


description: Interval at which the schedule will run


description: Path of the Micro that will handle the action request


description: The bounded context configuration

required: readModels eventStore

required: application boundedContext boundedContextName core interaction resources

enum: react aurelia

required: type language entryPoint

required: production development


key: application

description: The application id that represents the application that this bounded context is a part of


key: boundedContext

description: The bounded context id that represents this bounded context


key: boundedContextName

description: The bounded context name that represents the name of this bounded context


key: interaction

description: A list of configurations for the interaction layers that this bounded context exposes


key: resources

description: A map of describing the resource type implementation mapping of resource types


key: coreConfiguration

description: A configuration describing the Core of this bounded context


key: language

description: Describes which programming language the Core is written in


key: entryPoint

description: The entry point of the bounded context's Core.  A relative path to the folder


key: interactionLayerConfiguration

description: The configuration of an interaction layer


key: type

description: The type of the interaction layer


description: The programming language of the interaction layer


description: The entry point of the interaction layer. A relative path to the folder


key: framework

description: The framework of the interaction layer


key: resourceTypeImplementationConfiguration

description: Resource type implementation configuration


key: repo

description:
A list of local hooks
https://pre-commit.com/#2-add-a-pre-commit-configuration

default: local


description:
A repository url
https://pre-commit.com/#2-add-a-pre-commit-configuration


key: rev

description:
A revision or tag to clone at
https://pre-commit.com/#2-add-a-pre-commit-configuration


key: hooks

description:
A list of hook mappings
https://pre-commit.com/#pre-commit-configyaml---hooks.


key: id

description:
An identifier of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks


key: alias

description:
An additional identifier of the current hook for `pre-commit run <hookid>`
https://pre-commit.com/#pre-commit-configyaml---hooks


key: name

description:
A name of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks


description:
A language version of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks


key: files

description:
A pattern to include files to run on of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks


key: exclude

description:
A pattern to exclude files from `files` to run on of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks


key: types

description:
A list of file types to run on combined via logical `and` of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks


A list of file types to run on combined via logical `or` of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks


A list of file types to exclude of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks


key: args

description:
List of additional parameters to pass to the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks


key: stages

description:
A stage of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks


description:
A list of additional_dependencies of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks


description:
Run the current hook when no files matched
https://pre-commit.com/#pre-commit-configyaml---hooks


key: verbose

description:
Display an output of the current hook even it passes
https://pre-commit.com/#pre-commit-configyaml---hooks


key: entry

description:
A command of the current hook
https://pre-commit.com/#pre-commit-configyaml---hooks


description: A log file of the current hook


key: language

description:
A language the current hook is written in
https://pre-commit.com/#pre-commit-configyaml---hooks


description:
Whether to pass filenames to the current hook or not
https://pre-commit.com/#pre-commit-configyaml---hooks


key: ci

description:
pre-commit.ci specific settings
https://pre-commit.ci/#configuration

default:
[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

default: [pre-commit.ci] pre-commit autoupdate

default: weekly

enum: weekly monthly quarterly


description:
A commit message for pull request autofixes
https://pre-commit.ci/#configuration


description:
Whether to autofix pull requests
https://pre-commit.ci/#configuration


description:
A branch to send pull request's autoupdate to
https://pre-commit.ci/#configuration


description:
A commit message for autoupdate pull requests
https://pre-commit.ci/#configuration


description:
An autoupdate frequency
https://pre-commit.ci/#configuration


key: skip

description:
List of skipped hook's ids
https://pre-commit.ci/#configuration


key: submodules

description:
Whether to recursively check out submodules
https://pre-commit.ci/#configuration


key: repos

description:
Repository mappings of the current project
https://pre-commit.com/#pre-commit-configyaml---top-level


description:
Mappings for the default language versions of the current project
https://pre-commit.com/#pre-commit-configyaml---top-level


The default stages of the current project
https://pre-commit.com/#pre-commit-configyaml---top-level


description:
A file include pattern of the current project
https://pre-commit.com/#pre-commit-configyaml---top-level


description:
A file exclude pattern of the current project
https://pre-commit.com/#pre-commit-configyaml---top-level


description:
Whether stop running hooks after a first failure
https://pre-commit.com/#pre-commit-configyaml---top-level


description:
A minimum version of pre-commit
https://pre-commit.com/#pre-commit-configyaml---top-level


key: Skip

description: Skip all or specific commands and scripts


key: Only

description: Force the command, script, or hook to execute only in certain conditions. This acts like the opposite of skip.


key: Tags

description: Specify tags for commands and scripts, useful for excluding


key: Env

description: Specify environment variables for the command or script.


key: FailText

description: Text to show when the command or script fails.


key: StageFixed

description: Only for the 'pre-commit' hooks, this automatically calls 'git add' after running the command or script.


key: Interactive

description: Whether to use interactive mode and provide a STDIN for a command or script.


key: files

description: A custom git command for files to be referenced in {files} template.


key: parallel

description: Whether run commands and scripts concurrently.


key: piped

description: Whether run commands and scripts sequentially. Will stop execution if one of the commands/scripts fail.


key: follow

description: Follow the STDOUT of the running commands and scripts.


description: Tags or command names that you want to exclude.


key: commands

description: Commands to be executed for the hook.


key: scripts

description: Scripts to be executed for the hook.


key: run

description: The command that is executed for the hook


key: glob

description: Set a glob to filter files for your command.


description: Custom Git commit for files to be referenced in {files} template for the 'run' setting.


key: root

description: Change the CWD for the command you execute.


key: exclude

description: Provide a regular expression to exclude some files from being passed to the 'run' command.


key: colors

description: Whether enable or disable colorful output of Lefthook.


description: Whether hide spinner and other interactive things.


key: extends

description: Specify files to extend config with.


description: Specify a minimum version for the lefthook binary.


description: Manage verbosity by skipping the printing of output of some steps.

enum: meta success failure summary execution execution_out execution_info skips


description: Change a directory for script files. Directory for script files contains folders with git hook names which contain script files.

default: .lefthook/


description: Change a directory for local script files (not stored in VCS).

default: .lefthook-local/


key: rc

description: Provide an rc file, which is actually a simple sh script


key: remote

description: Remote configs enable sharing of lefthook configuration across many projects.


description: A URL to Git repository. It will be accessed with priveleges of the machine lefthook runs on.


key: ref

description: An optional branch or tag name.


key: config

description: An optional config path from remote's root.


description: Define personal data schema in code using Transcend.

required: title output-identifiers

required: name value

required: name type

enum: MULTI_SELECT SINGLE_SELECT TEXT EMAIL TELEPHONE URL ASSESSMENT

enum: actionItem dataSilo subDataPoint airgapCookie airgapDataFlow request vendor businessEntity dataSubCategory processingPurposeSubCategory

enum: EU AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BA BW BV BR IO VG BN BG BF BI KH CM CA CV BQ KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CW CY CZ DK DJ DM DO EC EG SV GQ ER EE SZ ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GG GN GW GY HT HM HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JE JO KZ KE KI KW KG LA LV LB LS LR LY LI LT LU MO MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL NC NZ NI NE NG NU NF KP MK MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW WS SM ST SA SN RS SC SL SG SX SK SI SB SO ZA GS KR SS ES LK BL SH KN LC MF PM VC SD SR SJ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UM VI UG UA AE GB US UY UZ VU VA VE VN WF EH YE ZM ZW

required: key values

enum: DISABLED AUTO FORM

enum: ESSENTIAL ADDITIONAL_FUNCTIONALITY ADVERTISING MARKETING ANALYTICS PERSONALIZATION OPERATION_SECURITY LEGAL TRANSFER SALE HR OTHER UNSPECIFIED

enum: FINANCIAL HEALTH CONTACT LOCATION DEMOGRAPHIC ID ONLINE_ACTIVITY USER_PROFILE SOCIAL_MEDIA CONNECTION TRACKING DEVICE SURVEY OTHER UNSPECIFIED NOT_PERSONAL_DATA

enum: QuickOptions QuickOptions3 AcceptAll AcceptAllRejectAllToggle AcceptAllOrMoreChoices AcceptOrRejectAll AcceptOrRejectAllOrMoreChoices AcceptOrRejectAnalytics AcceptOrRejectAdvertising NoticeAndDoNotSell DoNotSellExplainer PrivacyPolicyNotice CompleteOptions CompleteOptionsInverted Hidden

enum: om ab aa af sq am ar-DZ ar-BH ar-EG ar-IQ ar-JO ar-KW ar-LB ar-LY ar-MA ar-OM ar-QA ar-SA ar-SY ar-TN ar-AE ar-YE ar hy as ay az ba eu be bn dz bh bi br bg-BG bg my km ca zh-CN zh-HK zh-MO zh-SG zh-TW zh co hr-HR hr cs-CZ cs da-DK da div nl-BE nl-NL nl en-AU en-BZ en-CA en-IE en-JM en-NZ en-PH en-ZA en-CH en-TT en-GB en-US en-ZW us eo et et-EE fo fa fj fi-FI fi fr-BE fr-CA fr-FR fr-LU fr-MC fr-CH fr fy mk gd gl ka de-AT de-DE de-LI de-LU de-CH de el-GR el kl gn gu ha iw hi hu-HU hu is is-IS in ia ie ik ga ga-IE it-IT it-CH it ja jw kn ks kk rw ky rn kok ko ku kz lo la lv lv-LV ln lt-LT lt mg ms ml mt mt-MT mi mr mo mn na ne no nb nn no-NO nb-NO nn-NO oc or ps pl-PL pl pt-BR pt-PT pt-CH pt pa qu rm ro-MD ro-RO ro ru-MD ru sm sg sa sr sh st sn sd si ss sk sk-SK sl sl-SI so sb es-AR es-BO es-CL es-CO es-CR es-DO es-EC es-SV es-ES es-GT es-HN es-MX es-NI es-PA es-PY es-PE es-PR es-US es-UY es-VE es su sx sw sv-FI sv-SE sv gsw gsw-LI gsw-CH syr tl tg ta tt te th bo ti to ts tn tr tk tw uk ur uz vi vo cy wo xh yi yo zu

enum: Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville Africa/Bujumbura Africa/Cairo Africa/Casablanca Africa/Ceuta Africa/Conakry Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Douala Africa/El_Aaiun Africa/Freetown Africa/Gaborone Africa/Harare Africa/Johannesburg Africa/Juba Africa/Kampala Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Libreville Africa/Lome Africa/Luanda Africa/Lubumbashi Africa/Lusaka Africa/Malabo Africa/Maputo Africa/Maseru Africa/Mbabane Africa/Mogadishu Africa/Monrovia Africa/Nairobi Africa/Ndjamena Africa/Niamey Africa/Nouakchott Africa/Ouagadougou Africa/Porto-Novo Africa/Sao_Tome Africa/Tripoli Africa/Tunis Africa/Windhoek America/Adak America/Anchorage America/Anguilla America/Antigua America/Araguaina America/Argentina/La_Rioja America/Argentina/Rio_Gallegos America/Argentina/Salta America/Argentina/San_Juan America/Argentina/San_Luis America/Argentina/Tucuman America/Argentina/Ushuaia America/Aruba America/Asuncion America/Bahia America/Bahia_Banderas America/Barbados America/Belem America/Belize America/Blanc-Sablon America/Boa_Vista America/Bogota America/Boise America/Buenos_Aires America/Cambridge_Bay America/Campo_Grande America/Cancun America/Caracas America/Catamarca America/Cayenne America/Cayman America/Chicago America/Chihuahua America/Coral_Harbour America/Cordoba America/Costa_Rica America/Creston America/Cuiaba America/Curacao America/Danmarkshavn America/Dawson America/Dawson_Creek America/Denver America/Detroit America/Dominica America/Edmonton America/Eirunepe America/El_Salvador America/Fort_Nelson America/Fortaleza America/Glace_Bay America/Godthab America/Goose_Bay America/Grand_Turk America/Grenada America/Guadeloupe America/Guatemala America/Guayaquil America/Guyana America/Halifax America/Havana America/Hermosillo America/Indiana/Knox America/Indiana/Marengo America/Indiana/Petersburg America/Indiana/Tell_City America/Indiana/Vevay America/Indiana/Vincennes America/Indiana/Winamac America/Indianapolis America/Inuvik America/Iqaluit America/Jamaica America/Jujuy America/Juneau America/Kentucky/Monticello America/Kralendijk America/La_Paz America/Lima America/Los_Angeles America/Louisville America/Lower_Princes America/Maceio America/Managua America/Manaus America/Marigot America/Martinique America/Matamoros America/Mazatlan America/Mendoza America/Menominee America/Merida America/Metlakatla America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montreal America/Montserrat America/Nassau America/New_York America/Nipigon America/Nome America/Noronha America/North_Dakota/Beulah America/North_Dakota/Center America/North_Dakota/New_Salem America/Ojinaga America/Panama America/Pangnirtung America/Paramaribo America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Porto_Velho America/Puerto_Rico America/Punta_Arenas America/Rainy_River America/Rankin_Inlet America/Recife America/Regina America/Resolute America/Rio_Branco America/Santa_Isabel America/Santarem America/Santiago America/Santo_Domingo America/Sao_Paulo America/Scoresbysund America/Sitka America/St_Barthelemy America/St_Johns America/St_Kitts America/St_Lucia America/St_Thomas America/St_Vincent America/Swift_Current America/Tegucigalpa America/Thule America/Thunder_Bay America/Tijuana America/Toronto America/Tortola America/Vancouver America/Whitehorse America/Winnipeg America/Yakutat America/Yellowknife Antarctica/Casey Antarctica/Davis Antarctica/DumontDUrville Antarctica/Macquarie Antarctica/Mawson Antarctica/McMurdo Antarctica/Palmer Antarctica/Rothera Antarctica/Syowa Antarctica/Troll Antarctica/Vostok Arctic/Longyearbyen Asia/Aden Asia/Almaty Asia/Amman Asia/Anadyr Asia/Aqtau Asia/Aqtobe Asia/Ashgabat Asia/Atyrau Asia/Baghdad Asia/Bahrain Asia/Baku Asia/Bangkok Asia/Barnaul Asia/Beirut Asia/Bishkek Asia/Brunei Asia/Calcutta Asia/Chita Asia/Choibalsan Asia/Colombo Asia/Damascus Asia/Dhaka Asia/Dili Asia/Dubai Asia/Dushanbe Asia/Famagusta Asia/Gaza Asia/Hebron Asia/Hong_Kong Asia/Hovd Asia/Irkutsk Asia/Jakarta Asia/Jayapura Asia/Jerusalem Asia/Kabul Asia/Kamchatka Asia/Karachi Asia/Katmandu Asia/Khandyga Asia/Krasnoyarsk Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macau Asia/Magadan Asia/Makassar Asia/Manila Asia/Muscat Asia/Nicosia Asia/Novokuznetsk Asia/Novosibirsk Asia/Omsk Asia/Oral Asia/Phnom_Penh Asia/Pontianak Asia/Pyongyang Asia/Qatar Asia/Qostanay Asia/Qyzylorda Asia/Rangoon Asia/Riyadh Asia/Saigon Asia/Sakhalin Asia/Samarkand Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Srednekolymsk Asia/Taipei Asia/Tashkent Asia/Tbilisi Asia/Tehran Asia/Thimphu Asia/Tokyo Asia/Tomsk Asia/Ulaanbaatar Asia/Urumqi Asia/Ust-Nera Asia/Vientiane Asia/Vladivostok Asia/Yakutsk Asia/Yekaterinburg Asia/Yerevan Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe Atlantic/Madeira Atlantic/Reykjavik Atlantic/South_Georgia Atlantic/St_Helena Atlantic/Stanley Australia/Adelaide Australia/Brisbane Australia/Broken_Hill Australia/Currie Australia/Darwin Australia/Eucla Australia/Hobart Australia/Lindeman Australia/Lord_Howe Australia/Melbourne Australia/Perth Australia/Sydney Europe/Amsterdam Europe/Andorra Europe/Astrakhan Europe/Athens Europe/Belgrade Europe/Berlin Europe/Bratislava Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Busingen Europe/Chisinau Europe/Copenhagen Europe/Dublin Europe/Gibraltar Europe/Guernsey Europe/Helsinki Europe/Isle_of_Man Europe/Istanbul Europe/Jersey Europe/Kaliningrad Europe/Kiev Europe/Kirov Europe/Lisbon Europe/Ljubljana Europe/London Europe/Luxembourg Europe/Madrid Europe/Malta Europe/Mariehamn Europe/Minsk Europe/Monaco Europe/Moscow Europe/Oslo Europe/Paris Europe/Podgorica Europe/Prague Europe/Riga Europe/Rome Europe/Samara Europe/San_Marino Europe/Sarajevo Europe/Saratov Europe/Simferopol Europe/Skopje Europe/Sofia Europe/Stockholm Europe/Tallinn Europe/Tirane Europe/Ulyanovsk Europe/Uzhgorod Europe/Vaduz Europe/Vatican Europe/Vienna Europe/Vilnius Europe/Volgograd Europe/Warsaw Europe/Zagreb Europe/Zaporozhye Europe/Zurich Indian/Antananarivo Indian/Chagos Indian/Christmas Indian/Cocos Indian/Comoro Indian/Kerguelen Indian/Mahe Indian/Maldives Indian/Mauritius Indian/Mayotte Indian/Reunion Pacific/Apia Pacific/Auckland Pacific/Bougainville Pacific/Chatham Pacific/Easter Pacific/Efate Pacific/Enderbury Pacific/Fakaofo Pacific/Fiji Pacific/Funafuti Pacific/Galapagos Pacific/Gambier Pacific/Guadalcanal Pacific/Guam Pacific/Honolulu Pacific/Johnston Pacific/Kiritimati Pacific/Kosrae Pacific/Kwajalein Pacific/Majuro Pacific/Marquesas Pacific/Midway Pacific/Nauru Pacific/Niue Pacific/Norfolk Pacific/Noumea Pacific/Pago_Pago Pacific/Palau Pacific/Pitcairn Pacific/Ponape Pacific/Port_Moresby Pacific/Rarotonga Pacific/Saipan Pacific/Tahiti Pacific/Tarawa Pacific/Tongatapu Pacific/Truk Pacific/Wake Pacific/Wallis