renovate-schema.json

title: JSON schema for Renovate config files (https://renovatebot.com/)

description: Labels to add to Pull Request.

description: Additional string value to be appended to `branchPrefix`.

description: Additional reviewers for Pull Requests (in contrast to `reviewers`, this option adds to the existing reviewer list, rather than replacing it).

description: Set this to `true` to allow custom crate registries.

description: Set this to `true` if repositories are allowed to run install plugins.

description: Set this to `false` to disable template compilation for post-upgrade commands.

description: Set this to `true` if repositories are allowed to run install scripts.

description: A list of regular expressions that decide which post-upgrade tasks are allowed.

description: Configuration object for the ansible manager

description: Configuration object for the ansible-galaxy manager

description: Configuration object for the argocd manager

description: Configuration object for the asdf manager

description: Assign reviewers and assignees even if the PR is to be automerged.

description: Assignees for Pull Request (either username or email address depending on the platform).

description: Determine assignees based on configured code owners and changes in PR.

description: Take a random sample of given size from `assignees`.

description: Set to `true` to automatically approve PRs.

description: Control whether replacement regular expressions are global matches or only the first match.

description: Autodiscover all repositories.

description: Filter the list of autodiscovered repositories.

description: Filter the list of autodiscovered repositories by topics.

description: Whether to automerge branches/PRs automatically, without human intervention.

description: PR comment to add to trigger automerge. Only used if `automergeType=pr-comment`.

default: automergeComment

description: Limit automerge to these times of day or week.

description: The merge strategy to use when automerging PRs. Used only if `automergeType=pr`.

enum: auto fast-forward merge-commit rebase squash

default: auto

description: How to automerge, if enabled.

enum: branch pr pr-comment

default: pr

description: Configuration object for the azure-pipelines manager

description: The id of an existing work item on Azure Boards to link to each PR.

description: List of one or more custom base branches defined as exact strings and/or via regex expressions.

description: The base directory for Renovate to store local files, including repository files and cache. If left empty, Renovate will create its own temporary directory to use.

description: Configuration object for the batect manager

description: Configuration object for the batect-wrapper manager

versioning: semver

description: Configuration object for the bazel manager

description: Configuration object for the bazel-module manager

description: Configuration object for the bazelisk manager

description: Use the default reviewers (Bitbucket only).

description: Use the repository's [development branch](https://support.atlassian.com/bitbucket-cloud/docs/branch-a-repository/#The-branching-model) as the repository's default branch.

description: Configuration object for the bicep manager

description: Controls how third-party tools like npm or Gradle are called: directly, via Docker sidecar containers, or via dynamic install.

enum: global docker install hermit

default: install

description: Configuration object for the bitbucket-pipelines manager

description: Limit to a maximum of x concurrent branches. 0 means no limit, `null` (default) inherits value from `prConcurrentLimit`.

description: Branch name template.

description: Whether to be strict about the use of special characters within the branch name.

description: Prefix to use for all branch names.

default: renovate/

description: Old branchPrefix value to check for existing PRs.

description: Branch topic.

description: Configuration object for the buildkite manager

commitMessageTopic: buildkite plugin {{depName}}

description: Bump the version in the package file being updated.

enum: major minor patch prerelease

description: Configuration object for the bundler manager

versioning: ruby

description: The directory where Renovate stores its cache. If left empty, Renovate creates a subdirectory within the `baseDir`.

description: Maximum duration in minutes to keep datasource cache entries.

description: Configuration object for the cake manager

description: Configuration object for the cargo manager

commitMessageTopic: Rust crate {{depName}}

versioning: cargo

description: Configuration object for the cdnurl manager

description: A list of branch names to mark for creation or rebasing as if it was selected in the Dependency Dashboard issue.

description: Configuration object for the circleci manager

description: Set to `true` to initialize submodules during repository clone.

description: Configuration object for the cloudbuild manager

description: Configuration object for the cocoapods manager

description: Commit message body template. Will be appended to commit message, separated by two line returns.

description: If enabled, append a table in the commit message body describing all updates in the commit.

description: Message to use for commit messages and pull request titles.

default: {{{commitMessagePrefix}}} {{{commitMessageAction}}} {{{commitMessageTopic}}} {{{commitMessageExtra}}} {{{commitMessageSuffix}}}

description: Action verb to use in commit messages and PR titles.

default: Update

description: Extra description used after the commit message topic - typically the version.

description: Lowercase PR- and commit titles.

enum: auto never

description: Prefix to add to start of commit messages and PR titles. Uses a semantic prefix if `semanticCommits` is enabled.

description: Suffix to add to end of commit messages and PR titles.

description: The upgrade topic/noun used in commit messages and PR titles.

description: Configuration object for the composer manager

description: Configure use of `--ignore-platform-reqs` or `--ignore-platform-req` for the Composer package manager.

description: Configuration object for the conan manager

description: If enabled, issues created by Renovate are set as confidential.

description: Enable this to get config migration PRs when needed.

description: Set this to `false` to make Renovate create a new issue for each config warning, instead of reopening or reusing an existing issue.

description: Configuration object to define language or manager version constraints.

description: Perform release filtering based on language constraints.

description: The directory where Renovate stores its containerbase cache. If left empty, Renovate creates a subdirectory within the `cacheDir`.

description: Configuration object for the cpanfile manager

description: Defines custom datasources for usage by managers

description: A custom description for this configuration object

description: Template for generating a defaultRegistryUrl for custom datasource

description: Format of the custom datasource

description: List of jsonata transformation rules

description: Custom environment variables for child processes and sidecar Docker containers.

description: Customize sections in the dependency dashboard issue.

description: List of registry URLs to use as the default for a datasource.

description: Whether to create a "Dependency Dashboard" issue in the repository.

description: Controls if updates need manual approval from the Dependency Dashboard issue before PRs are created.

description: Set to `true` to let Renovate close the Dependency Dashboard issue if there are no more updates.

description: Any text added here will be placed last in the Dependency Dashboard issue body, with a divider separator before it.

description: Any text added here will be placed first in the Dependency Dashboard issue body.

default: This issue lists Renovate updates and detected dependencies. Read the [Dependency Dashboard](https://docs.renovatebot.com/key-concepts/dashboard/) docs to learn more.

description: These labels will always be applied on the Dependency Dashboard issue, even when they have been removed manually.

description: Control if the Dependency Dashboard issue lists CVEs supplied by [osv.dev](https://osv.dev).

description: Title for the Dependency Dashboard issue.

description: Configuration object for the deps-edn manager

description: Plain text description for a config or preset.

description: If `true`, Renovate tries to detect global manager configuration from the file system.

description: If `true`, Renovate tries to detect host rules from environment variables.

description: Configuration to apply when updating a digest (no change in tag/version).

description: Configuration object for the docker-compose manager

description: Change this value to add a prefix to the Renovate Docker sidecar container names and labels.

description: Pass CLI flags to `docker run` command when `binarySource=docker`.

description: Change this value to override the default Renovate sidecar image.

description: Set the `UID` and `GID` for Docker-based binaries if you use `binarySource=docker`.

description: Configuration object for the dockerfile manager

description: If set to `true` then Renovate creates draft PRs, instead of normal status PRs.

description: Configuration object for the droneci manager

description: If enabled, perform a dry run by logging messages instead of creating/updating/deleting branches and PRs.

description: Enable or disable Renovate bot.

description: A list of package managers to enable. Only managers on the list are enabled.

description: An object containing configuration encrypted with project key.

description: Custom endpoint to use.

description: A file matching any of these glob patterns will not be committed, even if the file has been updated.

description: Default execution timeout in minutes for child processes Renovate creates.

description: Set this to `true` to allow passing of all environment variables to package managers.

description: Configuration presets to use or extend.

description: A regex (`re2`) to extract a version from a datasource's raw version string.

description: Controls if and when release notes are fetched.

description: RegEx (`re2`) pattern for matching manager files.

description: Filter reviewers and assignees based on their availability.

description: Configuration object for the fleet manager

description: Configuration object for the flux manager

description: If defined, packages will follow this release tag exactly.

description: Any configuration set in this object will force override existing settings.

description: Decides if CLI configuration options are moved to the `force` config section.

description: Disallow maintainers to push to Renovate pull requests when running in fork mode.

description: The preferred organization to create or find forked repositories, when in fork mode.

description: Whether to process forked repositories. By default, all forked repositories are skipped when in `autodiscover` mode.

description: Set a personal access token here to enable "fork mode".

description: Configuration object for the fvm manager

description: Configuration object for the git-submodules manager

description: Author to use for Git commits. Must conform to [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322).

description: Git authors which are ignored by Renovate. Must conform to [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322).

description: Ignore approval rules for MRs created by Renovate, which is useful for automerge.

description: Which Git commands will be run with the `--no-verify` option.

description: PGP key to use for signing Git commits.

description: Configure the timeout with a number of milliseconds to wait for a Git task.

description: Overrides the default resolution for Git remote, e.g. to switch GitLab from HTTPS to SSH-based.

description: Configuration object for the github-actions manager

description: Display warnings about GitHub token not being set.

description: Configuration object for the gitlabci manager

description: Configuration object for the gitlabci-include manager

description: Configuration presets to use or extend for a self-hosted config.

description: Directory pattern to run `go get` on

description: Configuration object for the gomod manager

description: Configuration object for the gradle manager

description: Configuration object for the gradle-wrapper manager

description: Config if `groupName` is enabled.

description: Human understandable name for the dependency group.

description: Slug to use for group (e.g. in branch name). Slug is calculated from `groupName` if `null`.

description: If enabled, branch names will use a hashing function to ensure each branch has that length.

description: Configuration object for the helm-requirements manager

description: Configuration object for the helm-values manager

description: Configuration object for the helmfile manager

description: Configuration object for the helmsman manager

description: Configuration object for the helmv3 manager

description: Configuration object for the hermit manager

description: Configuration object for the homebrew manager

description: Host rules/configuration including credentials.

description: A list of HTTP status codes safe to ignore even when `abortOnError=true`.

description: If enabled, Renovate aborts its run when HTTP request errors occur.

description: A list of package managers to enable artifact auth. Only managers on the list are enabled. All are enabled if `null`

description: Authentication type for HTTP header. e.g. `"Bearer"` or `"Basic"`. Use `"Token-Only"` to use only the token without an authorization type.

description: Limit concurrent requests per host.

description: Enable got DNS cache.

description: Enable got HTTP/2 support.

description: hostType for a package rule. Can be a platform name or a datasource name.

description: Explicitly turn on insecure Docker registry access (HTTP).

description: Enable HTTP keepalives for hosts.

description: A domain name, host name or base URL to match against.

description: Limit requests rate per host.

description: Timeout (in milliseconds) for queries to external endpoints.

description: Configuration object for the html manager

description: Avoid upgrading from a non-deprecated version to a deprecated one.

description: Dependencies to ignore.

description: Skip any package file whose path matches one of these. Can be a string or glob pattern.

description: Set this to `true` if `allowPlugins=true` but you wish to skip running plugins when updating lock files.

description: Set to `true` to fetch the entire list of PRs instead of only those authored by the Renovate user.

description: A list of presets to ignore, including any that are nested inside an `extends` array.

description: Reviewers to be ignored in PR reviewers presence (either username or email address depending on the platform).

description: Set this to `false` if `allowScripts=true` and you wish to run scripts when updating lock files.

description: Set to `true` to enable automerging without tests.

description: Ignore versions with unstable SemVer.

description: Whether to process repositories that are mirrors. By default, repositories that are mirrors are skipped.

description: Include package files only within these defined paths.

description: Whether to consider passing internal checks such as `minimumReleaseAge` when determining branch status.

description: When and how to filter based on internal checks.

description: Configuration object for the jenkins manager

description: Configuration object for the jsonnet-bundler manager

description: Configuration object for the kotlin-script manager

description: Configuration object for the kubernetes manager

description: Configuration object for the kustomize manager

description: Labels to set in Pull Request.

description: Configuration object for the leiningen manager

description: Configuration for lock file maintenance.

description: Add a global or per-repo log context to each log entry.

description: Log file path.

description: Set the log file log level.

description: Configuration to apply when an update type is `major`.

description: Configuration object for the maven manager

description: Configuration object for the maven-wrapper manager

description: Configuration object for the meteor manager

description: Define presets here which have been removed or renamed and should be migrated automatically.

description: Time required before a new release is considered stable.

description: Configuration to apply when an update type is `minor`.

description: Configuration object for the mint manager

description: Configuration object for the mix manager

description: Configuration object for the nix manager

description: Configuration object for the nodenv manager

description: Configuration object for the npm manager

Change: [{{#if displayFrom}}`{{{displayFrom}}}` -> {{else}}{{#if currentValue}}`{{{currentValue}}}` -> {{/if}}{{/if}}{{#if displayTo}}`{{{displayTo}}}`{{else}}`{{{newValue}}}`{{/if}}]({{#if depName}}https://renovatebot.com/diffs/npm/{{replace '/' '%2f' depName}}/{{{currentVersion}}}/{{{newVersion}}}{{/if}})

description: npm token used to authenticate with the default registry.

description: String copy of `.npmrc` file. Use `\n` instead of line breaks.

description: Whether to merge `config.npmrc` with repo `.npmrc` content if both are found.

description: Configuration object for the nuget manager

description: Configuration object for the nvm manager

description: Require a Configuration PR first.

description: Change this value to override the default onboarding branch name.

description: Change this value to override the default onboarding commit message.

description: Configuration to use for onboarding PRs.

description: Change this value to override the default onboarding config file name.

description: Onboard the repository even if no dependencies are found.

description: Change this value to override the default onboarding PR title.

description: Set to enable rebase/retry markdown checkbox for onboarding PRs.

description: Set to `true` to perform a check for disabled config prior to cloning.

description: Configuration object for the osgi manager

description: Use vulnerability alerts from `osv.dev`.

description: Rules for matching packages.

description: A version range or regex pattern capturing allowed versions for dependencies.

description: If set, Renovate will use this URL to fetch changelogs for a matched dependency. Valid only within a `packageRules` object.

description: Dep names to exclude. Valid only within a `packageRules` object.

description: Dep name patterns to exclude. Valid only within a `packageRules` object.

description: Package names to exclude. Valid only within a `packageRules` object.

description: Package name patterns to exclude. Valid only within a `packageRules` object.

description: Package name prefixes to exclude. Valid only within a `packageRules` object.

description: List of repositories to exclude (e.g. `["**/*-archived"]`). Valid only within a `packageRules` object.

description: List of strings containing exact matches (e.g. `["main"]`) and/or regex expressions (e.g. `["/^release/.*/"]`). Valid only within a `packageRules` object.

description: List of categories to match (for example: `["python"]`). Valid only within a `packageRules` object.

description: Merge confidence levels to match against (`low`, `neutral`, `high`, `very high`). Valid only within `packageRules` object.

description: A regex to match against the raw `currentValue` string of a dependency. Valid only within a `packageRules` object.

description: A version or range of versions to match against the current version of a package. Valid only within a `packageRules` object.

description: List of datasources to match (e.g. `["orb"]`). Valid only within a `packageRules` object.

description: Dep names to match. Valid only within a `packageRules` object.

description: Dep name patterns to match. Valid only within a `packageRules` object.

description: List of depTypes to match (e.g. [`peerDependencies`]). Valid only within `packageRules` object.

description: List of strings to do an exact match against package and lock files with full path. Only works inside a `packageRules` object.

description: List of package managers to match (e.g. `["pipenv"]`). Valid only within a `packageRules` object.

description: Package names to match. Valid only within a `packageRules` object.

description: Package name patterns to match. Valid only within a `packageRules` object.

description: Package name prefixes to match. Valid only within a `packageRules` object.

description: List of repositories to match (e.g. `["**/*-archived"]`). Valid only within a `packageRules` object.

description: A list of source URL prefixes to match against, commonly used to group monorepos or packages from the same organization.

description: A list of source URLs to exact match against.

description: Update types to match against (`major`, `minor`, `pin`, `pinDigest`, etc). Valid only within `packageRules` object.

enum: major minor patch pin pinDigest digest lockFileMaintenance rollback bump replacement

description: The name of the new dependency that replaces the old deprecated dependency.

description: Controls what the replacement package name.

description: The version of the new dependency that replaces the old deprecated dependency.

description: Password for authentication.

description: Configuration to apply when an update type is `patch`.

description: Configuration object for the pep621 manager

description: If set to `true`: keep repository data between runs instead of deleting the data.

description: Configuration to apply when an update type is `pin`.

description: Configuration to apply when pinning a digest (no change in tag/version).

description: Whether to add digests to Dockerfile source images.

description: Configuration object for the pip-compile manager

description: Configuration object for the pip_requirements manager

description: Configuration object for the pip_setup manager

description: Configuration object for the pipenv manager

description: Platform type of repository.

enum: azure bitbucket bitbucket-server codecommit gitea github gitlab local

description: Controls if platform-native auto-merge is used.

description: Use platform API to perform commits instead of using Git directly.

description: Configuration object for the poetry manager

description: Enable post-update options to be run after package/artifact updating.

enum: bundlerConservative gomodMassage gomodTidy gomodTidy1.17 gomodTidyE gomodUpdateImportPaths helmUpdateSubChartArchives npmDedupe pnpmDedupe yarnDedupeFewer yarnDedupeHighest

description: Post-upgrade tasks that are executed before a commit is made by Renovate.

description: A list of post-upgrade commands that are executed before a commit is made by Renovate.

description: Controls when the post upgrade tasks run: on every update, or once per upgrade branch.

description: Files that match the glob pattern will be committed after running a post-upgrade task.

description: List of columns to use in PR bodies.

description: Table column definitions to use in PR tables.

description: List of extra notes or templates to include in the Pull Request body.

description: Pull Request body template. Controls which sections are rendered in the body of the pull request.

description: Set the maximum number of commits per Renovate run. By default there is no limit.

description: Limit to a maximum of x concurrent branches/PRs. 0 means no limit.

description: When to create the PR for a branch.

enum: immediate not-pending status-success approval

description: Text added here will be placed last in the PR body, with a divider separator before it.

default: This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

description: Text added here will be placed first in the PR body.

description: Rate limit PRs to maximum x created per hour. 0 means no limit.

description: Timeout in hours for when `prCreation=not-pending`.

description: Set sorting priority for PR creation. PRs with higher priority are created first, negative priority last.

description: Pull Request title template (deprecated). Inherits from `commitMessage` if null.

description: Whether to bypass appending extra context to the Pull Request title.

description: Configuration object for the pre-commit manager

prBodyNotes: Note: The `pre-commit` manager in Renovate is not supported by the `pre-commit` maintainers or community. Please do not report any problems there, instead [create a Discussion in the Renovate repository](https://github.com/renovatebot/renovate/discussions/new) if you have any questions.

description: If enabled, Renovate logs the fully resolved config for each repository, plus the fully resolved presets.

description: Server-side private key.

description: Secondary or old private key to try.

description: Path to the Server-side private key.

description: Path to the Server-side old private key.

description: Links which are used in PRs, issues and comments.

description: Set to `true` to enable branch pruning after automerging.

description: Set to `false` to disable pruning stale branches.

description: Configuration object for the pub manager

description: Configuration object for the puppet manager

description: Configuration object for the pyenv manager

description: Determines how to modify or update existing ranges.

enum: auto pin bump replace widen update-lockfile in-range-only

description: Label to request a rebase from Renovate bot.

description: Controls when Renovate rebases an existing branch.

enum: auto never conflicted behind-base-branch

description: Recreate PRs even if same ones were closed previously.

description: If set, this Redis URL will be used for caching instead of the file system.

description: Configuration object for the regex manager

description: Custom managers using regex matching.

description: Optional `extractVersion` for extracted dependencies. Valid only within a `regexManagers` object.

description: Optional `currentValue` for extracted dependencies. Valid only within a `regexManagers` object.

description: Custom manager to use. Valid only within a `regexManagers` object.

description: Optional datasource for extracted dependencies. Valid only within a `regexManagers` object.

description: Optional depName for extracted dependencies. Valid only within a `regexManagers` object.

description: Optional `depType` for extracted dependencies. Valid only within a `regexManagers` object.

description: Regex capture rule to use. Valid only within a `regexManagers` object.

description: Strategy how to interpret matchStrings.

description: Optional packageName for extracted dependencies, else defaults to `depName` value. Valid only within a `regexManagers` object.

description: Optional registry URL for extracted dependencies. Valid only within a `regexManagers` object.

description: Optional versioning for extracted dependencies. Valid only within a `regexManagers` object.

description: Aliases for registries.

description: List of URLs to try for dependency lookup. Package manager specific.

description: Configuration to apply when replacing a dependency.

commitMessageExtra: with {{newName}} {{#if isMajor}}{{{prettyNewMajor}}}{{else}}{{#if isSingleVersion}}{{{prettyNewVersion}}}{{else}}{{{newValue}}}{{/if}}{{/if}}

prBodyNotes: This is a special PR that replaces `{{{depNameSanitized}}}` with the community suggested minimal stable replacement version.

description: List of Repositories.

description: This option decides if Renovate uses a JSON cache to speed up extractions.

description: Set the type of renovate repository cache if `repositoryCache` is enabled.

description: Controls Renovate's behavior regarding repository config files such as `renovate.json`.

description: Ignore versions newer than npm "latest" version.

description: Requested reviewers for Pull Requests (either username or email address depending on the platform).

description: Determine reviewers based on configured code owners and changes in PR.

description: Take a random sample of given size from `reviewers`.

description: Configuration to apply when rolling back a version.

description: Create PRs to roll back versions if the current version is not found in the registry.

description: Configuration object for the ruby-version manager

description: Configuration object for the sbt manager

description: Limit branch creation to these times of day or week.

description: Object which holds secret name/value pairs.

description: Commit scope to use if Semantic Commits are enabled.

description: Commit type to use if Semantic Commits is enabled.

description: Enable Semantic Commit prefixes for commits and PR titles.

description: If set to `false`, Renovate will upgrade dependencies to their latest release only. Renovate will not separate major or minor branches.

description: If set to `true`, Renovate will separate `minor` and `patch` updates into separate branches.

description: If set to `true`, PRs will be raised separately for each available `major` upgrade version.

description: Configuration object for the setup-cfg manager

description: Skip installing modules/dependencies if lock file updating is possible without a full install.

description: Label to make Renovate stop updating a PR.

description: Options to suppress various types of warnings and other notifications.

enum: artifactErrors branchAutomergeFailure configErrorIssue dependencyLookupWarnings deprecationWarningIssues lockFileErrors missingCredentialsError onboardingClose prEditedNotification prIgnoreNotification

description: Configuration object for the swift manager

description: Configuration object for the tekton manager

description: Configuration object for the terraform manager

description: Configuration object for the terraform-version manager

description: Configuration object for the terragrunt manager

description: Configuration object for the terragrunt-version manager

description: Configuration object for the tflint-plugin manager

description: [IANA Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)

description: Repository Auth Token.

description: Enable remediation of transitive dependencies.

description: Configuration object for the travis manager

description: Enable or disable Unicode emoji.

description: Whether to update internal dep versions in a monorepo. Works on Lerna or Yarn Workspaces.

description: Set to `false` to disable lock file updating.

description: Whether to update branches when not scheduled. Renovate will not create branches outside of the schedule.

description: Whether to update pinned (single version) dependencies or not.

description: Whether to read configuration from `baseBranches` instead of only the default branch.

description: User-facing strings for the Renovate comment when a PR is closed.

ignoreMajor: Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for *any* future {{{newMajor}}}.x releases. But if you manually upgrade to {{{newMajor}}}.x then Renovate will re-enable `minor` and `patch` updates automatically.

ignoreDigest: Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for the `{{{depName}}}` `{{{newDigestShort}}}` update again.

ignoreOther: Because you closed this PR without merging, Renovate will ignore this update ({{{newValue}}}). You will get a PR once a newer version is released. To ignore this dependency forever, add it to the `ignoreDeps` array of your Renovate config.

description: Username for authentication.

description: Configuration object for the velaci manager

description: Versioning to use for filtering and comparisons.

enum: aws-machine-image azure-rest-api bazel-module cargo composer conan deb debian docker git go-mod-directive gradle hashicorp helm hermit hex ivy kubernetes-api loose maven nixpkgs node npm nuget pep440 perl poetry python redhat regex rez ruby semver semver-coerced swift ubuntu

description: Config to apply when a PR is needed due to a vulnerability in the existing package version.

description: Configuration object for the woodpecker manager

description: Writes discovered repositories to a JSON file and then exit.


esmrc.json

description: A boolean or object for toggling CJS features in ESM

type: boolean

type: object

description: A boolean for storing ES modules in require.cache

description: A boolean for __esModule interoperability

description: A boolean for respecting require.extensions in ESM

description: A boolean for importing named exports of CJS modules

description: A boolean for following CJS path rules in ESM

description: A boolean for __dirname, __filename, and require in ESM

description: A boolean for requiring ES modules without the dangling require().default

description: A boolean for top-level return support

type: array

description: An array of fields checked when importing a package

type: string

description: Fields from package.json

description: A string describing the mode in which to detect ESM module files

const: auto

description: 'auto' detect files with import, import.meta, export, 'use module', or .mjs as ESM

const: all

description: 'all' files besides those with 'use script' or .cjs are treated as ESM

const: strict

description: 'strict to treat only .mjs files as ESM

description: A boolean for top-level await in modules without ESM exports. (Node 10+)

description: A boolean to apply these options to all module loads

description: A boolean for WebAssembly module support. (Node 8+)

description: [dev] A boolean for toggling cache creation or a cache directory path

description: [dev] A boolean for including inline source maps

title: Configuration files for the esm module/package in Node.js


appsscript.json

title: homepage trigger

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

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

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

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

default: STABLE

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

title: dependencies

description: A list of advanced services and libraries.

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

title: advanced service

description: A single advanced service.

required: userSymbol serviceId version

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

default: Sheets

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

default: sheets

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

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

title: library

description: A single library.

required: userSymbol libraryId version

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

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

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

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

title: script

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

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

enum: MYSELF DOMAIN ANYONE ANYONE_ANONYMOUS

default: MYSELF

description: The identity under which the web app executes.

description: The location where exceptions are logged.

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

format: uri

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

format: hostname

title: api options

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

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

title: sheet manifest

description: Defines manifest values specific to Sheets.

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

title: macros

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

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

default: My Macro

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

default: myFunction

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

required: menuName functionName defaultShortcut

title: add-on manifest

description: Data Studio add-on manifest.

description: Display name for add-on.

description: URL for logo image of add-on.

description: Company name for the add-on.

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

description: Short description about the add-on.

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

description: A single source type.

title: templates

description: Map of template name to report ID.

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

description: List of AuthTypes supported.

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

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

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

required: name logoUrl company supportUrl description

title: add-ons

description: G Suite Add-ons

title: common options

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

description: The add-on name.

description: The logo URL.

title: layout options

description: Layout properties.

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

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

title: homepage trigger

description: Homepage trigger data

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

description: The name of the function to run

description: Universal add-on actions

title: actions

description: Actions

description: The action label.

description: The link's URL

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

description: Link prefixes.

description: A link prefix.

description: Use the locale from the host application?

required: logoUrl name

title: add-on metadata

description: Gmail add-on metadata.

description: Contextual triggers.

title: contextual trigger

description: A contextual trigger.

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

title: unconditional

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

title: homepage trigger

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

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

title: calendar metadata

description: Calendar add-on metadata.

title: homepage trigger

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

title: event

description: When a Calendar event is opened

description: Event hander function

title: event

description: When a Calendar event is updated

description: Event hander function

description: Handler access to Calendar event

title: add-on options

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

title: contextual trigger

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

title: JSON schema for Google Apps Script manifest files


host-meta.json

$ref: #/definitions/property

format: date-time

$ref: #/definitions/link

title: JSON schema for host-meta files


devspace-schema.json

description: Enabled can be used to enable attaching to a container

description:
DisableReplace prevents DevSpace from actually replacing the pod with modifications so that
the pod starts up correctly.

description: DisableTTY is used to tell DevSpace to not use a TTY connection for attaching

type: integer

description: Download is the download limit in kilo bytes per second

description: Upload is the upload limit in kilo bytes per second

description: BandwidthLimits defines the struct for specifying the sync bandwidth limits

$ref: #/$defs/BuildKitInClusterConfig

description: InCluster if specified, DevSpace will use BuildKit to build the image within the cluster

description: PreferMinikube if false, will not try to use the minikube docker daemon to build the image

description: Args are additional arguments to call docker buildx build with

description: Command to override the base command to create a builder and build images. Defaults to ["docker", "buildx"]

description: BuildKitConfig tells the DevSpace CLI to

description:
Name is the name of the builder to use. If omitted, DevSpace will try to create
or reuse a builder in the form devspace-$NAMESPACE

description:
Namespace where to create the builder deployment in. Defaults to the current
active namespace.

description: Rootless if enabled will create a rootless builder deployment.

description: Image is the docker image to use for the BuildKit deployment

description: NodeSelector is the node selector to use for the BuildKit deployment

description:
NoCreate. By default, DevSpace will try to create a new builder if it cannot be found.
If this is true, DevSpace will fail if the specified builder cannot be found.

description:
NoRecreate. By default, DevSpace will try to recreate the builder if the builder configuration
in the devspace.yaml differs from the actual builder configuration. If this is
true, DevSpace will not try to do that.

description:
NoLoad if enabled, DevSpace will not try to load the built image into the local docker
daemon if skip push is defined

description: CreateArgs are additional args to create the builder with.

description: BuildKitInClusterConfig holds the buildkit builder config

description: Name is the name of the helm chart to deploy. Can also be a local path or an oci url

group: repo

group_name: Source: Helm Repository

description: Version is the version of the helm chart to deploy

description: RepoURL is the url of the repo to deploy the chart from

description: Username is the username to authenticate to the chart repo. When using an OCI chart, used for registry auth

description: Password is the password to authenticate to the chart repo, When using an OCI chart, used for registry auth

description:
Path is the local path where DevSpace can find the artifact.
This option is mutually exclusive with the git option.

group: path

group_name: Source: Local Filesystem

description:
Git is the remote repository to download the artifact from. You can either use
https projects or ssh projects here, but need to make sure git can pull the project.
This option is mutually exclusive with the path option.

group: git

group_name: Source: Git Repository

description: SubPath is a path within the git repository where the artifact lies in

description: Branch is the git branch to pull

description: Tag is the tag to pull

description: Revision is the git revision to pull

description: CloneArgs are additional arguments that should be supplied to the git CLI

description:
DisableShallow can be used to turn off shallow clones as these are the default used
by devspace

description: DisablePull will disable pulling every time DevSpace is reevaluating this source

description: ChartConfig defines the helm chart options

description: Name is the name of a command that is used via `devspace run NAME`

description: Section can be used to group similar commands together in `devspace list commands`

description: Command is the command that should be executed. For example: 'echo 123'

description:
Args are optional and if defined, command is not executed within a shell
and rather directly.

description:
AppendArgs will append arguments passed to the DevSpace command automatically to
the specified command.

description: Description describes what the command is doing and can be seen in `devspace list commands`

description: Internal commands are not show in list and are usable through run_command

description:
After is executed after the command was run. It is executed also when
the command was interrupted which will set the env variable COMMAND_INTERRUPT
to true as well as when the command errored which will set the error string to
COMMAND_ERROR.

description: CommandConfig defines the command specification

description:
Command to execute to build the image. You can use ${runtime.images.my-image.image} and ${runtime.image.my-image.tag}
to reference the image and tag that should get built.

description: OnChange will determine when the command should be rerun

description: CustomConfig tells the DevSpace CLI to build with a custom build script

description: Name is used internally

description: Disabled excludes this dependency from variable resolution and pipeline runs

description: Branch is the git branch to pull

description: Tag is the tag to pull

description: Revision is the git revision to pull

description: Pipeline is the pipeline to deploy by default. Defaults to 'deploy'

default: deploy

group: execution

group_name: Execution

description: Vars are variables that should be passed to the dependency

description: OverwriteVars specifies if DevSpace should pass the parent variables to the dependency

description: IgnoreDependencies defines if dependencies of the dependency should be excluded

description: Namespace specifies the namespace this dependency should be deployed to

description: DependencyConfig defines the devspace dependency

description: Name of the deployment

description: Helm tells DevSpace to deploy this deployment via helm

description: Kubectl tells DevSpace to deploy this deployment via kubectl or kustomize

description:
UpdateImageTags lets you define if DevSpace should update the tags of the images defined in the
images section with their most recent built tag.

description: Namespace where to deploy this deployment

description: DeploymentConfig defines the configuration how the devspace should be deployed

description: Container is the container name these services should get started.

description:
Target Container architecture to use for the devspacehelper (currently amd64 or arm64). Defaults to amd64, but
devspace tries to find out the architecture by itself by looking at the node this container runs on.

description:
DevImage is the image to use for this container and will replace the existing image
if necessary.

description: Command can be used to override the entrypoint of the container

description: Args can be used to override the args of the container

description: WorkingDir can be used to override the working dir of the container

description:
Env can be used to add environment variables to the container. DevSpace will
not replace existing environment variables if an environment variable is defined here.

description: Resources can be used to override the resource definitions of the container

description: ReversePorts are port mappings to make local ports available inside the container

description: Sync allows you to sync certain local paths with paths inside the container

description: PersistPaths allows you to persist certain paths within this container with a persistent volume claim

description: Terminal allows you to tell DevSpace to open a terminal with screen support to this container

description: Logs allows you to tell DevSpace to stream logs from this container to the console

description: Attach allows you to tell DevSpace to attach to this container

description: SSH allows you to create an SSH tunnel to this container

description: ProxyCommands allow you to proxy certain local commands to the container

description:
RestartHelper holds restart helper specific configuration. The restart helper is used to delay starting of
the container and restarting it and is injected via an annotation in the replaced pod.

description: DevContainer holds options for dev services that should get started within a certain container of the selected pod

description: Name of the dev configuration

description: ImageSelector to select a pod

description: LabelSelector to select a pod

description: Namespace where to select the pod

description:
Ports defines port mappings from the remote pod that should be forwarded to your local
computer

description: PersistenceOptions are additional options for persisting paths within this pod

description: Patches are additional changes to the pod spec that should be applied

description: Open defines urls that should be opened as soon as they are reachable

description: DevPod holds configurations for selecting a pod and starting dev services for that pod

description: DisableFallback allows you to turn off kaniko building if docker isn't installed

description:
PreferMinikube allows you to turn off using the minikube docker daemon if the minikube
context is used.

description: UseCLI specifies if DevSpace should use the docker cli for building

description: Args are additional arguments to pass to the docker cli

description: DockerConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost

description: Name of the environment variable

description: Value of the environment variable

description: ReleaseName of the helm configuration

description: Chart holds the chart configuration and where DevSpace can find the chart

description: Values are additional values that should get passed to deploying this chart

description: ValuesFiles are additional files that hold values for deploying this chart

description: DisplayOutput allows you to display the helm output to the console

description: UpgradeArgs are additional arguments to pass to `helm upgrade`

description: TemplateArgs are additional arguments to pass to `helm template`

description: DisableDependencyUpdate disables helm dependencies update, default to false

description: HelmConfig defines the specific helm options used during deployment

description: Name of the image, will be filled automatically

description:
Image is the complete image name including registry and repository
for example myregistry.com/mynamespace/myimage

description:
Tags is an array that specifies all tags that should be build during
the build process. If this is empty, devspace will generate a random tag

description: Dockerfile specifies a path (relative or absolute) to the dockerfile. Defaults to ./Dockerfile.

description: Context is the context path to build with. Defaults to the current working directory

description:
Entrypoint specifies an entrypoint that will be appended to the dockerfile during
image build in memory. Example: ["sleep", "99999"]

description:
Cmd specifies the arguments for the entrypoint that will be appended
during build in memory to the dockerfile

description:
AppendDockerfileInstructions are instructions that will be appended to the Dockerfile that is build
at the current build target and are appended before the entrypoint and cmd instructions

description: BuildArgs are the build args that are to the build

description: Target is the target that should get used during the build. Only works if the dockerfile supports this

description: Network is the network that should get used to build the image

description:
RebuildStrategy is used to determine when DevSpace should rebuild an image. By default, devspace will
rebuild an image if one of the following conditions is true:
- The dockerfile has changed
- The configuration within the devspace.yaml for the image has changed
- A file within the docker context (excluding .dockerignore rules) has changed
This option is ignored for custom builds.

description:
SkipPush will not push the image to a registry if enabled. Only works if docker or buildkit is chosen
as build method

description:
CreatePullSecret specifies if a pull secret should be created for this image in the
target namespace. Defaults to true

description: BuildKit if buildKit is specified, DevSpace will build the image either in-cluster or locally with BuildKit

description: Docker if docker is specified, DevSpace will build the image using the local docker daemon

description: Kaniko if kaniko is specified, DevSpace will build the image in-cluster with kaniko

description:
Custom if custom is specified, DevSpace will build the image with the help of
a custom script.

description: Image defines the image specification

description: Enabled specifies if the given import should be enabled

description: Branch is the git branch to pull

description: Tag is the tag to pull

description: Revision is the git revision to pull

description: Import specifies the source of the devspace config to merge

description: The secret that should be mounted

description: The configMap that should be mounted

description:
Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
+optional

description:
Path within the container at which the volume should be mounted.  Must
not contain ':'.

description:
Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
+optional

description: KanikoAdditionalMount tells devspace how the additional mount of the kaniko pod should look like

description:
Name of the configmap
+optional

description:
If unspecified, each key-value pair in the Data field of the referenced
ConfigMap will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the ConfigMap,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'.
+optional

description:
Optional: mode bits to use on created files by default. Must be a
value between 0 and 0777. Defaults to 0644.
Directories within the path are not affected by this setting.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.
+optional

description: The key to project.

description:
The relative path of the file to map the key to.
May not be an absolute path.
May not contain the path element '..'.
May not start with the string '..'.

description:
Optional: mode bits to use on this file, must be a value between 0
and 0777. If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.
+optional

description:
Name of the secret in the pod's namespace to use.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+optional

description:
If unspecified, each key-value pair in the Data field of the referenced
Secret will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the Secret,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'.
+optional

description: Cache tells DevSpace if a cache repository should be used. defaults to false

description: SnapshotMode tells DevSpace which snapshot mode kaniko should use. defaults to time

description: Image is the image name of the kaniko pod to use

description: InitImage to override the init image of the kaniko pod

description: Args for additional arguments that should be passed to kaniko

description: Command to replace the starting command for the kaniko container

description: Namespace is the namespace where the kaniko pod should be run

description: Insecure allows pushing to insecure registries

description: PullSecret is the pull secret to mount by default

description: SkipPullSecretMount will skip mounting the pull secret

description: NodeSelector is the node selector to use for the kaniko pod

description: Tolerations is a tolerations list to use for the kaniko pod

description: ServiceAccount the service account to use for the kaniko pod

description: GenerateName is the optional prefix that will be set to the generateName field of the build pod

description: Annotations are extra annotations that will be added to the build pod

description: Labels are extra labels that will be added to the build pod

description: InitEnv are extra environment variables that will be added to the build init container

description:
Env are extra environment variables that will be added to the build kaniko container
Will populate the env.value field.

description:
EnvFrom are extra environment variables from configmap or secret that will be added to the build kaniko container
Will populate the env.valueFrom field.

description: AdditionalMounts are additional mounts that will be added to the build pod

description: Resources are the resources that should be set on the kaniko pod

description: KanikoConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost

description:
Manifests is a list of files or folders that will be deployed by DevSpace using kubectl
or kustomize

description: ApplyArgs are extra arguments for `kubectl apply`

description: CreateArgs are extra arguments for `kubectl create` which will be run before `kubectl apply`

description: KubectlBinaryPath is the optional path where to find the kubectl binary

description: InlineManifests is a block containing the manifest to deploy

description: Kustomize can be used to enable kustomize instead of kubectl

description: KustomizeArgs are extra arguments for `kustomize build` which will be run before `kubectl apply`

description: KustomizeBinaryPath is the optional path where to find the kustomize binary

description: KubectlConfig defines the specific kubectl options used during deployment

description:
Enabled enables the local registry for pushing images.
When unset the local registry will be used as a fallback if there are no push permissions for the registry.
When `true` the local registry will always be used.
When `false` the local registry will never be used.

description: LocalBuild enables use of local docker builder instead of building in the cluster

description: Namespace where the local registry is deployed. Default is the current context's namespace

description: Name of the deployment and service of the local registry. Default is `registry`

description: Image of the local registry. Default is `registry:2.8.1`

description: BuildKitImage of the buildkit sidecar. Default is `moby/buildkit:master-rootless`

description: Port that the registry image listens on. Default is `5000`

description: Persistence settings for the local registry

description: LocalRegistryConfig holds the configuration of the local image registry

description: Enable enables persistence for the local registry

description: Size of the persistent volume for local docker registry storage. Default is `5Gi`

description: StorageClassName of the persistent volume. Default is your cluster's configured default storage class

description: LocalRegistryPersistence configures persistence settings for the local registry

description: Enabled can be used to enable printing container logs

description: LastLines is the amount of lines to print of the running container initially

description: URL is the url to open in the browser after it is available

description: OpenConfig defines what to open after services have been started

description: Operation is the path operation to do. Can be either replace, add or remove

description: Path is the config path to apply the patch to

description: Value is the value to use for this patch.

description: PatchConfig describes a config patch and how it should be applied

description: Target describes where to apply a config patch

description: PatchTarget describes a config patch and how it should be applied

description: Size is the size of the created persistent volume in Kubernetes size notation like 5Gi

description: StorageClassName is the storage type DevSpace should use for this persistent volume

description: AccessModes are the access modes DevSpace should use for the persistent volume

description: ReadOnly specifies if the volume should be read only

description:
Name is the name of the PVC that should be created. If a PVC with that name
already exists, DevSpace will use that PVC instead of creating one.

description: PersistenceOptions are general persistence options DevSpace should use for all persistent paths within a single dev configuration

description:
Path is the container path that should get persisted. By default, DevSpace will create an init container
that will copy over the contents of this folder from the existing image.

description: VolumePath is the sub path on the volume that is mounted as persistent volume for this path

description: ReadOnly will make the persistent path read only to the user

description: SkipPopulate will not create an init container to copy over the existing contents if true

description: InitContainer holds additional options for the persistent path init container

description: PersistentPath holds options to configure persistence for DevSpace

description: Resources are the resources used by the persistent path init container

description: PersistentPathInitContainer defines additional options for the persistent path init container

description: Name of the pipeline, will be filled automatically

description: Run is the actual shell command that should be executed during this pipeline

description:
Flags are extra flags that can be used for running the pipeline via
devspace run-pipeline.

description:
ContinueOnError will not fail the whole job and pipeline if
a call within the step fails.

description: Pipeline defines what DevSpace should do.

description: Name is the name of the flag

description: Short is optional and is the shorthand name for this flag. E.g. 'g' converts to '-g'

description: Type is the type of the flag. Defaults to `bool`

description: Default is the default value for this flag

description: Description is the description as shown in `devspace run-pipeline my-pipe -h`

description: PipelineFlag defines an extra pipeline flag

description: Requests are the requests part of the resources

description: Limits are the limits part of the resources

description: PodResources describes the resources section of the started kaniko pod

description:
Port is a port mapping that maps the localPort:remotePort. So if
you port forward the remote port will be available at the local port.
If you do reverse port forwarding, the local port will be available
at the remote port in the container. If only port is specified, local and
remote port are the same.

description:
BindAddress is the address DevSpace should listen on. Optional and defaults
to localhost.

description: PortMapping defines the ports for a PortMapping

description: GitCredentials configures a git credentials helper inside the container that proxies local git credentials

description:
Command is the name of the command that should be available in the remote container. DevSpace
will create a small script for that inside the container that redirect command execution to
the local computer.

description:
LocalCommand can be used to run a different command than specified via the command option. By
default, this will be assumed to be the same as command.

description: SkipContainerEnv will not forward the container environment variables to the local command

description: Env are extra environment variables to set for the command

description: Name is the pull secret name to deploy

description:
The registry to create the image pull secret for.
Empty string == docker hub
e.g. gcr.io

description:
The username of the registry. If this is empty, devspace will try
to receive the auth data from the local docker

description:
The password to use for the registry. If this is empty, devspace will
try to receive the auth data from the local docker

description: The optional email to use

description: The secret to create

description: The service account to add the secret to

description: PullSecretConfig defines a pull secret that should be created by DevSpace

description: Name is the name of the command that should be installed

description: VersionArgs are the arguments to retrieve the version of the command

description: VersionRegEx is the regex that is used to parse the version

description: Version constraint of the command that should be installed

description: DevSpace specifies the DevSpace version constraint that is needed to use this config

description: Commands specifies an array of commands that need to be installed locally to use this config

description: Plugins specifies an array of plugins that need to be installed locally

description: Name of the plugin that should be installed

description: Version constraint of the plugin that should be installed

description:
Path defines the path to the restart helper that might be used if certain config
options are enabled

description: Inject signals DevSpace to inject the restart helper

description:
Enabled can be used to enable the ssh server within the container. By default,
DevSpace will generate the required keys and create an entry in your ~/.ssh/config
for this container that can be used via `ssh dev-config-name.dev-project-name.devspace`

description: LocalHostname is the local ssh host to write to the ~/.ssh/config

description: LocalPort is the local port to forward from, if empty will be random

description: RemoteAddress is the address to listen to inside the container

description:
UseInclude tells DevSpace to use a the file ~/.ssh/devspace_config for its ssh entries. DevSpace
will also create an import for its own entries inside ~/.ssh/config, this is a cleaner way,
but unfortunately not all SSH clients support this.

description:
Path is the path to sync. This can be defined in the form localPath:remotePath. You can also use '.'
to specify either the local or remote working directory. This is valid for example: .:.

description: ExcludePaths is an array of file patterns in gitignore format to exclude.

description: ExcludeFile loads the file patterns to exclude from a file.

description: DownloadExcludePaths is an array of file patterns in gitignore format to exclude from downloading

description: DownloadExcludeFile loads the file patterns to exclude from downloading from a file.

description: UploadExcludePaths is an array of file patterns in gitignore format to exclude from uploading

description: UploadExcludeFile loads the file patterns to exclude from uploading from a file.

description:
StartContainer will start the container after initial sync is done. This will
inject a devspacehelper into the pod and you need to define dev.*.command for
this to work.

description:
OnUpload can be used to execute certain commands on uploading either in the container or locally as
well as restart the container after a file changed has happened.

description: InitialSync defines the initial sync strategy to use when this sync starts. Defaults to mirrorLocal

description: WaitInitialSync can be used to tell DevSpace to not wait until the initial sync is done

description: InitialSyncCompareBy defines if the sync should only compare by the given type. Either mtime or size are possible

description: DisableDownload will disable downloading completely

description: DisableUpload will disable uploading completely

description:
BandwidthLimits can be used to limit the amount of bytes that are transferred by DevSpace with this
sync configuration

description: Polling will tell the remote container to use polling instead of inotify

description: NoWatch will terminate the sync after the initial sync is done

description: File signals DevSpace that this is a single file that should get synced instead of a whole directory

description: SyncConfig defines the paths for a SyncFolder

description: Name is the name to show for this exec in the logs

description:
Command is the command to execute. If no args are specified this is executed
within a shell.

description: Args are arguments to pass to the command

description: FailOnError specifies if the sync should fail if the command fails

description:
Local specifies if the command should be executed locally instead of within the
container

description:
Once executes this command only once in the container's life. Can be used to initialize
a container before starting it, but after everything was synced.

description: OnChange is an array of file patterns that trigger this command execution

description:
If true restart container will try to restart the container after a change has been made. Make sure that
images.*.injectRestartHelper is enabled for the container that should be restarted or the devspace-restart-helper
script is present in the container root folder.

description: Exec will execute the given commands in order after a sync operation

description: SyncOnUpload defines the struct for the command that should be executed when files / folders are uploaded

description: ApiVersion is the Kubernetes api of the target resource

description: Kind is the kind of the target resource (eg: Deployment, Service ...)

description: Name is the name of the target resource

description:
Command is the command that should be executed on terminal start.
This command is executed within a shell.

description: WorkDir is the working directory that is used to execute the command in.

description:
If enabled is true, DevSpace will use the terminal. Can be also
used to disable the terminal if set to false. DevSpace makes sure
that within a pipeline only one dev configuration can open a terminal
at a time and subsequent dev terminals will fail.

description:
DisableReplace tells DevSpace to not replace the pod or adjust its settings
to make sure the pod is sleeping when opening a terminal

description:
DisableScreen will disable screen which is used by DevSpace by default to preserve
sessions if connections interrupt or the session is lost.

description: DisableTTY will disable a tty shell for terminal command execution

description: Terminal describes the terminal options

required: Key Operator Value Effect TolerationSeconds

description: Name is the name of the variable

description: Value is a shortcut for using source: none and default: my-value

description: Question can be used to define a custom question if the variable was not yet used

description: Default is the default value the variable should have if not set by the user

options:
Options are options that can be selected when the variable question is asked

description: Password signals that this variable should not be visible if entered

description: ValidationPattern can be used to verify the user input

description: ValidationMessage can be used to tell the user the format of the variable value

description: NoCache can be used to prompt the user on every run for this variable

description:
Command is the command how to retrieve the variable. If args is omitted, command is parsed as a shell
command.

description: Args are optional args that will be used for the command

description:
Commands are additional commands that can be used to run a different command on a different operating
system.

description: AlwaysResolve makes sure this variable will always be resolved and not only if it is used somewhere. Defaults to false.

description: Source defines where the variable should be taken from

description: Variable describes the var definition

description:
OperatingSystem is optional and defines the operating system this
command should be executed on

description:
Command is the command to use to retrieve the value for this variable. If no
args are specified the command is run within a pseudo shell.

description: Args are optional arguments for the command

description:
Version holds the config version. DevSpace will always convert older configs to the current latest
config version, which makes it possible to use the newest DevSpace version also with older config
versions.

description:
Name specifies the name of the DevSpace project and uniquely identifies a project.
DevSpace will not allow multiple active projects with the same name in the same Kubernetes namespace.
If not provided, DevSpace will use the name of the current working directory.

description:
Imports merges specified config files into this one. This is very useful to split up your DevSpace configuration
into multiple files and reuse those through git, a remote url or common local path.

description:
Functions are POSIX functions that can be used within pipelines. Those functions can also be imported by
imports.

description:
Pipelines are the work blocks that DevSpace should execute when devspace dev, devspace build, devspace deploy or devspace purge
is called. Pipelines are defined through a special POSIX script that allows you to use special commands
such as create_deployments, start_dev, build_images etc. to signal DevSpace you want to execute
a specific functionality. The pipelines dev, build, deploy and purge are special and will override
the default functionality of the respective command if defined. All other pipelines can be either run
via the devspace run-pipeline command or used within another pipeline through run_pipelines.

description:
Images holds configuration of how DevSpace should build images. By default, DevSpace will build all defined images.
If you are using a custom pipeline, you can dynamically define which image is built at which time during the
execution.

description:
Deployments holds configuration of how DevSpace should deploy resources to Kubernetes. By default, DevSpace will deploy all defined deployments.
If you are using a custom pipeline, you can dynamically define which deployment is deployed at which time during the
execution.

description:
Dev holds development configuration. Each dev configuration targets a single pod and enables certain dev services on that pod
or even rewrites it if certain changes are requested, such as adding an environment variable or changing the entrypoint.
Dev allows you to:
- sync local folders to the Kubernetes pod
- port forward remote ports to your local computer
- forward local ports into the Kubernetes pod
- configure an ssh tunnel to the Kubernetes pod
- proxy local commands to the container
- restart the container on file changes

description: Vars are config variables that can be used inside other config sections to replace certain values dynamically

description:
Commands are custom commands that can be executed via 'devspace run COMMAND'. These commands are run within a pseudo bash
that also allows executing special commands such as run_watch or is_equal.

description:
Dependencies are sub devspace projects that lie in a local folder or remote git repository that can be executed
from within the pipeline. In contrast to imports, these projects pose as separate fully functional DevSpace projects
that typically lie including source code in a different folder and can be used to compose a full microservice
application that will be deployed by DevSpace. Each dependency name can only be used once and if you want to use
the same project multiple times, make sure to use a different name for each of those instances.

description:
PullSecrets are image pull secrets that will be created by devspace in the target namespace
during devspace dev or devspace deploy. DevSpace will merge all defined pull secrets into a single
one or the one specified.

description:
Require defines what DevSpace, plugins and command versions are required to use this config and if a condition is not
fulfilled, DevSpace will fail.

description: LocalRegistry specifies the configuration for a local image registry

description: Config defines the configuration


typingsrc.json

type: array string

description: A string or array of strings of trusted certificates in PEM format

description: Public x509 certificate to use

description: Override the default installation source (e.g., when doing 'typings install debug')

default: npm

enum: file npm github bitbucket bower http https

description: Set your GitHub for resolving 'github:' locations

description: The proxy to use for HTTP requests

description: The proxy to use for HTTPS requests

description: Private key to use for SSL

description: A string of space-separated hosts to not proxy

description: A HTTP(s) proxy URI for outgoing requests

description: Override the registry URL

description: Reject invalid SSL certificates

description: Set the User-Agent for HTTP requests

title: JSON schema for .typingsrc files