description: POWERSHELL_POWERSHELL: User custom arguments to add in linter CLI call


description: POWERSHELL_POWERSHELL: User custom arguments to remove before calling linter

examples: --foo bar

type: string

type: array string


description: POWERSHELL_POWERSHELL: User custom config file name if different from default


description: POWERSHELL_POWERSHELL_FORMATTER: User custom arguments to add in linter CLI call


description: POWERSHELL_POWERSHELL_FORMATTER: User custom arguments to remove before calling linter


description: POWERSHELL_POWERSHELL_FORMATTER: User custom config file name if different from default


description: POWERSHELL_POWERSHELL_FORMATTER: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling POWERSHELL_POWERSHELL_FORMATTER and its pre/post commands

type: array


description: POWERSHELL_POWERSHELL: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling POWERSHELL_POWERSHELL and its pre/post commands


description: Custom bash commands to run before linters

command: npm install java-caller

cwd: root

command: echo "pre-run command has been called"

cwd: workspace


description: If set to false, only fixed and error files are displayed in logs

type: boolean


description: Enable printing alpaca image to console output


description: PROTOBUF_PROTOLINT: User custom arguments to add in linter CLI call


description: PROTOBUF_PROTOLINT: User custom arguments to remove before calling linter


description: PROTOBUF_PROTOLINT: User custom config file name if different from default


description: PROTOBUF_PROTOLINT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling PROTOBUF_PROTOLINT and its pre/post commands


description: PUPPET_PUPPET_LINT: User custom arguments to add in linter CLI call


description: PUPPET_PUPPET_LINT: User custom arguments to remove before calling linter


description: PUPPET_PUPPET_LINT: User custom config file name if different from default


description: PUPPET_PUPPET_LINT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling PUPPET_PUPPET_LINT and its pre/post commands


description: PYTHON_BANDIT: User custom arguments to add in linter CLI call


description: PYTHON_BANDIT: User custom arguments to remove before calling linter


description: PYTHON_BANDIT: User custom config file name if different from default


description: PYTHON_BANDIT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling PYTHON_BANDIT and its pre/post commands


description: PYTHON_BLACK: User custom arguments to add in linter CLI call


description: PYTHON_BLACK: User custom arguments to remove before calling linter


description: PYTHON_BLACK: User custom config file name if different from default


default: .python-black


description: PYTHON_BLACK: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling PYTHON_BLACK and its pre/post commands


description: PYTHON_FLAKE8: User custom arguments to add in linter CLI call


description: PYTHON_FLAKE8: User custom arguments to remove before calling linter


description: PYTHON_FLAKE8: User custom config file name if different from default


description: PYTHON_FLAKE8: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling PYTHON_FLAKE8 and its pre/post commands


description: PYTHON_ISORT: User custom arguments to add in linter CLI call


description: PYTHON_ISORT: User custom arguments to remove before calling linter


description: PYTHON_ISORT: User custom config file name if different from default


description: PYTHON_ISORT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling PYTHON_ISORT and its pre/post commands


description: PYTHON_MYPY: User custom arguments to add in linter CLI call


description: PYTHON_MYPY: User custom arguments to remove before calling linter


description: PYTHON_MYPY: User custom config file name if different from default


description: PYTHON_MYPY: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling PYTHON_MYPY and its pre/post commands


description: PYTHON_PYLINT: User custom arguments to add in linter CLI call


description: PYTHON_PYLINT: User custom arguments to remove before calling linter


description: PYTHON_PYLINT: User custom config file name if different from default

default: .pylintrc


default: .python-lint


description: PYTHON_PYLINT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling PYTHON_PYLINT and its pre/post commands


description: PYTHON_PYRIGHT: User custom arguments to add in linter CLI call


description: PYTHON_PYRIGHT: User custom arguments to remove before calling linter


description: PYTHON_PYRIGHT: User custom config file name if different from default


description: PYTHON_PYRIGHT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling PYTHON_PYRIGHT and its pre/post commands


description: PYTHON_RUFF: User custom arguments to add in linter CLI call


description: PYTHON_RUFF: User custom arguments to remove before calling linter


description: PYTHON_RUFF: User custom config file name if different from default


description: PYTHON_RUFF: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling PYTHON_RUFF and its pre/post commands


description: RAKU_RAKU: User custom arguments to add in linter CLI call


description: RAKU_RAKU: User custom arguments to remove before calling linter


description: RAKU_RAKU: User custom config file name if different from default


description: RAKU_RAKU: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling RAKU_RAKU and its pre/post commands


description: Define simple if you do not to have external images in PR/MR comments

default: advanced

enum: simple advanced


description: The location where the output reporting will be generated to

default: report


description: REPOSITORY_CHECKOV: User custom arguments to add in linter CLI call


description: REPOSITORY_CHECKOV: User custom arguments to remove before calling linter


description: REPOSITORY_CHECKOV: User custom config file name if different from default


description: REPOSITORY_CHECKOV: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling REPOSITORY_CHECKOV and its pre/post commands


description: REPOSITORY_DEVSKIM: User custom arguments to add in linter CLI call


description: REPOSITORY_DEVSKIM: User custom arguments to remove before calling linter


description: List of env variables explicitly not filtered before calling REPOSITORY_DEVSKIM and its pre/post commands


description: REPOSITORY_DUSTILOCK: User custom arguments to add in linter CLI call


description: REPOSITORY_DUSTILOCK: User custom arguments to remove before calling linter


description: List of env variables explicitly not filtered before calling REPOSITORY_DUSTILOCK and its pre/post commands


description: REPOSITORY_GITLEAKS: User custom arguments to add in linter CLI call


description: REPOSITORY_GITLEAKS: User custom arguments to remove before calling linter


description: REPOSITORY_GITLEAKS: User custom config file name if different from default


description: REPOSITORY_GITLEAKS: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling REPOSITORY_GITLEAKS and its pre/post commands


description: REPOSITORY_GIT_DIFF: User custom arguments to add in linter CLI call


description: REPOSITORY_GIT_DIFF: User custom arguments to remove before calling linter


description: List of env variables explicitly not filtered before calling REPOSITORY_GIT_DIFF and its pre/post commands


description: REPOSITORY_GOODCHECK: User custom arguments to add in linter CLI call


description: REPOSITORY_GOODCHECK: User custom config file name if different from default


description: REPOSITORY_GOODCHECK: Path where to find linter configuration file


description: REPOSITORY_GRYPE: User custom arguments to add in linter CLI call


description: REPOSITORY_GRYPE: User custom arguments to remove before calling linter


description: REPOSITORY_GRYPE: User custom config file name if different from default


description: REPOSITORY_GRYPE: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling REPOSITORY_GRYPE and its pre/post commands


description: REPOSITORY_KICS: User custom arguments to add in linter CLI call


description: REPOSITORY_KICS: User custom arguments to remove before calling linter


description: REPOSITORY_KICS: User custom config file name if different from default


description: REPOSITORY_KICS: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling REPOSITORY_KICS and its pre/post commands


description: REPOSITORY_SECRETLINT: User custom arguments to add in linter CLI call


description: REPOSITORY_SECRETLINT: User custom arguments to remove before calling linter


description: REPOSITORY_SECRETLINT: User custom config file name if different from default


description: REPOSITORY_SECRETLINT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling REPOSITORY_SECRETLINT and its pre/post commands


description: REPOSITORY_SEMGREP: User custom arguments to add in linter CLI call


description: REPOSITORY_SEMGREP: User custom arguments to remove before calling linter


description: List of env variables explicitly not filtered before calling REPOSITORY_SEMGREP and its pre/post commands


description: REPOSITORY_SYFT: User custom arguments to add in linter CLI call


description: REPOSITORY_SYFT: User custom arguments to remove before calling linter


description: REPOSITORY_SYFT: User custom config file name if different from default


description: REPOSITORY_SYFT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling REPOSITORY_SYFT and its pre/post commands


description: REPOSITORY_TRIVY: User custom arguments to add in linter CLI call


description: REPOSITORY_TRIVY: User custom arguments to remove before calling linter


description: REPOSITORY_TRIVY: User custom config file name if different from default


description: REPOSITORY_TRIVY: Path where to find linter configuration file


description: REPOSITORY_TRIVY_SBOM: User custom arguments to add in linter CLI call


description: REPOSITORY_TRIVY_SBOM: User custom arguments to remove before calling linter


description: REPOSITORY_TRIVY_SBOM: User custom config file name if different from default


description: REPOSITORY_TRIVY_SBOM: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling REPOSITORY_TRIVY_SBOM and its pre/post commands


description: List of env variables explicitly not filtered before calling REPOSITORY_TRIVY and its pre/post commands


description: REPOSITORY_TRUFFLEHOG: User custom arguments to add in linter CLI call


description: REPOSITORY_TRUFFLEHOG: User custom arguments to remove before calling linter


description: REPOSITORY_TRUFFLEHOG: User custom config file name if different from default


description: REPOSITORY_TRUFFLEHOG: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling REPOSITORY_TRUFFLEHOG and its pre/post commands


description: RST_RSTCHECK: User custom arguments to add in linter CLI call


description: RST_RSTCHECK: User custom arguments to remove before calling linter


description: RST_RSTCHECK: User custom config file name if different from default


description: RST_RSTCHECK: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling RST_RSTCHECK and its pre/post commands


description: RST_RSTFMT: User custom arguments to add in linter CLI call


description: RST_RSTFMT: User custom arguments to remove before calling linter


description: List of env variables explicitly not filtered before calling RST_RSTFMT and its pre/post commands


description: RST_RST_LINT: User custom arguments to add in linter CLI call


description: RST_RST_LINT: User custom arguments to remove before calling linter


description: List of env variables explicitly not filtered before calling RST_RST_LINT and its pre/post commands


description: RUBY_RUBOCOP: User custom arguments to add in linter CLI call


description: RUBY_RUBOCOP: User custom arguments to remove before calling linter


description: RUBY_RUBOCOP: User custom config file name if different from default


description: RUBY_RUBOCOP: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling RUBY_RUBOCOP and its pre/post commands


description: RUST_CLIPPY: User custom arguments to add in linter CLI call


description: RUST_CLIPPY: User custom arguments to remove before calling linter


description: RUST_CLIPPY: User custom config file name if different from default


description: RUST_CLIPPY: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling RUST_CLIPPY and its pre/post commands


description: R_LINTR: User custom arguments to add in linter CLI call


description: R_LINTR: User custom arguments to remove before calling linter


description: R_LINTR: User custom config file name if different from default

default: .lintr


description: R_LINTR: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling R_LINTR and its pre/post commands


description: SALESFORCE_SFDX_SCANNER_APEX: User custom arguments to add in linter CLI call


description: SALESFORCE_SFDX_SCANNER_APEX: User custom arguments to remove before calling linter


description: SALESFORCE_SFDX_SCANNER_APEX: User custom config file name if different from default


description: SALESFORCE_SFDX_SCANNER_APEX: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling SALESFORCE_SFDX_SCANNER_APEX and its pre/post commands


description: SALESFORCE_SFDX_SCANNER: User custom arguments to add in linter CLI call


description: SALESFORCE_SFDX_SCANNER_AURA: User custom arguments to add in linter CLI call


description: SALESFORCE_SFDX_SCANNER_AURA: User custom arguments to remove before calling linter


description: SALESFORCE_SFDX_SCANNER_AURA: User custom config file name if different from default

default: --eslintconfig


description: SALESFORCE_SFDX_SCANNER_AURA: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling SALESFORCE_SFDX_SCANNER_AURA and its pre/post commands


description: SALESFORCE_SFDX_SCANNER_LWC: User custom arguments to add in linter CLI call


description: SALESFORCE_SFDX_SCANNER_LWC: User custom arguments to remove before calling linter


description: SALESFORCE_SFDX_SCANNER_LWC: User custom config file name if different from default


description: SALESFORCE_SFDX_SCANNER_LWC: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling SALESFORCE_SFDX_SCANNER_LWC and its pre/post commands


description: Generate SARIF reports that can be used to display issues directly in GitHub UI


description: Override SARIF output file name


description: If SARIF_REPORTER_LINTERS is set, only the linters in the list will output SARIF


description: SCALA_SCALAFIX: User custom arguments to add in linter CLI call


description: SCALA_SCALAFIX: User custom arguments to remove before calling linter


description: SCALA_SCALAFIX: User custom config file name if different from default


description: SCALA_SCALAFIX: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling SCALA_SCALAFIX and its pre/post commands


description: List of secured environment variables to hide when calling linters


description: Displays elapsed time for each linter in reports


description: Displays all linters that mega-linter could run but didn't


description: Comma-separated list of cli_lint_modes. To use if you want to skip linters with some CLI lint modes (ex: "file,project"). Available values: file,cli_lint_mode,project

examples: file project

enum: file list_of_files project


description: SNAKEMAKE_LINT: User custom arguments to add in linter CLI call


description: SNAKEMAKE_LINT: User custom arguments to remove before calling linter


description: List of env variables explicitly not filtered before calling SNAKEMAKE_LINT and its pre/post commands


description: SNAKEMAKE_SNAKEFMT: User custom arguments to add in linter CLI call


description: SNAKEMAKE_SNAKEFMT: User custom arguments to remove before calling linter


description: SNAKEMAKE_SNAKEFMT: User custom config file name if different from default


description: SNAKEMAKE_SNAKEFMT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling SNAKEMAKE_SNAKEFMT and its pre/post commands


description: If set to true, MegaLinter will also send file names to cspell for analysis.


description: SPELL_CSPELL: User custom arguments to add in linter CLI call


description: SPELL_CSPELL: User custom arguments to remove before calling linter


description: SPELL_CSPELL: User custom config file name if different from default


description: SPELL_CSPELL: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling SPELL_CSPELL and its pre/post commands


description: SPELL_LYCHEE: User custom arguments to add in linter CLI call


description: SPELL_LYCHEE: User custom arguments to remove before calling linter


description: SPELL_LYCHEE: User custom config file name if different from default


description: SPELL_LYCHEE: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling SPELL_LYCHEE and its pre/post commands


description: SPELL_MISSPELL: User custom arguments to add in linter CLI call


description: SPELL_PROSELINT: User custom arguments to add in linter CLI call


description: SPELL_PROSELINT: User custom arguments to remove before calling linter


description: SPELL_PROSELINT: User custom config file name if different from default

default: .proselintrc


description: SPELL_PROSELINT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling SPELL_PROSELINT and its pre/post commands


description: SPELL_VALE: User custom arguments to add in linter CLI call


description: SPELL_VALE: User custom arguments to remove before calling linter


description: SPELL_VALE: User custom config file name if different from default


description: SPELL_VALE: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling SPELL_VALE and its pre/post commands


description: SQL_SQLFLUFF: User custom arguments to add in linter CLI call


description: SQL_SQLFLUFF: User custom arguments to remove before calling linter


description: SQL_SQLFLUFF: User custom config file name if different from default

default: .sqlfluff


description: SQL_SQLFLUFF: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling SQL_SQLFLUFF and its pre/post commands


description: SQL_SQL_LINT: User custom arguments to add in linter CLI call


description: SQL_SQL_LINT: User custom arguments to remove before calling linter


description: SQL_SQL_LINT: User custom config file name if different from default


description: SQL_SQL_LINT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling SQL_SQL_LINT and its pre/post commands


description: SQL_TSQLLINT: User custom arguments to add in linter CLI call


description: SQL_TSQLLINT: User custom arguments to remove before calling linter


description: SQL_TSQLLINT: User custom config file name if different from default

default: .tsqllintrc


description: SQL_TSQLLINT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling SQL_TSQLLINT and its pre/post commands


description: SWIFT_SWIFTLINT: User custom arguments to add in linter CLI call


description: SWIFT_SWIFTLINT: User custom arguments to remove before calling linter


description: SWIFT_SWIFTLINT: User custom config file name if different from default


description: SWIFT_SWIFTLINT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling SWIFT_SWIFTLINT and its pre/post commands


description: General execution log mega-linter.log (same as ConsoleReporter log) + a separate log file for each processed linter


description: Sub-folder of reports folder containing TAP logs

default: tap


description: TEKTON_TEKTON_LINT: User custom arguments to add in linter CLI call


description: TEKTON_TEKTON_LINT: User custom arguments to remove before calling linter


description: TEKTON_TEKTON_LINT: User custom config file name if different from default


description: TEKTON_TEKTON_LINT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling TEKTON_TEKTON_LINT and its pre/post commands


description: TERRAFORM_CHECKOV: User custom arguments to add in linter CLI call


description: TERRAFORM_KICS: User custom arguments to add in linter CLI call


description: TERRAFORM_TERRAFORM_FMT: User custom arguments to add in linter CLI call


description: TERRAFORM_TERRAFORM_FMT: User custom arguments to remove before calling linter


description: List of env variables explicitly not filtered before calling TERRAFORM_TERRAFORM_FMT and its pre/post commands


description: TERRAFORM_TERRAGRUNT: User custom arguments to add in linter CLI call


description: TERRAFORM_TERRAGRUNT: User custom arguments to remove before calling linter


description: TERRAFORM_TERRAGRUNT: User custom config file name if different from default


description: TERRAFORM_TERRAGRUNT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling TERRAFORM_TERRAGRUNT and its pre/post commands


description: TERRAFORM_TERRASCAN: User custom arguments to add in linter CLI call


description: TERRAFORM_TERRASCAN: User custom arguments to remove before calling linter


description: TERRAFORM_TERRASCAN: User custom config file name if different from default


description: TERRAFORM_TERRASCAN: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling TERRAFORM_TERRASCAN and its pre/post commands


description: TERRAFORM_TFLINT: User custom arguments to add in linter CLI call


description: TERRAFORM_TFLINT: User custom arguments to remove before calling linter


description: TERRAFORM_TFLINT: User custom config file name if different from default


description: TERRAFORM_TFLINT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling TERRAFORM_TFLINT and its pre/post commands


description: General execution log mega-linter.log (same as ConsoleReporter log) + a separate log file for each processed linter


description: Sub-folder of reports folder containing text logs


description: TSX_ESLINT: User custom arguments to add in linter CLI call


description: TSX_ESLINT: User custom arguments to remove before calling linter


description: TSX_ESLINT: User custom config file name if different from default


description: TSX_ESLINT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling TSX_ESLINT and its pre/post commands


description: Style of typescript formatting to apply

enum: standard prettier

examples: standard prettier


description: TYPESCRIPT_ES: User custom arguments to add in linter CLI call


description: TYPESCRIPT_ES: User custom arguments to remove before calling linter


description: TYPESCRIPT_ES: User custom config file name if different from default


description: TYPESCRIPT_ES: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling TYPESCRIPT_ES and its pre/post commands


description: TYPESCRIPT_PRETTIER: User custom arguments to add in linter CLI call


description: TYPESCRIPT_PRETTIER: User custom arguments to remove before calling linter


description: TYPESCRIPT_PRETTIER: User custom config file name if different from default


description: TYPESCRIPT_PRETTIER: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling TYPESCRIPT_PRETTIER and its pre/post commands


description: TYPESCRIPT_STANDARD: User custom arguments to add in linter CLI call


description: TYPESCRIPT_STANDARD: User custom arguments to remove before calling linter


description: List of env variables explicitly not filtered before calling TYPESCRIPT_STANDARD and its pre/post commands


description: Will parse the entire repository and find all files to validate across all types. When set to false, only new or edited files will be parsed for validation.


description: VBDOTNET_DOTNET_FORMAT: User custom arguments to add in linter CLI call


description: VBDOTNET_DOTNET_FORMAT: User custom arguments to remove before calling linter


description: List of env variables explicitly not filtered before calling VBDOTNET_DOTNET_FORMAT and its pre/post commands


description: XML_XMLLINT: User custom arguments to add in linter CLI call


description: XML_XMLLINT: User custom arguments to remove before calling linter


description: List of env variables explicitly not filtered before calling XML_XMLLINT and its pre/post commands


description: YAML_PRETTIER: User custom arguments to add in linter CLI call


description: YAML_PRETTIER: User custom arguments to remove before calling linter


description: YAML_PRETTIER: User custom config file name if different from default


description: YAML_PRETTIER: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling YAML_PRETTIER and its pre/post commands


description: YAML_V8R: User custom arguments to add in linter CLI call


description: YAML_V8R: User custom arguments to remove before calling linter


description: YAML_V8R: User custom config file name if different from default


description: YAML_V8R: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling YAML_V8R and its pre/post commands


description: YAML_YAMLLINT: User custom arguments to add in linter CLI call


description: YAML_YAMLLINT: User custom arguments to remove before calling linter


description: YAML_YAMLLINT: User custom config file name if different from default


description: YAML_YAMLLINT: Path where to find linter configuration file


description: List of env variables explicitly not filtered before calling YAML_YAMLLINT and its pre/post commands


key: svgLoader

description:
Configures how SVG assets load.
Refer to https://help.codux.com/kb/en/article/kb17934 for more information.

default: asset


key: boardsPath

description:
Default directory for new boards, relative to the project root.
Refer to https://help.codux.com/kb/en/article/kb19337 for more information.


key: scripts

description:
Configures scripts for project users to run from Codux (triggerable and on demand).
Refer to https://help.codux.com/kb/en/article/kb30920 for more information.

type: object


key: conditionalClassnamesConfig

description:
Options for using the classNames utility library, including path to classNames module, and target export.
Refer to https://help.codux.com/kb/en/article/kb36122 for more information.


key: boardGlobalSetup

description:
Path to a file that will be evaluated before each board is rendered,
Useful for importing global stylesheets and initializing global variables.
Can be absolute or relative to the project root (in which case it needs to start with './')
Refer to https://help.codux.com/kb/en/article/kb36623 for more information.


key: httpServerPort

description: Port of HTTP server that is used to serve previews and user project itself.

type: number


key: fileNamingConvention

description:
Configures file-naming convention for new component creation.
Refer to https://help.codux.com/kb/en/article/kb29627 for more information.
Options: "pascal-case" | "camel-case" | "kebab-case"


key: serverProxyMap

description:
Configures proxy servers for Codux to redirect requests to.
The key is the path to proxy requests from, and the value is the url to proxy requests to.
Refer to https://help.codux.com/kb/en/article/kb18137 for more information.


key: styling

description:
Styling related configuration.
Contains field for styling solution which determines the main styling solution in the user's project.
Refer to https://help.codux.com/kb/en/article/kb31817 for more information.


key: solution

description:
Default file extension to use for component style sheets in the project.
Options: "css" | "sass" | "css modules" | "sass modules" | "scss" | "scss modules" | "stylable"


key: formatting

description:
Formats code styling in Codux code drawer.
Refer to https://help.codux.com/kb/en/article/kb21416 for more information.


key: AddPanelConfig

description:
Add Panel config.
Can contain list of libraries installed in the project which provide boards for Codux.


key: ConfiguredScript

description: The type of configured script users will define in the `codux.config.json`.


key: ScriptFromConfig

description: Scripts have a `commmand` but not an array of scripts to `run`.


key: command

description: This is the command that the script runs when executed.


key: title

description:
Script title in the UI.
Will be available to use from Codux.


key: description

description: Script description in the UI.


key: trigger

description:
Initiate Git commands in Codux before running the rest of the scripts.
The array of triggers may include "setup" for when the user opens the project for the first time,
"pull" for when branch commits sync, and "checkout" for when switching branches.


key: BatchFromConfig

description: Batches have a `run` array but not a `commmand`.


key: run

description: The value of this parameter is an array of script objects to include in the batch.


key: PreviewConfiguration

description:
Specifies environment variables to use globally across the project.
Refer to https://help.codux.com/kb/en/article/kb37722 for more information.


key: environmentVariables

description: variables that are being accessed from process.env


key: ICompilationConfig

description:
Enables CSS modules in your project.
Refer to https://help.codux.com/kb/en/article/kb25813 for more information.

required: activateCssModules cssModulesExt


key: activateCssModules

description: Enables or disables the use of CSS modules.


key: cssModulesExt

description: The extension types for files to load as modules.


key: PluggableSafeModeConfig

description:
Configures maximum rendered elements.
Refer to https://help.codux.com/kb/en/article/kb18414 for more information.


key: INewComponentConfig

description:
Configures default paths for new component and template files.
Refer to https://help.codux.com/kb/en/article/kb16522 for more information.


key: componentsPath

description: Path where new components and related files will save to.


key: templatesPath

description: Path where project templates are stored.


key: IgnoredSubPaths

description:
Specifies project folders to exclude from component search.
Refer to https://help.codux.com/kb/en/article/kb14730 for more information.


key: IResolveConfiguration

description:
Includes package assets from additional sources, and creates aliases and fallbacks.
Refer to https://help.codux.com/kb/en/article/kb18719 for more information.


key: alias

description:
Aliases for package requests.
Record key is the request to be mapped, value is the new target.
Alias is attempted before original request.


key: fallback

description:
Fallback for package requests.
Record key is the request to be mapped, value is the new target.
Original request is attempted before fallback.


key: packageRoots

description: Folders to use when searching for packages.


key: workspaceAlias

description:
Aliases for all package requests in a monorepo.
Record key is the request to be mapped, value is the new target.


key: SassCompilationProjectConfigEntry

description:
Adds Sass support to compilations.
Refer to https://help.codux.com/kb/en/article/kb19315 for more information.

required: modules resolveUrls


key: modules

description:
Defines path and module extensions for Sass modules to include and/or ignore.
Input as an array of glob patterns.


key: include

description: Array of glob patterns to include.


key: ignore

description: Array of glob patterns to ignore.


key: resolveUrls

description: Determines whether URLs in Sass files should resolve to absolute file paths before compiling them.


key: includePaths

description: Array of paths to resolve Sass files from.


key: IStyleFilesConfig

description: Style files config


key: commonStyleFilePattern

description: ext glob pattern of common style files that are used by other components. Defines common rules category.


key: ComponentsDiscoveryConfig

description:
Scopes component discovery in your project.
Refer to https://help.codux.com/kb/en/article/kb37113 for more information.


description: Array of glob patterns to include.


key: exclude

description: Array of glob patterns to exclude.


description: Defines an assembly in the Unity compilation pipeline

enum: Android Editor iOS LinuxStandalone32 LinuxStandalone64 LinuxStandaloneUniversal Lumin macOSStandalone Nintendo3DS PS4 PSVita Stadia Switch tvOS WSA WebGL WindowsStandalone32 WindowsStandalone64 XboxOne

default: false

required: name expression define


key: name

description: The name of the assembly being defined


key: rootNamespace

description: The root namespace of the assembly. Requires Unity 2020.2


key: references

description: A list of assembly names or assembly asset GUIDs to reference


key: includePlatforms

description: Platforms to target


key: excludePlatforms

description: Platforms that are explicitly not targeted


key: allowUnsafeCode

description: Allow unsafe code


key: autoReferenced

description: When true, this assembly definition is automatically referenced by predefined assemblies (Assembly-CSharp, Assembly-CSharp-firstpass, etc.)


key: noEngineReferences

description: When true, no references to UnityEngine or UnityEditor will be added to this assembly project


key: overrideReferences

description: When true, any references to precompiled assembly assets are manually chosen. When false, all precompiled assembly assets are automatically referenced


key: precompiledReferences

description: A list of precompiled assembly assets that will be referenced. Only valid when overrideReferences is true


key: defineConstraints

description: A list of the C# compiler define symbols that must evaluate to true in order for the assembly to be compiled or referenced. Absence of a symbol can be checked with a bang symbol (!DEFINE)


key: optionalUnityReferences

description: Additional optional Unity features to reference


key: versionDefines

description: A set of expressions that will define a symbol in the C# project if a package or module version matches the given expression


description: The package or module that will provide the version to be checked in the expression


key: expression

description: The semantic version range of the chosen package or module


key: define

description: The name of the define that is added to the project file when expression evaluates to true


description: What package manager to use

enum: javascript ruby:bundler php:composer python go:modules go:dep java:maven java:gradle dotnet:nuget rust:cargo elixir:hex docker terraform submodules elm github_actions


key: directory

description: Where to look for package manifests


description: How often to check for updates

enum: live daily weekly monthly


description: Branch to create pull requests against. By default your repository's default branch is used.


key: items

description: branchname


description: Reviewers to set on update pull requests.


description: reviewer github username


description: Assignees to set on update pull requests.


description: assignee github username


description: Labels to set on update pull requests. By default 'dependencies' is used.


description: Milestone to set on dependency update pull requests. Specified using the milestone number - you can find this in the URL when looking at details of a milestone in GitHub.

type: integer


description: Limit which updates are allowed.  By default all direct/top-level dependencies are kept up to date (indirect/sub-dependencies are only updated if they include security fixes).

examples: development production direct indirect all

enum: security all

default: security


description: matching on dependency name


description: only allow certain updates


description: which updates to do


description: By default no updates are ignored. The version_requirement specifies the versions to ignore. The range format is specific to the package manager (e.g., ^1.0.0 for JS, or ~> 2.0 for Ruby).


description: The version_requirement specifies the versions to ignore. The range format is specific to the package manager (e.g., ^1.0.0 for JS, or ~> 2.0 for Ruby).


description: Automerged updates must be enabled at the account level (from account settings in your dashboard) before they can be configured on a project. Specify which update pull requests should be merged automatically. By default no updates are automerged. For all of the options below Dependabot will wait until all your status checks pass before merging. You can also set working hours for automerging in your dashboard account settings.

enum: development production all

enum: security:patch semver:patch semver:minor in_range all


description: Specify how Dependabot should update your package manifest (e.g. package.json, Gemfile etc), as opposed to your lockfile. By default, version requirements are increased if it's an app and the range widened if it's a library.


description: Preferences for the format of Dependabot's commit messages and pull request titles. By default, Dependabot will attempt to detect your commit message preferences and use those.


key: tags

description: List of tags.


key: name

description:
The mandatory name of the node. If not present, node will be
skipped at runtime. It is used for example in debug log to help
you track things.


description: List of parsers to include in the collection.


description: List of scnearios to include in the collection.


key: author

description: The name of the author.


key: description

description: description of the parser usage


description: List of collections to include in the collection.


description: List of postoverflows to include in the collection.


description: (optional) AWS Profile can be specified here (but normally it's specified via AWS_PROFILE env var)


description: (required) AWS Region of this environment should be specified here. Can be overridden by AWS_PROFILE env var or --aws-region flag.


description: (optional) Path to ize.toml config file can be specified, but normally it's read from the environment's directory automatically.


key: env

description: (optional) Environment name can be specified here. Normally it should be passed via `ENV` variable or --env flag.


description: (optional) Environment directory can be specified here. Normally it's calculated automatically based on the directory structure convention.


key: home

description: (optional) User home directory can be specified here. Normally $HOME is used.


description: (optional) Ize directory can be specified here. Normally it's assumed to be .infra or .ize in the current repo.


description: (optional) Log level can be specified here. Possible levels: info, debug, trace, panic, warn, error, fatal(default). Can be overridden via IZE_LOG_LEVEL env var or via --log-level flag.


key: namespace

description: (required) Namespace of the project can be specified here. It is used as a base for all naming. It can be overridden by NAMESPACE env var or --namespace flag.


description: (optional) Plain text output can be enabled here. Default is false. Can be overridden by IZE_PLAIN_TEXT env var or --plain-text flag.


description: (optional) Prefer a specific runtime. (native or docker) (default 'native')


description: (optional) Path to apps directory can be set. By default apps are searched in 'apps' and 'projects' directories. This is needed in case your repo structure is not purely ize-structured (let's say you have 'src' repo in your dotnet app, as an example)


description: (optional) Project directory can be set here. By default it's the current directory, but in case you prefer to run ize from the outside of repo it may be useful (uncommon).


description: (optional) Terraform version can be set here. 1.1.3 by default


description: (optional) Docker registry can be set here. By default it uses ECR repo with the name of the service.


description: (optional) TF_LOG_PATH can be set here.


key: tag

description: (optional) Tag can be set statically. Normally it is being constructed automatically based on the git revision.


description: (optional) Terraform TF_LOG can be set here.  Can be TRACE, DEBUG, INFO, WARN or ERROR.


description: (optional) Custom prompt can be enabled here for all console connections. Default: false.


key: tunnel

description: Tunnel configuration.


description: Bastion instance ID.


description: Forward host.


key: app

description: Apps configuration.

deprecationMessage: app block is deprecated


key: ecs

description: Ecs apps configuration.


key: serverless

description: Serverless apps configuration.


key: alias

description: (optional) Alias mode can be enabled here. This can be used to combine various apps via depends_on parameter.


key: terraform

description: Terraform configuration.


key: infra

description: Infrastructure configuration.

deprecationMessage: infra block is deprecated


description: Infrastructure configuration.


key: version

description: (optional) Terraform version can be set here. 1.1.3 by default.


description: (optional) Terraform state bucket region can be specified here. Normally AWS_REGION is used here. Can be overridden via env vars or flags.


description: (optional) Terraform state bucket name can be specified here. Normally it's generated and defaults to <NAMESPACE>-tf-state


description: (optional) Terraform state name that will be used in the .tfstate file. Normally it's 'terraform' or state name.


description: (optional) Root domain name can be set here. This is the main domain that will be passed to the terraform. Generally if your app lives at 'api.dev.nutcorp.net' the root domain is `nutcorp.net`


description: (optional) Terraform-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.


description: (optional) Terraform-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).


description: Tunnel configuration.


description: Bastion instance ID.


key: items

description: Forward host.


description: App configuration.


key: type

description: app type


key: file

description: (optional) Path to serverless file can be specified here. Normally it's serverless.yml in the app directory.


description: (optional) Node version that will be used by nvm can be specified here that. Default is v14.


description: (optional) Create domain for the serverless domain manager during the deployment.


key: path

description: (optional) Path to ecs app folder can be specified here. By default it's derived from apps path and app name.


description: (optional) SLS node_modules cache mount path can be specified here. It's used to store cache during CI/CD process.


description: environments


description: environment


key: unsafe

description: (optional) Enables unsafe mode that increases deploy time on a cost of shorter healthcheck.


key: image

description: (optional) Docker image can be specified here. By default it's derived from the app name.


key: cluster

description: (optional) ECS cluster can be specified here. By default it's derived from env & namespace


description: (optional) Task definition revision can be specified here. By default latest revision is used to perform a deployment. Normally this parameter can be used via cli during specific deployment needs.


key: timeout

description: (optional) ECS deployment timeout can be specified here.


description: (optional) Docker registry can be set here. By default it uses ECR repo with the name of the service.


description: (optional) skip deploy app.


description: (optional) expresses startup and shutdown dependencies between apps


description: Ecs app configuration.


key: icon

description: (optional) set icon


description: (optional) ECS-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.


description: (optional) ECS-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).


description: Serverless app configuration.


description: (optional) Path to the serverless app directory can be specified here. Normally it's derived from app directory and app name.


description: (optional) Serverless-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.


description: (optional) Serverless-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).


description: Alias configuration.


description: Terraform configuration


description: (optional) Terraform version can be set here. 1.1.3 by default.


description: (optional) Terraform state bucket region can be specified here. Normally AWS_REGION is used here. Can be overridden via env vars or flags.


description: (optional) Terraform state bucket name can be specified here. Normally it's generated and defaults to <NAMESPACE>-tf-state


description: (optional) Terraform state name that will be used in the .tfstate file. Normally it's 'terraform' or state name.


description: (optional) Root domain name can be set here. This is the main domain that will be passed to the terraform. Generally if your app lives at 'api.dev.nutcorp.net' the root domain is `nutcorp.net`


description: (optional) Terraform-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.


description: (optional) Terraform-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).


key: catalogName

description: The name of the catalog


key: schemaName

description: The name of the schema


key: remarks

description: The comments stored for the table/view/column


key: tableName

description: The name of the table


key: where

description: Allows to define the 'where' condition(s) string


key: dbms

description: Specifies logical expression of database type(s) on which the change must be applied. Valid database type names are listed on the supported databases page. It can be a comma-separated list of multiple databases or you can also specify that a change is not applicable to a particular database type by prefixing with !. The keywords all and none are also available.


key: name

description: The name of the column.


key: computed

description: The attribute which is used if the value in name isn't actually a column name but a function. Since 3.3.0


key: descending

description: The boolean attribute which allows you to specify that a column should be used in a descending order in the index if it is used in a createIndex command. Default value is false (in an ascending order) Since 3.4


key: type

description: The column data type.


key: value

description: The value for which to set the column. The value will be surrounded by quote marks and nested quote marks will be escaped.


key: valueNumeric

description: The numeric value to set the column to. The value will not be escaped and will not be nested in quote marks.


key: valueBoolean

description: The boolean value to set the column to. The actual value string inserted will depend on the database implementation.


key: valueDate

description: The date and time value to set the column to. The value is specified in one of the following forms: YYYY-MM-DD, hh:mm:ss, or YYYY-MM-DDThh:mm:ss.


key: valueComputed

description: The value that is returned from a function or procedure call. This attribute will contain the function to call.


key: valueSequenceCurrent

description: The name of the sequence in which the current value is used.


key: valueSequenceNext

description: The name of the sequence in which the next value is used.


key: valueBlobFile

description:
The path to a file, whose contents will be written as a BLOB (i.e. chunk of binary data).

The path to the changelog file location must be either absolute or relative. An example of an absolute path is: /usr/local/somefile.dat on Unix or c:\Directory\somefile.dat on Windows.


key: valueClobFile

description:
The path to a file, whose contents will be written as a CLOB (i.e. chunk of character data).
The path to the changelog file location must be either absolute or relative. An example of an absolute path is: /usr/local/somefile.dat on Unix or c:\Directory\somefile.dat on Windows.


key: defaultValue

description: The default value for column.


key: defaultValueNumeric

description: The default numeric value for column.


key: defaultValueDate

description: The default date and time value for column. The value is specified in one of the following forms: YYYY-MM-DD, hh:mm:ss, or YYYY-MM-DDThh:mm:ss.


key: defaultValueBoolean

description: The default boolean value for column.


key: defaultValueComputed

description: The default value that is returned from a function or procedure call. This attribute will contain the function to call.


key: autoIncrement

description: The auto-increment column. Ignored on databases that do not support the autoincrement/identity functionality.


key: startWith

description: The value auto-increment start. Ignored on databases that do not support autoincrement/identity functionality.


key: incrementBy

description: The value of each step by auto-increment. Ignored on databases that do not support autoincrement/identity functionality.


key: remarks

description: A short description of the column (column comment).


key: encoding

description: The name of the encoding (specified in java.nio.Charset javadoc, e.g. "UTF-8") of the CLOB file (specified in valueClobFile) contents.


key: beforeColumn

description: The attribute that allows you to control where in the table column order the new column goes if it is used in an addColumn command. Only one of beforeColumn, afterColumn, or position is allowed. Since 3.1


key: afterColumn


key: position

description: The attribute that allows you to control where in the table column order the new column goes if it is used in an addColumn command. Only one of beforeColumn, afterColumn, or position is allowed. Uses one based index. Since 3.1


key: header

description: Name of the column in the CSV file from which the value for the column will be taken if its different from the column name. Ignored if index is also defined.


key: index

description: Index of the column in the CSV file from which the value for the column will be taken.


key: constraints

description: Constraint definitions


key: nullable

description: The attribute that defines whether the column is nullable.


key: notNullConstraintName

description: The not null constraint name.


key: primaryKey

description: The attribute that defines whether the column is a primary key.


key: primaryKeyName

description: The primary key name Since 1.6.


key: primaryKeyTablespace

description: The tablespace to use for the defined primary key.


key: unique

description: The attribute that defines whether a unique clause should be applied.


key: uniqueConstraintName

description: The unique constraint name.


key: references

description: The foreign key definition.


key: referencedTableCatalogName

description: The name of the catalog.


key: referencedTableSchemaName

description: The name of the schema.


key: referencedTableName

description: The name of the table.


key: referencedColumnNames

description: The name of the column.


key: foreignKeyName

description: The foreign key name.


key: deleteCascade

description: The attribute that sets delete cascade.


key: deferrable

description: The attribute that defines whether constraints are deferrable.


key: initiallyDeferred

description: The attribute that defines whether constraints are initially deferred.


key: checkConstraint

description: The attribute that defines whether to validate the defined check constraint.


key: validateNullable

description: The attribute that defines whether to validate the defined not null constraint.


key: validateUnique

description: The attribute that defines whether to validate the defined unique constraint.


key: validatePrimaryKey

description: The attribute that defines whether to validate the defined primary key constraint.


key: validateForeignKey

description: The attribute that defines whether to validate the defined foreign key constraint.


key: columns

description:
The column constraint and foreign key information. Setting the defaultValue attribute will specify a default value for the column. Setting the value attribute will set all rows existing to the specified value without modifying the column default.
See Information about the <column> tag section for more information.


key: preConditions

description: Preconditions are changelog or changeset tags which control the execution of an update based on the state of the database.

const: HALT

const: CONTINUE

const: WARN

default: HALT

const: TEST

const: FAIL

const: IGNORE

default: IGNORE

required: id author changeLogFile

required: tableName columnName


key: onFailMessage

description: Provides a custom message to output when preconditions fail. Since 2.0


key: onErrorMessage


key: onFail

description: Controls what happens if the preconditions check fails.


description: Halts the execution of the entire changelog (default). HALT can be put outside a changeset (e.g. at the beginning of the changelog).


description: Skips over the changeset. Execution of the changeset will be attempted again on the next update. Continues with the changelog.


description: Skips over the changeset but mark it as executed. Continues with the changelog.


description: Sends a warning and continues executing the changeset / changelog as normal. WARN can be put outside a changeset (e.g. at the beginning of the changelog).


key: onError

description: Controls what happens if there is an error checking whether the precondition passed or not.


key: onSqlOutput

description: Controls what to do in the updateSQL mode. Since 1.9.5


description: Runs the changeset in the updateSQL mode.


description: Fails the preCondition in the updateSQL mode.


description: Ignores the preCondition in the updateSQL mode (default).


key: dbms

description: Defines if the database executed against matches the type specified.


key: type

description: The type of database expected. Multiple dbms values can be specified using comma-separated values. (required)


key: runningAs

description: Defines if the database user executed under matches the username specified.


key: username

description: The database user script which is expected to run as. (required)


key: changeSetExecuted

description: Defines if the specified changeset has already been executed.


key: id

description: The changeset id. (required)


key: author

description: The changeset author. (required)


key: changeLogFile

description: The file name (including classpath relative path) of the changeset. (required)


key: columnExists

description: Defines if the specified column exists in the database.


key: schemaName

description: The name of the table's schema.


key: tableName

description: The name of the column's table. (required)


key: columnName

description: The name of the column. (required)


key: tableExists

description: Defines if the specified table exists in the database.


description: The name of the table. (required)


key: viewExists

description: Defines if the specified view exists in the database.


description: The name of the view's schema.


key: viewName

description: The name of the view. (required)


key: foreignKeyConstraintExists

description: Defines if the specified foreign key exists in the database.


description: The name of the foreign key's schema.


key: foreignKeyName

description: The name of the foreign key. (required)


key: indexExists

description:
Defines if the specified index exists in the database. You can either specify the indexName attribute or tableName and columnName attributes.
Note: There are a few databases where the indexName is not unique, that's why both indexName and tableName can be used.


description: The name of the index's schema.


key: indexName

description: The name of the index.


description: The name of the table.


description: The name of the column.


key: sequenceExists

description: Defines if the specified sequence exists in the database.


description: The name of the sequences' schema.


key: sequenceName

description: The name of the sequence. (required)


key: primaryKeyExists

description:
Defines if the specified primary key exists in the database.
(tableName or primaryKeyName is required)


description: The name of the primary key's schema.


key: primaryKeyName

description: The name of the primary key.


description: The name of the table containing primary key.


key: sqlCheck

description:
Executes an SQL string and checks the returned value. The SQL must return a single row with a single value.

To check a number of rows, use the count SQL function.
To check for ranges of values, perform the check in the SQL and return a value that can be easily compared against.


key: expectedResult

description: The value to compare the SQL result to. (required)


key: changeLogPropertyDefined

description: Checks whether given changelog attribute is present. It fails if the value is not the same as given.


key: property

description: The name of the property to check. (required)


key: value

description: The required value for a given property.


key: customPrecondition

description:
Can be created by adding a class that implements the liquibase.precondition.CustomPrecondition interface. Parameters on custom classes are set through reflection based on the <param> sub-tags. Pass parameters as strings to the custom precondition.

The customPrecondition sub-tags:
param - the parameter to pass to the custom precondition.
name - the name of the parameter to set. (required)
value - a string value to set parameter to. (required)


key: className

description: The name of the custom precondition class. (required)


key: createTable

description: You can typically use the createTable Change Type when you want to create a table in your changelog file and then deploy it to your database. It can include columns and another values listed in this documentation.

required: tableName columns


key: tablespace

description: The name of the tablespace in which the table is created


key: createView

description: Creates a new database view.


key: viewName

description: Name of the view to create


key: replaceIfExists

description: Use 'create or replace' syntax


key: fullDefinition

description: Set to true if selectQuery is the entire view definition. False if the CREATE VIEW header should be added.


key: path

description: Path to file containing view definition


key: encoding

description: Encoding used in the file defined in the `path` attribute


key: relativeToChangelogFile

description: Whether the file path relative to the root changelog file rather than to the classpath.


key: selectQuery

description: SQL for generating the view


key: sql

description: It is useful for complex changes that aren't supported through Liquibase's automated Change Types and to work around bugs and limitations of Liquibase. The SQL contained in the <SQL> Change Type can be multi-line.


key: stripComments

description: Set to true to remove any comments in the SQL before executing, otherwise false.


key: splitStatements

description: Set to false to not have Liquibase split statements on ;'s and GO's. Defaults to true if not set


key: endDelimiter

description:
Indicates the end of the SQL statement and prevents incomplete SQL statements from being processed when the SQL files contain statements referencing a ; which Liquibase treats as the default end delimiter. You can use the endDelimiter when the changeset contains SQL to create a stored procedure or function that contains the default ; end delimiter to separate the statements inside the procedure.
For more information, see The endDelimiter SQL attribute.


description: Specifies the SQL to execute


key: update

description: You can typically use the update Change Type when you want to update a table in your changelog file and then deploy this update to your database. It can include columns and another values listed in this documentation.


key: delete

description: Deletes data from an existing table.


key: value

description:
Value of the attribute.
Note: If not set, then the first valueXXX defined is used in the order they appear.


key: valueNumeric

description: integer value of the attribute.


key: valueBoolean

description: boolean value of the attribute.


key: valueDate

description: Date and/or Time value to set the attribute to. The value shall be specified in one of the following forms: "YYYY-MM-DD", "hh:mm:ss" or "YYYY-MM-DDThh:mm:ss".


key: valueComputed

description: A value that is returned from a function or procedure call. This attribute shall contain the function name to call.


key: valueSequenceNext

description: Name of the sequence which next value is used


key: valueSequenceCurrent

description: Name of the sequence which current value is used


key: tagDatabase

description: The tagDatabase Change Type applies a tag to the database for future update or rollback.


key: tag

description: The tag to apply


key: dropTable

description: Drops an existing table from your database.


key: cascadeConstraints

description: Add the `CASCADE CONSTRAINTS` to the statement


key: oldViewName

description: Name of the view to rename


key: newViewName

description: Name to rename the view to


key: dropView

description: Drops an existing view.


key: viewName

description: Name of the view to drop


key: empty

description: empty


key: insert

description: You can typically use the insert Change Type when you want to add and deploy the specific data or values to the existing table in your database. It can include columns and another attributes listed in this documentation.


key: addColumn

description: You can typically use the addColumn Change Type when you want to add a new column and deploy it to the table in your database.


key: createProcedure

description:
The createProcedure Change Type defines the definition for a stored procedure. This Change Type is better to use for creating procedures than the raw SQL command because it will not attempt to strip comments or break up lines.

Often times it is best to use the CREATE OR REPLACE syntax along with setting runOnChange='true' on the enclosing changeset tag. That way if you need to make a change to your procedure, you can change your existing code rather than creating a new REPLACE PROCEDURE call. The advantage to this approach is that it keeps your changelog smaller and allows you to more easily see what has changed in your procedure code through your source control system's diff command.

required: path procedureText


key: procedureText

description: The SQL creating the procedure. You need to define either this attribute or the path attribute. The procedureText attribute is not supported in the XML format; however, you can specify the procedure SQL within <createProcedure></<createProcedure> tags. See the XML example.


key: procedureName

description: The name of the procedure. It is required if replaceIfExists= true


key: path

description: The file containing the procedure text. Either this attribute or a nested procedure text is required.


key: encoding

description: The encoding used in the file defined in the `path` attribute


key: relativeToChangelogFile

description: Defines whether the file path is relative to the root changelog file rather than to the classpath.


key: replaceIfExists

description: If the stored procedure defined by procedureName already exits, alter it instead of creating it.


key: comments

description: The comments you can specify in the changeset.


key: dropProcedure

description: Drops an existing procedure


description: Name of the stored procedure to drop


key: sqlFile

description: The <sqlFile> Change Type is useful for complex changes that are not supported through Liquibase automated Change Types such as stored procedures. The SQL contained in the <sqlFile> Change Type can be multi-line.


description: Specifies the file path of the SQL file to load.


key: stripComments

description: Set to true to remove any comments in the SQL before executing, otherwise false.


key: splitStatements

description: Set to false to not have Liquibase split statements on ;'s and GO's. Defaults to true if not set.


description: Specifies encoding used in the file defined in the `path` attribute.


key: endDelimiter

description:
Indicates the end of the SQL statement and prevents incomplete SQL statements from being processed when the SQL files contain statements referencing a ; which Liquibase treats as the default end delimiter. You can use the endDelimiter when the changeset contains SQL to create a stored procedure or function that contains the default ; end delimiter to separate the statements inside the procedure.
For more information, see The endDelimiter SQL attribute.


description: Indicates whether the file path is relative to the root changelog file rather than to the classpath.


key: stop

description: Stops Liquibase execution with a message. Mainly useful for debugging and stepping through a changelog


key: message

description: Message to output when execution stops


key: renameTable

description: Renames an existing table.

required: newTableName oldTableName


key: oldTableName

description: Name of the table to rename


key: newTableName

description: New name for the table


key: renameColumn

description: Renames an existing column.

required: newColumnName oldColumnName tableName


key: oldColumnName

description: Name of the existing column to rename


key: newColumnName

description: Name to rename the column to


key: columnDataType

description: Data type of the column


key: remarks

description: Remarks of the column


key: dropColumn

description:
Drops an existing column(s).

To drop a single column, use the simple form of this element where the tableName and columnName are specified as attributes. To drop several columns, specify the tableName as an attribute, and then specify a set of nested <column> tags. If nested <column> tags are present, the columnName attribute will be ignored.


key: columnName

description: Name of the column to drop, if dropping a single column. Ignored if nested 'column's are defined


key: mergeColumns

description:
The mergeColumns Change Type concatenates the values in two columns and joins them with a string. The Change Type stores the resulting value in a new column.
You can typically use the mergeColumns Change Type when you want to combine the values from two columns into one.


description: The name of the column containing the first half of the data


key: joinString

description: The string to place between the values from column1 and column2 (may be empty)


description: The name of the column containing the second half of the data


key: finalColumnName

description: The name of the column to create


key: finalColumnType

description: The data type of the column to create


key: modifyDataType

description: Allows you to modify data types.

required: columnName newDataType tableName


description: Name of the column


key: createSequence

description: Creates a new database sequence.


key: sequenceName

description: Name of the sequence to create


key: startValue

description: The first sequence number to be generated.


key: incrementBy

description: Interval between sequence numbers


key: maxValue

description: The maximum value of the sequence


key: minValue

description: The minimum value of the sequence


key: ordered

description: Does the sequence need to be guaranteed to be generated in the order of request?


key: cacheSize

description: Number of values to fetch per query


key: dataType

description: Data type of the sequence


key: cycle

description: Can the sequence cycle when it hits the max value?


key: alterSequence

description: Alters properties of an existing sequence.


description: Name of the sequence to alter


description: New amount the sequence should increment by


description: New maximum value for the sequence


description: New minimum value for the sequence


description: Change the cache size


key: dropSequence

description: Drops an existing sequence.


description: Name of the sequence to drop


key: renameSequence

description: Renames an existing sequence.

required: newSequenceName oldSequenceName


key: oldSequenceName

description: Name of the sequence to rename


key: newSequenceName

description: New name for the sequence


key: createIndex

description: The createIndex Change Type creates an index on an existing column or a set of columns.


key: indexName

description: The name of the index to create.


key: unique

description: The unique values in the index.


key: clustered

description: The attribute that creates a clustered index.


key: tablespace

description: The tablespace in which you create the index.


key: dropIndex

description: The dropIndex Change Type drops an existing index on a column.


description: The name of the index to drop.


key: addNotNullConstraint

description: The addNotNullConstraint Change Type adds a NOT NULL constraint to an existing table.

required: columnName tableName


key: columnName

description: The name of the column for which to add the constraint.


key: defaultNullValue

description: The value for which you can set all values that currently equal null in a column. If null values exist and if defaultNullValue is not set, the change will fail.


key: columnDataType

description: The current data type of the column.


key: constraintName

description: The created constraint name (if database supports names for NOT NULL constraints).


key: validate

description: The attribute which is true if the NOT NULL constraint has 'ENABLE VALIDATE' set, or which is false if the NOT NULL constrain has 'ENABLE NOVALIDATE' set.


key: dropNotNullConstraint

description: Makes a column nullable.


description: Name of the column to drop the constraint from


description: Current data type of the column


key: addForeignKeyConstraint

description: Adds a foreign key constraint to an existing column.

required: baseColumnNames baseTableName constraintName referencedColumnNames referencedTableName


key: baseTableCatalogName

description: Catalog name of the base table


key: baseTableSchemaName

description: Schema name of the base table


key: baseTableName

description: Name of the table containing the column to constraint


key: baseColumnNames

description: Name of column(s) to place the foreign key constraint on. Comma-separate if multiple


description: Name of the new foreign key constraint


key: referencedTableCatalogName

description: Schema name of the referenced table


key: referencedTableSchemaName

description: Schema name of the referenced table


key: referencedTableName

description: Name of the table the foreign key points to


key: referencedColumnNames

description: Column(s) the foreign key points to. Comma-separate if multiple


key: deferrable

description: Is the foreign key deferrable


key: initiallyDeferred

description: Is the foreign key initially deferred


key: onDelete

description: ON DELETE functionality. Possible values: 'CASCADE', 'SET NULL', 'SET DEFAULT', 'RESTRICT', 'NO ACTION'


key: onUpdate

description: ON UPDATE functionality. Possible values: 'CASCADE', 'SET NULL', 'SET DEFAULT', 'RESTRICT', 'NO ACTION'


description: Shall be true if the foreign key should 'ENABLE VALIDATE' set, or false if the foreign key should 'ENABLE NOVALIDATE' set.


key: dropForeignKeyConstraint

description: Drops an existing foreign key.

required: baseTableName constraintName


description: Name of the table containing the column constrained by the foreign key


key: constraintName

description: Name of the foreign key constraint to drop


key: dropAllForeignKeyConstraints

description: Drops all foreign key constraints for a table.


description: Catalog name of the table containing columns constrained by foreign keys


description: Schema name of the table containing columns constrained by foreign keys


description: Name of the table containing columns constrained by foreign keys


key: addPrimaryKey

description: Adds a primary key out of an existing column or set of columns.

required: columnNames tableName


key: columnNames

description: Name of the column(s) to create the primary key on. Comma separated if multiple


description: Name of primary key constraint


key: validate

description: This is true if the primary key has 'ENABLE VALIDATE' set, or false if the primary key has 'ENABLE NOVALIDATE' set.


key: dropPrimaryKey

description: The dropPrimaryKey Change Type drops an existing primary key in the table.


description: The name of the primary key.


key: dropIndex

description: The index to drop.


key: addLookupTable

description: Creates a lookup table containing values stored in a column and creates a foreign key to the new table.

required: existingColumnName existingTableName newColumnName newTableName


key: existingTableName

description: Name of the table containing the data to extract


key: existingColumnName

description: Name of the column in the new table to create


key: newTableName

description: Name of lookup table to create


key: newColumnName


key: newColumnDataType

description: Data type of the new table column


description: Name of the foreign-key constraint to create between the existing table and the lookup table


key: addAutoIncrement

description: Converts an existing column to be an auto-increment (a.k.a 'identity') column.

enum:
ALWAYS
BY DEFAULT


key: columnName

description: Name of the column


key: defaultOnNull

description: When using generationType 'BY DEFAULT' then defaultOnNull = true allows the identity to be used if the identity column is referenced, but a value of NULL is specified.


key: generationType

description: Type of the generation in 'GENERATED %s AS IDENTITY'. ALWAYS | BY DEFAULT


key: columnDataType

description: Current data type of the column to make auto-increment


key: startWith

description: Initial integer value of the increment


key: incrementBy

description: Integer value the increment increments at each call


key: addDefaultValue

description: The addDefaultValue Change Type adds a default value to the database definition for the specified column.


description: The name of the column for which to add a default value.


description: The current data type of the column for which to add a default value.


key: defaultValue

description: The default value. Either this property or one of the other defaultValue* properties are required.


key: defaultValueNumeric

description: The attribute that sets the default value for a column of a numeric type. For example: integer, bigint, bigdecimal, and others.


key: defaultValueDate

description: The attribute that sets the default value for a column of a date type. For example: timestamp, datetime, date, and others.


key: defaultValueBoolean

description: The attribute that sets the default value for a column of a boolean type.


key: defaultValueComputed

description: The attribute that sets the default value for a column using a function which returns value of the same type as the column has.


key: defaultValueSequenceNext

description: The attribute that sets value for a specified column by using the value of the existing sequence. With every new input, the next value of the sequence will be taken.


key: defaultValueConstraintName

description: The attribute that sets a unique name for default constraint used for a specific column. It works only along with any of defaultValue* attributes listed.


key: dropDefaultValue

description: Removes the database default value for a column.


description: Name of column to drop the default value from


key: addUniqueConstraint

description: Adds a unique constraint to an existing column or set of columns.


key: columnNames

description: Name of the column(s) to create the unique constraint on. Comma separated if multiple


key: constraintName

description: Name of the unique constraint


key: tablespace

description: 'Tablespace' to create the index in. Corresponds to file group in mssql


key: disabled

description: True if this constraint is disabled, False otherwise


key: deferrable

description: True if this constraint is deferrable, False otherwise


key: initiallyDeferred

description: True if this constraint is initially deferred, False otherwise


key: clustered

description: Whether create a clustered index


key: validate

description: Should be true if the unique constraint shall 'ENABLE VALIDATE' set, or false if the 'ENABLE NOVALIDATE' shall.


key: dropUniqueConstraint

description: Drops an existing unique constraint.

required: constraintName tableName


description: Name of unique constraint to drop


key: setTableRemarks

description: Sets remarks on a table.

required: remarks tableName


key: remarks

description: Comment to set on the table


key: setColumnRemarks

description: The setColumnRemarks Change Type sets remarks on a column.

required: columnName remarks tableName


key: columnName

description: The name of the column


description: The comment to set on the column


key: customChange

description: The customChange type creates a custom Change Type class.


key: loadData

description: Loads data from a CSV file into an existing table when you add it to your changelog.

required: file tableName


key: file

description: CSV file to load.


key: relativeToChangelogFile

description: Whether the file path relative to the root changelog file rather than to the classpath.


key: usePreparedStatements

description: Use prepared statements instead of insert statement strings if the database supports it.


key: encoding

description: Encoding of the CSV file (defaults to UTF-8).


key: separator

description: Character separating the fields.


key: quotchar

description: The quote character for string fields containing the separator character.


key: commentLineStartsWith

description: Lines starting with this are treated as comment and ignored.


key: loadUpdateData

description:
Loads or updates data from a CSV file into an existing table. Differs from loadData by issuing a SQL batch that checks for the existence of a record. If found, the record is UPDATEd, else the record is INSERTed. Also, generates DELETE statements for a rollback.

A value of NULL in a cell will be converted to a database NULL rather than the string 'NULL'

required: file primaryKey tableName


description: CSV file to load


description: Encoding of the CSV file (defaults to UTF-8)


key: primaryKey

description: Comma delimited list of the columns for the primary key


key: onlyUpdate

description: If true, records with no matching database record should be ignored


description: Use prepared statements instead of insert statement strings if the DB supports it.


key: executeCommand

description: The executeCommand Change Type executes a system command.


key: executable

description: The name of the executable to run


key: os

description: The list of operating systems on which to execute the command (taken from the os.name Java system property)


key: timeout

description: The timeout value for executable to run


key: arg

description: Arguments for the executable


key: value

description: The value of the attribute (for example: '-param')


key: args

description: Arguments for the executable


key: output

description: Logs a message and continues execution.

enum: STDOUT STDERR FATAL WARN INFO DEBUG

default: STDERR


key: message

description: Message to output


key: target

description: Target for message. Possible values: STDOUT, STDERR, FATAL, WARN, INFO, DEBUG. Default value: STDERR


key: modifySql

description: Although Liquibase supports most standard SQL statements with its Change Types, there are times when you need the generated SQL to be different. The following examples show how to change data types or add additional vendor-specific clauses such as ENGINE INNODB to CREATE TABLE statements. Since 1.9


key: context

description: Specifies the list of Contexts in which to run the SQL modification. If you do not specify any context, every changeset will be applied. Since 2.0


key: applyToRollback

description: Defines whether the SQL modification should be applied to rollback statements. The default value is false. Since 2.0


key: prepend

description: Adds SQL to the beginning of the statement.


key: append

description: Adds SQL to the end of the statement.


key: replace

description: Replaces all instances of the text specified.


key: regExpReplace

description: Replaces all instances of the regular expression specified.


key: databaseChangeLog

description: The root of all Liquibase changes is the changelog file. Liquibase uses a changelog to sequentially list all changes made to your database. Think of it as a ledger. It is a file that contains a record of all your database changes (changesets). Liquibase uses this changelog record to audit your database and execute any changes that are not yet applied to your database.

required: id author

required: changeSetId changeSetAuthor


key: logicalFilePath

description: Overrides the file name and path when creating the unique identifier of changesets. It is required when you want to move or rename changelogs.


key: objectQuotingStrategy

description:
Controls how object names are quoted in the generated SQL or used in calls to the database. The names of objects are used differently in databases. For example, Oracle converts everything to uppercase (unless quoted). There are three possible values. The default value is LEGACY.
LEGACY - the same behavior as in Liquibase 2.0
QUOTE_ALL_OBJECTS - every object gets quoted. For example: person becomes "person".
QUOTE_ONLY_RESERVED_WORDS - reserved keywords and invalid column names are quoted.


key: property

description: Liquibase allows a dynamic substitution of properties in your changelog. The tokens to replace in your changelog are described using the ${property-name} syntax.


key: file

description: The name of the file from which the properties should be loaded. It will create a property for all properties in the file. The content of the file must follow the java properties file format.


key: name

description: The name of the parameter. Required if file is not set


key: value

description: The value of the property. Required if file is not set


description: Contexts in which the property is valid. Expected as a comma-separated list.


key: global

description: Boolean. Defines whether the property is global or limited to the actual DATABASECHANGELOG. It is given as true or false.


key: changeSet

description:
The changeset tag is a unit of change that Liquibase executes on a database and which is used to group database Change Types together. A list of changes created by multiple changesets are tracked in a changelog.

A changeset is uniquely tagged by both an author and an id attributes (author:id), as well as the changelog file path. The id tag is only used as an identifier, it does not direct the order that changes are run and does not have to be an integer. If you do not know or do not want to save the actual author, use a placeholder value such as UNKNOWN. To execute the changeset, you must include both author and id.


key: id

description: Specifies an alpha-numeric identifier. Required


key: author

description: Specifies the creator of the changeset. Required


key: context

description: Controls whether a changeset is executed depending on runtime settings. Any string can be used for the context name and they are checked case-insensitively.


key: labels

description: Controls whether a changeset is executed depending on runtime settings. Any string can be used for the label name and they are checked case-insensitively.


key: runOnChange

description: Executes the changeset the first time and each time the changeset has been changed.


key: runAlways

description: Executes the changeset on every run, even if it has been run before.


key: failOnError

description: Defines whether the migration will fail if an error occurs while executing the changeset. Default value is true.


key: runInTransaction

description: Specifies whether the changeset can be ran as a single transaction (if possible). Default value is true.


description: Overrides the file name and path when creating the unique identifier of changesets. Required when moving or renaming changelog.


description:
Controls how object names are quoted in the generated SQL or used in calls to the database. Different databases do different things to the names of objects. For example, Oracle converts everything to uppercase (unless quoted). There are three possible values. The default value is LEGACY.
LEGACY - the same behavior as in Liquibase 2.0
QUOTE_ALL_OBJECTS - every object gets quoted. For example: person becomes "person".
QUOTE_ONLY_RESERVED_WORDS - reserved keywords and invalid column names are quoted.


key: created

description: Stores dates, versions, or any other string of value without using remarks (comments) attributes. Since 3.5


key: runOrder

description: Overrides the order in the changelog from where the changeset with the runOrder="first|last" will be run. It is typically used when you want a changeset to be always executed after everything else but don't want to keep moving it to the end of the changelog. Setting the runOrder to last will automatically move it in the final changeset order.Since 3.5


key: ignore

description: Ignores the changeset from the execution. Since 3.6


key: validCheckSum

description: Adds a checksum that is considered valid for this changeset, regardless of what is stored in the database. It is primarily used when you need to change a changeset and don't want errors thrown on databases on which it has already been run (not a recommended procedure). Special value "1:any" will match to any checksum and will not execute the changeset on ANY change. Since 1.7


key: comment

description: Specifies the description of the changeset. XML comments will provide the same benefit. Future releases of Liquibase may be able to make use of <comment> tag comments to generate documentation.


key: rollback

description: If you do not want to undo a change in a rollback mode, you can use an empty rollback tag.


key: include

description: The <include> tag is used within your master changelog to reference other changelogs.


key: file

description: Name of the file you want to import required.


key: relativeToChangelogFile

description: File path relative to the changelog file containing the element rather than to the classpath. Default: false


description: Appends a context (using an AND statement) to all contained changesets.


description: Appends a label to all contained changesets.


key: includeAll

description: The <includeAll> tag allows you to specify a directory that contains multiple changelog files. It is used within your master changelog file to call on the directory and include all .xml files as changelog files, and all .sql files as individual changes.


key: path

description: Name of the path you want to reference.


key: errorIfMissingOrEmpty

description: Controls what happens if the path listed does not exist or is an empty directory. Default: false. If set to true, the update will fail.


description: File path relative to the changelog file containing the element rather than to the classpath. Default: false.


key: resourceComparator

description: A string containing the name of the class you want to use for sorting.


key: filter

description: A class name that allows you to create custom filters.


description: The resource configurations mapped to tenant id

required: readModels eventStore


key: resourceTypeConfiguration

description: The configuration of a resource type


key: readModels

description: Configuration for the resource type for read models


key: eventStore

description: Configuration for the resource type for the event store


description:
An array of crawler rules.
 - Anything prefixed as "HTML RegEx" will do Java-flavored pattern-matching on the page's raw (unmodified by javascript) HTML.

required: enabled name rule pattern

examples: cookieName cookieValue

format: regex

enum: DEEPDECRYPT REWRITE DIRECTHTTP FOLLOWREDIRECT SUBMITFORM

const: DEEPDECRYPT

const: REWRITE

const: DIRECTHTTP

const: SUBMITFORM

const: FOLLOWREDIRECT


key: enabled

description:
- Type: Boolean
- Applies to rule: ALL
- Purpose: Enables or disables this rule


key: cookies

description:
- Type: Array of length-2 Arrays
- Applies to rule: DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT
- Purpose: A list of length-2 arrays in the form [["cookieName", "cookieValue"],[..., ...]...]. Here you can put in your personal cookies e.g. login cookies of websites which JD otherwise fails to parse.Also if "updateCookies" is enabled, JD will update these with all cookies it receives from the website(s) that match the "pattern" property.


key: updateCookies

description:
- Type: Boolean
- Applies to rule: DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT
- Purpose: If the target websites returns new cookies, save these inside this rule and update this rule.


key: logging

description:
- Type: Boolean
- Applies to rule: ALL
- Purpose: Enable this for support purposes. Logs of your LinkCrawler Rules can be found in your JD install dir/logs/: LinkCrawlerRule.<RuleID>.log.0 and /LinkCrawlerDeep.*


key: maxDecryptDepth

description:
- Type: Integer
- Applies to rule: ALL
- Purpose: How many layers deep do should your rule crawl (e.g. rule returns URLs matching the same rule again recursively - how often is this chain allowed to happen?)


key: id

description:
- Type: Integer
- Applies to rule: ALL
- Purpose: Auto generated ID of the rule. Normally leave this blank and JD2 will autoinsert.


key: name

description:
- Type: String
- Applies to rule: ALL
- Purpose: name of the rule.


key: pattern

description:
- Type: RegEx
- Applies to rule: ALL
- Purpose: defines on which URLs will this rule apply by matching it to the pattern


key: packageNamePattern

description:
- Type: HTML RegEx
- Applies to rule: DEEPDECRYPT
- Purpose: All URLs crawled by this rule will be grouped into the same package that is the HTML RegEx's first capture


key: passwordPattern

description:
- Type: HTML RegEx or null
- Applies to rule: DEEPDECRYPT
- Purpose: Matches against archive extraction password that may be found as text inside the page's (unmodified by javascript) HTML code. First returned capture must be the password.


key: formPattern

description:
- Type: HTML RegEx
- Applies to rule: DEEPDECRYPT
- Purpose:


key: deepPattern

description:
- Type: HTML RegEx or null
- Applies to rule: DEEPDECRYPT
- Purpose: Which URLs should this rule look for inside the page's (unmodified by javascript) HTML code. null (or blank) = auto scan and return all supported URLs found in HTML code.
Keep in mind that, if the url's found in the html are relative (e.g. starting with a slash / character instead of a protocol like http or a domain (website root) name) you WILL have to enclose the entire expression in quotes (outside of the parentheses that do capturing) like \"(...)\" AND enclose the part that would match the missing part of the url (i.e. from the protocol to the slash-or-other-character it begins with) in an 'OPTIONAL, NON CAPTURING' group (?:...)?. Resulting in the following pattern for pretty much every case \"((?:missing part of full url)?rest of url that is in the html)\"


key: rewriteReplaceWith

description:
- Type: String
- Applies to rule: REWRITE
- Purpose:Pattern for new URL, can use captures from "pattern" in the $1 form


description: Roadrunner config file schema version 3

default: roadrunner

examples:
php not-worker.php
sh script.sh
start script.bat

default: pipes

default: development

default: debug

default: console

default: stderr

default: default

enum: prometheus statsd

default: prometheus

examples: summary histogram

enum: zipkin stdout stderr otlp jaeger jaeger_agent

enum: http grpc

default: RoadRunner

enum: headers gzip static sendfile http_metrics cache proxy_ip_parser otel

enum: DEBUG INFO WARN DPANIC PANIC ERROR FATAL

enum: amqp sqs beanstalk boltdb memory nats kafka

enum: AtEnd At AfterMilli AtStart Relative WithEpoch


key: version

description: configuration version


key: centrifuge

description: Centrifugo server plugin. Docs: https://centrifugal.dev/


description: Centrifugo server proxy address (docs: https://centrifugal.dev/docs/server/proxy#grpc-proxy)


description: gRPC server API address (docs: https://centrifugal.dev/docs/server/server_api#grpc-api)


description: Use gRPC gzip compressor


description: Your application version


description: Your application name


key: pool

description: Workers pool settings


key: tls

description: TLS settings


key: cert

description: Path to the cert file


key: key

description: Path to the cert key file


key: listen

description: TCP address:port for listening


description: Execute command or script after RR allocated a pool of workers. Command executed on the every pool allocation. For example, if you have 2 plugins: `http` and `grpc`, the `after_init` command would be fired twice.


key: command

description: Command to execute. It can be script or binary


Script execute timeout


key: env

description: Environment variables for the worker processes


description: Execute command or script before RR starts allocating workers


description: Worker starting command, with any required arguments


key: user

description: User name (not UID) for the worker processes. An empty value means to use the RR process user


key: group

description: Group name (not GID) for the worker processes. An empty value means to use the RR process user


key: relay

description: Worker relay can be: 'pipes', TCP (eg.: tcp://127.0.0.1:6002), or socket (eg.: unix:///var/run/rr.sock)


Timeout for relay connection establishing (only for socket and TCP port relay)


key: output

description: Output


description: Errors only output


key: channels

description: You can configure each plugin log messages individually


description: file logger options


description: path to the file


description: maximum file size in MB


description: The maximum number of days to retain old log files based on the timestamp encoded in their filename


description: The maximum number of old log files to retain


key: compress

description: compress files to save a disk space


key: temporal

description: Workflow and activity mesh service, https://docs.temporal.io/docs/php/introduction/


key: address

description: Address of temporal server


description: Sticky cache size. Sticky workflow execution is the affinity between workflow tasks of a specific workflow execution to a specific worker. The benefit of sticky execution is that the workflow does not have to reconstruct state by replaying history from the beginning. The cache is shared between workers running within same process. This must be called before any worker is started. If not called, the default size of 10K (which may change) will be used


key: namespace

description: Namespace name for this client to work with


key: metrics

description: Temporal metrics


key: driver

description: Metrics driver to use


description: Server metrics address


key: type

description: Metrics type


key: prefix

description: Temporal metrics prefix


description: The host and port of the statsd server


description: The prefix to use in reporting to statsd


description: FlushInterval is the maximum interval for sending packets


description: FlushBytes specifies the maximum udp packet size you wish to send. If FlushBytes is unspecified, it defaults  to 1432 bytes, which is considered safe for local traffic.


key: tags

description: Hashmap with tag:value values


description: Prefix for the tag


description: TagSeparator allows tags to be appended with a separator. If not specified tag keys and values are embedded to the stat name directly.


key: activities

description: Activities pool settings


key: tls

description: Temporal TLS configuration


key: key

description: Path to the key file


key: cert

description: Path to the certificate


description: Path to the CA certificate


description: Client auth type


description: ServerName is used to verify the hostname on the returned certificates unless InsecureSkipVerify is given. It is also included in the client's handshake to support virtual hosting unless it is an IP address.


key: kv

description: Key value storages plugin


description: boltdb driver


description: Driver which should be used for the storage