description: Specifies if declaring module exports the pipe.


key: skipTests

description: When true, does not create test files.

type: boolean


key: fileVersion

description: File format version

type: integer


key: prefix

description: The prefix to apply to generated selectors.

type: string

format: html-selector


key: root

description: Root of the project files.


key: sourceRoot

description: The root of the source files, assets and index.html file structure.


key: projectType

description: Project type.

enum: application library


description: Project i18n options

type: object

default: en-US

type: array


key: sourceLocale

description: Specifies the source locale of the application.


description: Localization options to use for the source locale


key: code

description: Specifies the locale code of the source locale


key: baseHref

description: HTML base HREF to use for the locale (defaults to the locale code)


description: Localization file to use for i18n


description: Localization files to use for i18n


description: Localization options to use for the locale


key: translation

description: Localization file to use for i18n


description: Localization files to use for i18n


key: builder

description: The builder used for this package.


key: configurations

description: A map of alternative target options.


key: appShell

description: App Shell target options for Architect.


key: browserTarget

description: Target to build.


key: serverTarget

description: Server target to use for rendering the app shell.


key: appModuleBundle

description: Script that exports the Server AppModule to render. This should be the main JavaScript outputted by the server target. By default we will resolve the outputPath of the serverTarget and find a bundle named 'main' in it (whether or not there's a hash tag).


key: route

description: The route to render.


key: inputIndexPath

description: The input path for the index.html file. By default uses the output index.html of the browser target.


key: outputIndexPath

description: The output path of the index.html file. By default will overwrite the input file.


key: browser

description: Browser target options

x-deprecated: Deprecated since 9.0.

enum: none all media bundles

type: number

enum: none anonymous use-credentials

required: glob input output

required: src replaceWith

required: replace with

enum: all allScript any anyScript anyComponentStyle bundle initial


key: assets

description: List of static application assets.


key: main

description: The name of the main entry-point file.


key: polyfills

description: The name of the polyfills file.


key: tsConfig

description: The name of the TypeScript configuration file.


key: scripts

description: Global scripts to be included in the build.


key: styles

description: Global styles to be included in the build.


key: stylePreprocessorOptions

description: Options to pass to style preprocessors.


key: includePaths

description: Paths to include. Paths will be resolved to project root.


key: optimization

description: Enables optimization of the build output.


description: Enables optimization of the scripts output.


description: Enables optimization of the styles output.


key: fileReplacements

description: Replace compilation source files with other compilation source files in the build.


key: outputPath

description: Path where output will be placed.


key: resourcesOutputPath

description: The path where style resources will be placed, relative to outputPath.


key: aot

description: Build using Ahead of Time compilation.


key: sourceMap

description: Output sourcemaps.


description: Output sourcemaps for all scripts.


description: Output sourcemaps for all styles.


key: hidden

description: Output sourcemaps used for error reporting tools.


key: vendor

description: Resolve vendor packages sourcemaps.


key: vendorChunk

description: Use a separate bundle containing only vendor libraries.


key: commonChunk

description: Use a separate bundle containing code used across multiple bundles.


key: baseHref

description: Base url for the application being built.


key: deployUrl

description: URL where files will be deployed.


key: verbose

description: Adds more details to output logging.


key: progress

description: Log progress to the console while building.


description: Localization file to use for i18n.


description: Format of the localization file specified with --i18n-file.


description: Locale to use for i18n.


key: extractCss

description: Extract css from global styles onto css files instead of js ones.


key: watch

description: Run build when files change.


key: outputHashing

description: Define the output filename cache-busting hashing mode.


key: poll

description: Enable and define the file watching poll time period in milliseconds.


key: deleteOutputPath

description: Delete the output path before building.


key: preserveSymlinks

description: Do not use the real path when resolving modules.


key: extractLicenses

description: Extract all licenses in a separate file, in the case of production builds only.


key: showCircularDependencies

description: Show circular dependency warnings on builds.


key: buildOptimizer

description: Enables @angular-devkit/build-optimizer optimizations when using the 'aot' option.


key: namedChunks

description: Use file name for lazy loaded chunks.


key: subresourceIntegrity

description: Enables the use of subresource integrity validation.


key: serviceWorker

description: Generates a service worker config for production builds.


key: ngswConfigPath

description: Path to ngsw-config.json.


key: index

description: Configures the generation of the application's HTML index.


description: The path of a file to use for the application's HTML index. The filename of the specified path will be used for the generated file and will be created in the root of the application's configured output path.


key: input

description: The path of a file to use for the application's generated HTML index.


key: output

description: The output path of the application's generated HTML index file. The full provided path will be used and will be considered relative to the application's configured output path.


key: statsJson

description: Generates a 'stats.json' file which can be analyzed using tools such as 'webpack-bundle-analyzer'.


key: forkTypeChecker

description: Run the TypeScript type checker in a forked process.


key: lazyModules

description: List of additional NgModule files that will be lazy loaded. Lazy router modules with be discovered automatically.


key: budgets

description: Budget thresholds to ensure parts of your application stay within boundaries which you set.


key: rebaseRootRelativeCssUrls

description: Change root relative URLs in stylesheets to include base HREF and deploy URL. Use only for compatibility and transition. The behavior of this option is non-standard and will be removed in the next major release.


key: webWorkerTsConfig

description: TypeScript configuration for Web Worker modules.


key: crossOrigin

description: Define the crossorigin attribute setting of elements that provide CORS support.


key: experimentalRollupPass

description: Concatenate modules with Rollup before bundling them with Webpack.


key: allowedCommonJsDependencies

description: A list of CommonJS packages that are allowed to be used without a build time warning.


key: glob

description: The pattern to match.


description: The input path dir in which to apply 'glob'. Defaults to the project root.


description: Absolute path within the output.


key: ignore

description: An array of globs to ignore.


key: assetPattern

description: The file to include.


description: The file to include.


key: bundleName

description: The bundle name for this extra entry point.


key: lazy

description: If the bundle will be lazy loaded.


key: inject

description: If the bundle will be referenced in the HTML file.


key: extraEntryPoint

description: The file to include.


key: type

description: The type of budget.


key: name

description: The name of the bundle.


key: baseline

description: The baseline size for comparison.


key: maximumWarning

description: The maximum threshold for warning relative to the baseline.


key: maximumError

description: The maximum threshold for error relative to the baseline.


key: minimumWarning

description: The minimum threshold for warning relative to the baseline.


key: minimumError

description: The minimum threshold for error relative to the baseline.


key: warning

description: The threshold for warning relative to the baseline (min & max).


key: error

description: The threshold for error relative to the baseline (min & max).


key: devServer

description: Dev Server target options for Architect.

default: localhost

alias: o


key: browserTarget

description: Target to serve.


key: port

description: Port to listen on.


key: host

description: Host to listen on.


key: proxyConfig

description: Proxy configuration file.


key: ssl

description: Serve using HTTPS.


key: sslKey

description: SSL key to use for serving HTTPS.


key: sslCert

description: SSL certificate to use for serving HTTPS.


key: open

description: When true, open the live-reload URL in default browser.


key: liveReload

description: When true, reload the page on change using live-reload.


key: publicHost

description: The URL that the browser client (or live-reload client, if enabled) should use to connect to the development server. Use for a complex dev server setup, such as one with reverse proxies.


key: allowedHosts

description: List of hosts that are allowed to access the dev server.


key: servePath

description: The pathname where the app will be served.


key: disableHostCheck

description: When true, don't verify that connected clients are part of allowed hosts.


key: hmr

description: When true, enable hot module replacement.


key: watch

description: When true, rebuild on change.


key: hmrWarning

description: When true, show a warning when the --hmr option is enabled.


key: servePathDefaultWarning

description: When true, show a warning when deploy-url/base-href use unsupported serve path values.


key: optimization

description: Enable optimization of the build output.


key: scripts

description: When true, enable optimization of the scripts output.


key: styles

description: When true, enable optimization of the styles output.


key: aot

description: Build using ahead-of-time compilation.


key: sourceMap

description: When true, output sourcemaps.


description: When true, output sourcemaps for all scripts.


description: When true, output sourcemaps for all styles.


key: vendor

description: When true, resolve vendor packages sourcemaps.


key: vendorChunk

description: When true, use a separate bundle containing only vendor libraries.


key: commonChunk

description: When true, use a separate bundle containing code used across multiple bundles.


key: baseHref

description: Base url for the application being built.


key: deployUrl

description: URL where files will be deployed.


key: verbose

description: When true, add more details to output logging.


key: progress

description: When true, log progress to the console while building.


description: Extract i18n target options for Architect.

default: xlf

enum: xmb xlf xlif xliff xlf2 xliff2

x-deprecated: Use 'format' option instead.

x-deprecated: Use 'i18n' project level sub-option 'sourceLocale' instead.


key: browserTarget

description: Target to extract from.


key: format

description: Output format for the generated file.


description: Output format for the generated file.


description: Specifies the source language of the application.


key: ivy

description: Use Ivy compiler to extract translations.


description: Log progress to the console.


key: outputPath

description: Path where output will be placed.


key: outFile

description: Name of the file to output.


key: karma

description: Karma target options for Architect.


key: main

description: The name of the main entry-point file.


key: tsConfig

description: The name of the TypeScript configuration file.


key: karmaConfig

description: The name of the Karma configuration file.


key: polyfills

description: The name of the polyfills file.


key: assets

description: List of static application assets.


key: scripts

description: Global scripts to be included in the build.


key: styles

description: Global styles to be included in the build.


key: stylePreprocessorOptions

description: Options to pass to style preprocessors


key: includePaths

description: Paths to include. Paths will be resolved to project root.


key: environment

description: Defines the build environment.


key: sourceMap

description: Output sourcemaps.


description: Output sourcemaps for all scripts.


description: Output sourcemaps for all styles.


key: vendor

description: Resolve vendor packages sourcemaps.


key: progress

description: Log progress to the console while building.


key: watch

description: Run build when files change.


key: poll

description: Enable and define the file watching poll time period in milliseconds.


key: preserveSymlinks

description: Do not use the real path when resolving modules.


key: browsers

description: Override which browsers tests are run against.


key: codeCoverage

description: Output a code coverage report.


key: codeCoverageExclude

description: Globs to exclude from code coverage.


key: fileReplacements

description: Replace compilation source files with other compilation source files in the build.


key: reporters

description: Karma reporters to use. Directly passed to the karma runner.


key: webWorkerTsConfig

description: TypeScript configuration for Web Worker modules.


key: glob

description: The pattern to match.


key: input

description: The input path dir in which to apply 'glob'. Defaults to the project root.


key: output

description: Absolute path within the output.


key: ignore

description: An array of globs to ignore.


key: assetPattern

description: The file to include.


description: The file to include.


key: bundleName

description: The bundle name for this extra entry point.


key: lazy

description: If the bundle will be lazy loaded.


key: inject

description: If the bundle will be referenced in the HTML file.


key: extraEntryPoint

description: The file to include.


key: protractor

description: Protractor target options for Architect.


key: protractorConfig

description: The name of the Protractor configuration file.


key: devServerTarget

description: Dev server target to run tests against.


key: grep

description: Execute specs whose names match the pattern, which is internally compiled to a RegExp.


key: invertGrep

description: Invert the selection specified by the 'grep' option.


key: specs

description: Override specs in the protractor config.


key: items

description: Spec name.


key: suite

description: Override suite in the protractor config.


key: webdriverUpdate

description: Try to update webdriver.


key: serve

description: Compile and Serve the app.


key: port

description: The port to use to serve the application.


key: host

description: Host to listen on.


key: baseUrl

description: Base URL for protractor to connect to.


key: main

description: The name of the main entry-point file.


key: tsConfig

description: The name of the TypeScript configuration file.


key: stylePreprocessorOptions

description: Options to pass to style preprocessors


key: includePaths

description: Paths to include. Paths will be resolved to project root.


key: optimization

description: Enables optimization of the build output.


key: scripts

description: Enables optimization of the scripts output.


key: styles

description: Enables optimization of the styles output.


key: fileReplacements

description: Replace compilation source files with other compilation source files in the build.


key: outputPath

description: Path where output will be placed.


key: resourcesOutputPath

description: The path where style resources will be placed, relative to outputPath.


key: sourceMap

description: Output sourcemaps.


description: Output sourcemaps for all scripts.


description: Output sourcemaps for all styles.


key: hidden

description: Output sourcemaps used for error reporting tools.


key: vendor

description: Resolve vendor packages sourcemaps.


key: verbose

description: Adds more details to output logging.


key: progress

description: Log progress to the console while building.


description: Localization file to use for i18n.

x-deprecated: Deprecated since 9.0


description: Format of the localization file specified with --i18n-file.


description: Locale to use for i18n.


key: outputHashing

description: Define the output filename cache-busting hashing mode.


key: deleteOutputPath

description: delete-output-path


key: preserveSymlinks

description: Do not use the real path when resolving modules.


key: extractLicenses

description: Extract all licenses in a separate file, in the case of production builds only.


key: showCircularDependencies

description: Show circular dependency warnings on builds.


key: namedChunks

description: Use file name for lazy loaded chunks.


key: bundleDependencies

description: Available on server platform only. Which external dependencies to bundle into the module. By default, all of node_modules will be bundled.


key: externalDependencies

description: Exclude the listed external dependencies from being bundled into the bundle. Instead, the created bundle relies on these dependencies to be available during runtime.


key: statsJson

description: Generates a 'stats.json' file which can be analyzed using tools such as 'webpack-bundle-analyzer'.


key: forkTypeChecker

description: Run the TypeScript type checker in a forked process.


key: lazyModules

description: List of additional NgModule files that will be lazy loaded. Lazy router modules with be discovered automatically.


key: tslint

description: TSlint target options for Architect.

default: stylish

enum: checkstyle codeFrame filesList json junit msbuild pmd prose stylish tap verbose vso


key: tslintConfig

description: The name of the TSLint configuration file.


key: tsConfig

description: The name of the TypeScript configuration file.


key: fix

description: Fixes linting errors (may overwrite linted files).


key: typeCheck

description: Controls the type check for linting.


key: force

description: Succeeds even if there was linting errors.


key: silent

description: Show output text.


key: format

description: Output format (prose, json, stylish, verbose, pmd, msbuild, checkstyle, vso, fileslist, codeFrame).


key: exclude

description: Files to exclude from linting.


key: files

description: Files to include in linting.


key: missingTranslation

description: How to handle missing translations for i18n.

enum: warning error ignore

default: warning


key: localize

description: Translate all locales.


description: List of locales ID's to translate.


description: A ML briefcase schema

default: devicecode

default: serviceprincipal

default: keyvault

default: key

enum: key sas


key: name

description: The name of this resource


key: credentialprovider

description: Name of the credential provider to be used.


key: metadata

description: Allows to attach user-definied metadata to resources


key: key

description: Overrides the key to lookup the value for the property.


key: tenantid

description: Azure tenant id (a GUID)


description: AWS Boto3


Region name


AWS Access Key ID


key: azure

description: Azure services


key: auth

description: Azure authentication services


key: devicecode

description: Azure Device Code authentication


key: items

description: Azure Device Code authentication. Prompts the user with a URL.


key: managedserviceidentity

description: Azure Managed Service Idenity


description: Azure Managed Service Identity (https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview)


key: serviceprincipal

description: Azure Service Princiapl


description: Azure Service Principal


key: clientid

description: TODO The client id (a guid)


key: subscription

description: Azure Subscription


description: Azure Subscription


key: id

description: Azure subscription id (e.g. guids)


key: ids

description: List of Azure subscription ids (e.g. guids)


key: keyvault

description: Azure KeyVaults


description: Azure KeyVault https://docs.microsoft.com/en-us/azure/key-vault


key: dnsname

description: DNS for the Azure KeyVault instance


key: credential

description: Name of credential resource. E.g. device code or service principal resource


key: cognitiveservice

description: Azure Cognitive Services


key: anomalydetection

description: Azure Cognitive Service Anomaly Detection


description: Azure Cognitive Service Anomaly Detection (https://docs.microsoft.com/en-us/azure/cognitive-services/anomaly-detector/)


key: url

description: End point URL for Azure Cognitive Service


key: contentmoderator

description: Azure Cognitive Service Content Moderator


key: face

description: Azure Cognitive Service Face


description: Azure Cognitive Service Face (https://azure.microsoft.com/en-us/services/cognitive-services/face/)


key: spellcheck

description: Azure Cognitive Service Spell Checker


description: Azure Cognitive Service Spell Checker


key: textanalytics

description: Azure Cognitive Service Text Analytics


key: items

description: Azure Cognitive Service Text Analytics


key: vision

description: Azure Cognitive Service Vision


description: Azure Cognitive Service Vision


key: storage

description: Azure Storage Services


key: account

description: Azure Storage Account


description: Azure Storage Account


key: accountname

description: Azure blob account name


key: accountkey

description: Azure blob account key


key: secrettype

description: Is the secret a key or SAS token


key: blob

description: Azure Blob Storage


description: Azure Blob Storage


description: URL to Azure blob


description: Name of Azure Storage account resource object


key: containername

description: Name of container


key: path

description: Path to blob


key: amazon

description: Amazon Web Services (AWS)


description: AWS Rekognition services


description: AWS Rekognition services


key: google

description: Google Cloud Platform services


key: language

description: Google NER service


key: video

description: Google video intelligence for content moderation annotation


description: Google Face Detect SDK


key: clarifai

description: ClarifAI Services


key: moderation

description: Clarifai Moderation image SDK


description: Clarifai Moderation image SDK


key: python

description: Python specific resources


key: jupyterlabCredentialProvider

description: JupyterLab Credential Provider


key: env

description: Environment variable Credential Provider


key: dotenv

description: .env file Credential Provider


key: keyring

description: Python KeyRing Credential Provider (https://pypi.org/project/keyring)


Service name used when calling get_password


key: sqlalchemy

description: Python SQL Alchemy (https://www.sqlalchemy.org/)


key: drivername

description: the name of the database backend. This name will correspond to a module in sqlalchemy/databases or a third party plug-in.


key: username

description: The user name.


key: host

description: The name of the host.


key: port

description: The port number.


key: database

description: The database name.


key: query

description: A dictionary of options to be passed to the dialect and/or the DBAPI upon connect.


description: JSON Schema for Jovo language Models (https://www.jovo.tech/docs/model)

required: name phrases

required: name type

type: string object

required: name samples


description: JSON Schema for Grafana 5.x Dashboards (https://grafana.com/docs/grafana/latest/reference/dashboard/#dashboard-json)


key: id

description: unique numeric identifier for the dashboard. (generated by the db)


key: uid

description: unique dashboard identifier that can be generated by anyone. string (8-40)


key: title

description: current title of dashboard


key: tags

description: tags associated with dashboard, an array of strings


key: style

description: theme of dashboard, i.e. dark or light


key: timezone

description: timezone of dashboard, i.e. utc or browser


key: editable

description: whether a dashboard is editable or not


key: graphTooltip

description: 0 for no shared crosshair or tooltip (default), 1 for shared crosshair, 2 for shared crosshair AND shared tooltip


key: panels

description: Panels are the building blocks of a dashboard. It consists of data source queries, type of graphs, aliases, etc. Panel JSON consists of an array of JSON objects, each representing a different panel. Most of the fields are common for all panels but some fields depend on the panel type.


key: gridPos

description: The gridPos property describes the panel size and position in grid coordinates.


key: x

description: The x position, in same unit as w.


key: y

description: The y position, in same unit as h.


key: w

description: 1-24 (the width of the dashboard is divided into 24 columns)


key: h

description: In grid height units, each represents 30 pixels.


key: time

description: time range for dashboard, i.e. last 6 hours, last 7 days, etc


key: timepicker

description: timepicker metadata


key: collapse

description: whether timepicker is collapsed or not


key: enable

description: whether timepicker is enabled or not


key: templating

description: templating metadata


description: whether templating is enabled or not


key: list

description: an array of objects each representing one template variable


key: allFormat

description: format to use while fetching all values from data source, eg: wildcard, glob, regex, pipe, etc.


key: current

description: shows current selected variable text/value on the dashboard


key: datasource

description: shows data source for the variables


key: includeAll

description: whether all value option is available or not


key: multi

description: whether multiple values can be selected or not from variable value list


key: multiFormat

description: format to use while fetching timeseries from data source


key: name

description: name of variable


key: options

description: array of variable text/value pairs available for selection on dashboard


key: query

description: data source query used to fetch values for a variable


key: type

description: type of variable, i.e. custom, query or interval


key: annotations

description: annotations metadata


key: refresh

description: auto-refresh interval


key: schemaVersion

description: version of the JSON schema (integer), incremented each time a Grafana update brings changes to said schema


key: version

description: version of the dashboard (integer), incremented each time the dashboard is updated


description: A package recipe for webman

required: os arch

const: github-release

const: arch-linux-community

const: gitea-release

enum: win macos linux


key: tagline

description: Package tagline


key: about

description: Package description


description: Installation notes for this package


description: Removal notes for this package


description: URL for information/documentation


description: URL for releases


description: Base URL for downloading


description: Git username


description: Git repository


description: Gitea URL


description: Source URL


description: Filename format


description: Version format


description: Strategy for resolving latest release


description: Force latest release


description: Allow pre-releases


description: Arch Linux package name


description: OS mappings


description: Architecture mappings


key: ignore

description: Ignore mappings


key: os

description: Operating system


key: arch

description: Architecture


description: OS mapping


description: Extraction has root directory, generally the same name as the archive


description: Download is a raw binary


description: Override for the global filename format


key: renames

description: List of from-to pairs for renaming links to binaries


key: from

description: string to replace


key: to

description: string to insert


description: Installation notes for this OS


description: Removal notes for this OS


key: script

description: Path of the script to launch


key: name

description: Process name in the process list. Defaults to script filename without the extension (app for app.js)


key: cwd

description: Current working directory to start the process with. Defaults to CWD of the current environment (from your shell)


key: args

description: Arguments to pass to the script


key: interpreter

description: Interpreter absolute path. Defaults to node


description: Options to pass to the interpreter


description: File path for stderr (each line is appended to this file)


description: File path for stdout (each line is appended to this file)


description: If set to true, avoid to suffix logs file with the process id


description: Alias to combine_logs


description: File path where the pid of the started process is written by pm2. Defaults to ~/.pm2/pids/app_name-id.pid


description: Disable all logs storage


description: Define a specific log output type


description: Format for log timestamps in moment.js format (eg YYYY-MM-DD HH:mm Z)


key: env

description: Specify environment variables to be injected


description: Specify environment variables to be injected (when passing --env)


description: Restart the app if an amount of memory is exceeded (format: /0-9?/ K for KB, 'M' for MB, 'G' for GB, default to B)


description: Time in ms to wait before restarting a crashing app


description: Enable or disable the source map support


description: Make the process wait for a process.send('ready')


key: instances

description: Number of instances to be started in cluster mode


description: Time in ms before sending the final SIGKILL signal after SIGINT


description: Time in ms before forcing a reload if app is still not listening/has still not sent ready


description: A cron pattern to restart your app


key: vizion

description: Enable or disable the versioning metadatas (vizion library)


key: autorestart

description: Enable or disable auto restart after process failure


key: watch

description: Enable or disable the watch mode


description: List of paths to ignore (regex)


description: Object that will be used as an options with chokidar (refer to chokidar documentation)


description: Minimum uptime of the app to be considered started (format is /[0-9]+(h|m|s)?/, for hours, minutes, seconds, default to ms)


description: Number of times a script is restarted when it exits in less than min_uptime


description: Set the execution mode

enum: fork cluster

default: fork


key: force

description: Start a script even if it is already running (only the script path is considered)


description: Append the environment name to the app name


description: List of commands executed after a pull/upgrade operation performed from Keymetrics dashboard


description: Shutdown an application with process.send('shutdown') instead of process.kill(pid, SIGINT)


key: trace

description: Enable or disable the transaction tracing


description: Specify the name of an environment variable to inject which increments for each cluster


description: Rename the NODE_APP_INSTANCE environment variable. Defaults to NODE_APP_INSTANCE


description: Excludes global variables starting with "REACT_" and will not allow their penetration into the cluster


key: pmx

description: Enable or disable apm wrapping


key: automation

description: Enable or disable apm wrapping


key: treekill

description: Only kill the main process, not detached children


key: port

description: Shortcut to inject a PORT environment variable


key: uid

description: Set user id. Defaults to current user uid


key: gid

description: Set group id. Defaults to current user gid


description: Specify environment variables to be injected when using --env


key: key

description: SSH key path. Defaults to $HOME/.ssh


key: user

description: SSH user


key: host

description: SSH host


description: SSH options with no command-line flag, see 'man ssh'


key: ref

description: GIT remote/branch


key: repo

description: GIT remote


key: path

description: path in the server


key: pre-setup

description: Pre-setup command or path to a script on your local machine


key: post-setup

description: Post-setup commands or path to a script on the host machine


key: pre-deploy-local

description: pre-deploy action


key: post-deploy

description: post-deploy action


key: apps

description: The apps property is an array of object where each object contains the configuration for each process.


key: deploy

description: The deploy property is an object where each of its properties is an object which defines a deployment environment.


key: manifest

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


key: system

description: The game system name which this world relies upon


key: background

description: A web URL or local file path which provides a background banner image


key: coreVersion

description: The version of the core software for which this world has been migrated


key: systemVersion

description: The version of the game system for which this world has been migrated


key: nextSession

description: An ISO datetime string when the next game session is scheduled to occur


key: resetKeys

description: Should user access keys be reset as part of the next launch?


key: safeMode

description: Should the world launch in safe mode?


key: webJobName

description: The name of the Azure Webjob.


key: startTime

description: The start time of a scheduled job. Example. 2014-06-11T00:00:00-08:00

format: date-time


key: endTime

description: The end time of a scheduled job. Example. 2014-06-12T00:00:00-08:00


key: jobRecurrenceFrequency

description: The frequency metric used with the 'interval' property.

enum: Second Minute Hour Day Week Month


key: interval

description: The interval of how often the Azure Webjob should run. Use it with the 'jobRecurrenceFrequency' property.


key: runMode

description:
Determines the run mode of the Azure Webjob.

 Triggered: manually triggered
 Scheduled: runs on a specific schedule
 Continuous: runs all the time


enum: Continuous OnDemand


description: Pants configuration file schema: https://www.pantsbuild.org/

default: fetch

enum: fetch validate defer

default: indicatif-spinner

enum: indicatif-spinner experimental-prodash

default: never

enum: always on_failure never

default: info

enum: trace debug info warn error

default: pants

default: <buildroot>/dist

default: .*/ /dist/ __pycache__

default: #cores

default: backoff

enum: ignore first_only backoff

default: {'user-agent': 'pants/<pants_version>'}

default: max(2, #cores/2)

default: debug

default: warn

enum: ignore warn error

default: error

default: / src src/python src/py src/thrift src/protobuf src/protos src/scala src/java


key: GLOBAL

description: Options to control the overall behavior of Pants.


description:
Register functionality from these backends
https://www.pantsbuild.org/v2.16/docs/reference-global#backend_packages


description:
Python files to evaluate and whose symbols should be exposed to all BUILD files
https://www.pantsbuild.org/v2.16/docs/reference-global#build_file_prelude_globs


description:
Path globs or literals to ignore when identifying BUILD files
https://www.pantsbuild.org/v2.16/docs/reference-global#build_ignore


description:
The naming scheme for BUILD files, i.e. where you define targets
https://www.pantsbuild.org/v2.16/docs/reference-global#build_patterns


description:
Path to a file containing PEM-format CA certificates used for verifying secure connections when downloading files required by a build
https://www.pantsbuild.org/v2.16/docs/reference-global#ca_certs_path


description:
Controls how the content of cache entries is handled during process execution
https://www.pantsbuild.org/v2.16/docs/reference-global#cache_content_behavior


key: colors

description:
Whether Pants should use colors in output or not
https://www.pantsbuild.org/v2.16/docs/reference-global#colors


key: concurrent

description:
Enable concurrent runs of Pants
https://www.pantsbuild.org/v2.16/docs/reference-global#concurrent


description:
If true, `docker_environment` targets can be used to run builds inside a Docker container
https://www.pantsbuild.org/v2.16/docs/reference-global#docker_execution


description:
Display a dynamically-updating console UI as Pants runs
https://www.pantsbuild.org/v2.16/docs/reference-global#dynamic_ui


description:
If `--dynamic-ui` is enabled, selects the renderer
https://www.pantsbuild.org/v2.16/docs/reference-global#dynamic_ui_renderer


A directory to write execution and rule graphs to as `dot` files
https://www.pantsbuild.org/v2.16/docs/reference-global#engine_visualize_to


description:
Ignore logs and warnings matching these strings
https://www.pantsbuild.org/v2.16/docs/reference-global#ignore_warnings


description:
Controls whether Pants will clean up local directories used as chroots for running processes
https://www.pantsbuild.org/v2.16/docs/reference-global#keep_sandboxes


key: level

description:
Set the logging level
https://www.pantsbuild.org/v2.16/docs/reference-global#level


description:
Whether to cache process executions in a local cache persisted to disk at `--local-store-dir`
https://www.pantsbuild.org/v2.16/docs/reference-global#local_cache


description:
Directory to use for local process execution sandboxing
https://www.pantsbuild.org/v2.16/docs/reference-global#local_execution_root_dir


description:
Directory to use for the local file store, which stores the results of subprocesses run by Pants
https://www.pantsbuild.org/v2.16/docs/reference-global#local_store_dir


description:
The maximum size in bytes of the local store containing directories
https://www.pantsbuild.org/v2.16/docs/reference-global#local_store_directories_max_size_bytes


description:
The maximum size in bytes of the local store containing files
https://www.pantsbuild.org/v2.16/docs/reference-global#local_store_files_max_size_bytes


description:
The maximum size in bytes of the local store containing process cache entries
https://www.pantsbuild.org/v2.16/docs/reference-global#local_store_processes_max_size_bytes


description:
The number of LMDB shards created for the local store
https://www.pantsbuild.org/v2.16/docs/reference-global#local_store_shard_count


description:
Set a more specific logging level for one or more logging targets
https://www.pantsbuild.org/v2.16/docs/reference-global#log_levels_by_target


description:
Whether to show/hide logging done by 3rdparty Rust crates used by the Pants engine
https://www.pantsbuild.org/v2.16/docs/reference-global#log_show_rust_3rdparty


key: logdir

description:
Write logs to files under this directory
https://www.pantsbuild.org/v2.16/docs/reference-global#logdir


key: loop

description:
Run goals continuously as file changes are detected
https://www.pantsbuild.org/v2.16/docs/reference-global#loop


description:
The maximum number of times to loop when `--loop` is specified
https://www.pantsbuild.org/v2.16/docs/reference-global#loop_max


description:
Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches
https://www.pantsbuild.org/v2.16/docs/reference-global#named_caches_dir


description:
The name of the script or binary used to invoke Pants
https://www.pantsbuild.org/v2.16/docs/reference-global#pants_bin_name


description:
Paths to Pants config files
https://www.pantsbuild.org/v2.16/docs/reference-global#pants_config_files


description:
Write end products, such as the results of `pants package`, to this dir
https://www.pantsbuild.org/v2.16/docs/reference-global#pants_distdir


description:
Paths to ignore for all filesystem operations performed by pants (e.g
https://www.pantsbuild.org/v2.16/docs/reference-global#pants_ignore


description:
Make use of a root .gitignore file when determining whether to ignore filesystem operations performed by Pants
https://www.pantsbuild.org/v2.16/docs/reference-global#pants_ignore_use_gitignore


description:
When set, a base directory in which to store `--pants-workdir` contents
https://www.pantsbuild.org/v2.16/docs/reference-global#pants_physical_workdir_base


description:
The directory to use for tracking subprocess metadata
https://www.pantsbuild.org/v2.16/docs/reference-global#pants_subprocessdir


description:
Use this Pants version
https://www.pantsbuild.org/v2.16/docs/reference-global#pants_version


description:
Write intermediate logs and output files to this dir
https://www.pantsbuild.org/v2.16/docs/reference-global#pants_workdir


key: pantsd

description:
Enables use of the Pants daemon (pantsd). pantsd can significantly improve runtime performance by lowering per-run startup cost, and by memoizing filesystem operations and rule execution
https://www.pantsbuild.org/v2.16/docs/reference-global#pantsd


description:
Filesystem events matching any of these globs will trigger a daemon restart
https://www.pantsbuild.org/v2.16/docs/reference-global#pantsd_invalidation_globs


The maximum memory usage of the pantsd process
https://www.pantsbuild.org/v2.16/docs/reference-global#pantsd_max_memory_usage


description:
The port to bind the Pants nailgun server to
https://www.pantsbuild.org/v2.16/docs/reference-global#pantsd_pailgun_port


description:
The maximum amount of time to wait for the invocation to start until raising a timeout exception
https://www.pantsbuild.org/v2.16/docs/reference-global#pantsd_timeout_when_multiple_invocations


key: pantsrc

description:
Use pantsrc files located at the paths specified in the global option `pantsrc_files`
https://www.pantsbuild.org/v2.16/docs/reference-global#pantsrc


description:
Override config with values from these files, using syntax matching that of `--pants-config-files`
https://www.pantsbuild.org/v2.16/docs/reference-global#pantsrc_files


key: plugins

description:
Allow backends to be loaded from these plugins (usually released through PyPI). The default backends for each plugin will be loaded automatically
https://www.pantsbuild.org/v2.16/docs/reference-global#plugins


description:
Re-resolve plugins, even if previously resolved
https://www.pantsbuild.org/v2.16/docs/reference-global#plugins_force_resolve


description:
Print the full exception stack trace for any errors
https://www.pantsbuild.org/v2.16/docs/reference-global#print_stacktrace


description:
The cache namespace for process execution
https://www.pantsbuild.org/v2.16/docs/reference-global#process_execution_cache_namespace


description:
The time in seconds to wait when gracefully shutting down an interactive process (such as one opened using `pants run`) before killing it
https://www.pantsbuild.org/v2.16/docs/reference-global#process_execution_graceful_shutdown_timeout


description:
Whether or not to use nailgun to run JVM requests that are marked as supporting nailgun
https://www.pantsbuild.org/v2.16/docs/reference-global#process_execution_local_enable_nailgun


description:
Number of concurrent processes that may be executed locally
https://www.pantsbuild.org/v2.16/docs/reference-global#process_execution_local_parallelism


description:
Number of concurrent processes that may be executed remotely
https://www.pantsbuild.org/v2.16/docs/reference-global#process_execution_remote_parallelism


The default memory usage for a single "pooled" child process
https://www.pantsbuild.org/v2.16/docs/reference-global#process_per_child_memory_usage


The maximum memory usage for all "pooled" child processes
https://www.pantsbuild.org/v2.16/docs/reference-global#process_total_child_memory_usage


key: pythonpath

description:
Add these directories to PYTHONPATH to search for plugins
https://www.pantsbuild.org/v2.16/docs/reference-global#pythonpath


description:
Path to a PEM file containing CA certificates used for verifying secure connections to `[GLOBAL].remote_execution_address` and `[GLOBAL].remote_store_address`
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_ca_certs_path


description:
Whether to enable reading from a remote cache
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_cache_read


description:
The number of concurrent requests allowed to the remote cache service
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_cache_rpc_concurrency


description:
Timeout value for remote cache RPCs in milliseconds
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_cache_rpc_timeout_millis


description:
How frequently to log remote cache failures at the `warn` log level
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_cache_warnings


description:
Whether to enable writing results to a remote cache
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_cache_write


description:
Enables remote workers for increased parallelism. (Alpha)
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_execution


description:
The URI of a server used as a remote execution scheduler
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_execution_address


description:
Sets the base path to use when setting up an append-only cache for a process running remotely
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_execution_append_only_caches_base_path


description:
Platform properties to set on remote execution requests
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_execution_extra_platform_properties


description:
Headers to set on remote execution requests
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_execution_headers


description:
Overall timeout in seconds for each remote execution request from time of submission
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_execution_overall_deadline_secs


description:
The number of concurrent requests allowed to the remote execution service
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_execution_rpc_concurrency


description:
Name of the remote instance to use by remote caching and remote execution
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_instance_name


description:
Path to a file containing an oauth token to use for gGRPC connections to `[GLOBAL].remote_execution_address` and `[GLOBAL].remote_store_address`
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_oauth_bearer_token_path


description:
The URI of a server used for the remote file store
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_store_address


description:
The maximum total size of blobs allowed to be sent in a single batch API call to the remote store
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_store_batch_api_size_limit


description:
Size in bytes of chunks transferred to/from the remote file store
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_store_chunk_bytes


description:
Headers to set on remote store requests
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_store_headers


description:
The number of concurrent requests allowed to the remote store service
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_store_rpc_concurrency


description:
Number of times to retry any RPC to the remote store before giving up
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_store_rpc_retries


description:
Timeout value for remote store RPCs (not including streaming requests) in milliseconds
https://www.pantsbuild.org/v2.16/docs/reference-global#remote_store_rpc_timeout_millis


description:
The number of threads to keep active and ready to execute `@rule` logic (see also: `--rule-threads-max`)
https://www.pantsbuild.org/v2.16/docs/reference-global#rule_threads_core


description:
The maximum number of threads to use to execute `@rule` logic
https://www.pantsbuild.org/v2.16/docs/reference-global#rule_threads_max


description:
The time in seconds to wait for still-running "session end" tasks to complete before finishing completion of a Pants invocation. "Session end" tasks include, for example, writing data that was generated during the applicable Pants invocation to a configured remote cache
https://www.pantsbuild.org/v2.16/docs/reference-global#session_end_tasks_timeout


description:
Display the target where a log message originates in that log message's output
https://www.pantsbuild.org/v2.16/docs/reference-global#show_log_target


description:
Read additional specs (target addresses, files, and/or globs), one per line, from these files
https://www.pantsbuild.org/v2.16/docs/reference-global#spec_files


description:
Option scopes to record in stats on run completion
https://www.pantsbuild.org/v2.16/docs/reference-global#stats_record_option_scopes


description:
True if stats recording should be allowed to complete asynchronously when `pantsd` is enabled
https://www.pantsbuild.org/v2.16/docs/reference-global#streaming_workunits_complete_async


description:
The level of workunits that will be reported to streaming workunit event receivers
https://www.pantsbuild.org/v2.16/docs/reference-global#streaming_workunits_level


description:
Interval in seconds between when streaming workunit event receivers will be polled
https://www.pantsbuild.org/v2.16/docs/reference-global#streaming_workunits_report_interval


description:
Paths that correspond with build roots for any subproject that this project depends on
https://www.pantsbuild.org/v2.16/docs/reference-global#subproject_roots


key: tag

description:
Include only targets with these tags (optional '+' prefix) or without these tags ('-' prefix)
https://www.pantsbuild.org/v2.16/docs/reference-global#tag


description:
What to do when files and globs specified in BUILD files, such as in the `sources` field, cannot be found
https://www.pantsbuild.org/v2.16/docs/reference-global#unmatched_build_file_globs


description:
What to do when command line arguments, e.g. files and globs like `dir::`, cannot be found
https://www.pantsbuild.org/v2.16/docs/reference-global#unmatched_cli_globs


description:
Verify that all config file values correspond to known options
https://www.pantsbuild.org/v2.16/docs/reference-global#verify_config


description:
Set to False if Pants should not watch the filesystem for changes. `pantsd` or `loop` may not be enabled
https://www.pantsbuild.org/v2.16/docs/reference-global#watch_filesystem


key: anonymous-telemetry

description: Options related to sending anonymous stats to the Pants project, to aid development.


key: enabled

description:
Whether to send anonymous telemetry to the Pants project
https://www.pantsbuild.org/v2.16/docs/reference-anonymous-telemetry#enabled


description:
An anonymized ID representing this repo
https://www.pantsbuild.org/v2.16/docs/reference-anonymous-telemetry#repo_id


key: autoflake

description: The Autoflake Python code formatter (https://github.com/myint/autoflake).

default: autoflake


key: args

description:
Arguments to pass directly to Autoflake, e.g. `--autoflake-args='--remove-all-unused-imports --target-version=py37 --quiet'`
https://www.pantsbuild.org/v2.16/docs/reference-autoflake#args


description:
The console script for the tool
https://www.pantsbuild.org/v2.16/docs/reference-autoflake#console_script


description:
The entry point for the tool
https://www.pantsbuild.org/v2.16/docs/reference-autoflake#entry_point


description:
If specified, install the tool using the lockfile for this named resolve
https://www.pantsbuild.org/v2.16/docs/reference-autoflake#install_from_resolve


description:
Python interpreter constraints for this tool
https://www.pantsbuild.org/v2.16/docs/reference-autoflake#interpreter_constraints


key: requirements

description:
If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.16/docs/reference-autoflake#requirements


key: skip

description:
If true, don't use Autoflake when running `pants fmt` and `pants lint`
https://www.pantsbuild.org/v2.16/docs/reference-autoflake#skip


key: black

description: The Black Python code formatter (https://black.readthedocs.io/).

default: black


description:
Arguments to pass directly to Black, e.g. `--black-args='--target-version=py37 --quiet'`
https://www.pantsbuild.org/v2.16/docs/reference-black#args


key: config

description:
Path to a TOML config file understood by Black (https://github.com/psf/black#configuration-format)
https://www.pantsbuild.org/v2.16/docs/reference-black#config


description:
If true, Pants will include any relevant pyproject.toml config files during runs
https://www.pantsbuild.org/v2.16/docs/reference-black#config_discovery


description:
The console script for the tool
https://www.pantsbuild.org/v2.16/docs/reference-black#console_script


description:
The entry point for the tool
https://www.pantsbuild.org/v2.16/docs/reference-black#entry_point


description:
If specified, install the tool using the lockfile for this named resolve
https://www.pantsbuild.org/v2.16/docs/reference-black#install_from_resolve


description:
Python interpreter constraints for this tool
https://www.pantsbuild.org/v2.16/docs/reference-black#interpreter_constraints


description:
If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.16/docs/reference-black#requirements


description:
If true, don't use Black when running `pants fmt` and `pants lint`
https://www.pantsbuild.org/v2.16/docs/reference-black#skip


key: build-deprecations-fixer

description:
A tool/plugin for fixing BUILD file deprecations (where possible).

This includes deprecations for: - Renamed targets - Renamed fields


description:
If true, don't use BUILD Deprecations Fixer when running `pants fix`
https://www.pantsbuild.org/v2.16/docs/reference-build-deprecations-fixer#skip


key: changed

description:
Tell Pants to detect what files and targets have changed from Git.

See https://www.pantsbuild.org/v2.16/docs/advanced-target-selection.

enum: none direct transitive


key: dependents

description:
Include direct or transitive dependents of changed targets
https://www.pantsbuild.org/v2.16/docs/reference-changed#dependents


key: diffspec

description:
Calculate changes contained within a given Git spec (commit range/SHA/ref)
https://www.pantsbuild.org/v2.16/docs/reference-changed#diffspec


key: since

description:
Calculate changes since this Git spec (commit range/SHA/ref)
https://www.pantsbuild.org/v2.16/docs/reference-changed#since


key: check

description: Run type checking or the lightest variant of compilation available for a language.


key: only

description:
Only run these checkers and skip all others
https://www.pantsbuild.org/v2.16/docs/reference-check#only


key: check-default-tools

description: Options for checking that external tool default locations are correctly typed.


key: cli

description: Options for configuring CLI behavior, such as command line aliases.


key: alias

description:
Register command line aliases
https://www.pantsbuild.org/v2.16/docs/reference-cli#alias


key: count-loc

description: Count lines of code.


key: coursier

description: A dependency resolver for the Maven ecosystem. (https://get-coursier.io/)

enum: error warning


description:
Known versions to verify downloads against
https://www.pantsbuild.org/v2.16/docs/reference-coursier#known_versions


key: repos

description:
Maven style repositories to resolve artifacts from
https://www.pantsbuild.org/v2.16/docs/reference-coursier#repos


description:
A dictionary mapping platforms to strings to be used when generating the URL to download the tool
https://www.pantsbuild.org/v2.16/docs/reference-coursier#url_platform_mapping


description:
URL to download the tool, either as a single binary file or a compressed file (e.g. zip file)
https://www.pantsbuild.org/v2.16/docs/reference-coursier#url_template


description:
What action to take in case the requested version of coursier is not supported
https://www.pantsbuild.org/v2.16/docs/reference-coursier#use_unsupported_version


key: version

description:
Use this version of coursier
https://www.pantsbuild.org/v2.16/docs/reference-coursier#version


key: coverage-py

description: Configuration for Python test coverage measurement.

default: coverage

default: {distdir}/coverage/python

enum: console xml html raw json lcov


description:
Path to an INI or TOML config file understood by coverage.py (https://coverage.readthedocs.io/en/stable/config.html)
https://www.pantsbuild.org/v2.16/docs/reference-coverage-py#config


description:
If true, Pants will include any relevant config files during runs (`.coveragerc`, `setup.cfg`, `tox.ini`, and `pyproject.toml`)
https://www.pantsbuild.org/v2.16/docs/reference-coverage-py#config_discovery


description:
The console script for the tool
https://www.pantsbuild.org/v2.16/docs/reference-coverage-py#console_script


description:
The entry point for the tool
https://www.pantsbuild.org/v2.16/docs/reference-coverage-py#entry_point


description:
Fail if the total combined coverage percentage for all tests is less than this number
https://www.pantsbuild.org/v2.16/docs/reference-coverage-py#fail_under


key: filter

description:
A list of Python modules or filesystem paths to use in the coverage report, e.g. `['helloworld_test', 'helloworld/util/dirutil']`
https://www.pantsbuild.org/v2.16/docs/reference-coverage-py#filter


description:
If true, Pants will generate a global coverage report
https://www.pantsbuild.org/v2.16/docs/reference-coverage-py#global_report


description:
If specified, install the tool using the lockfile for this named resolve
https://www.pantsbuild.org/v2.16/docs/reference-coverage-py#install_from_resolve


description:
Python interpreter constraints for this tool
https://www.pantsbuild.org/v2.16/docs/reference-coverage-py#interpreter_constraints


description:
Path to write the Pytest Coverage report to
https://www.pantsbuild.org/v2.16/docs/reference-coverage-py#output_dir


key: report

description:
Which coverage report type(s) to emit
https://www.pantsbuild.org/v2.16/docs/reference-coverage-py#report


key: requirements

description:
If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.16/docs/reference-coverage-py#requirements


key: debug-adapter

description:
Options used to configure and launch a Debug Adapter server.

See https://microsoft.github.io/debug-adapter-protocol/ for more information.


key: host

description:
The hostname to use when launching the server
https://www.pantsbuild.org/v2.16/docs/reference-debug-adapter#host


key: port

description:
The port to use when launching the server
https://www.pantsbuild.org/v2.16/docs/reference-debug-adapter#port


key: debugpy

description: An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy).

default: debugpy


key: args

description:
Arguments to pass directly to debugpy, e.g. `--debugpy-args='--log-to-stderr'`
https://www.pantsbuild.org/v2.16/docs/reference-debugpy#args


description:
The console script for the tool
https://www.pantsbuild.org/v2.16/docs/reference-debugpy#console_script


description:
The entry point for the tool
https://www.pantsbuild.org/v2.16/docs/reference-debugpy#entry_point


description:
If specified, install the tool using the lockfile for this named resolve
https://www.pantsbuild.org/v2.16/docs/reference-debugpy#install_from_resolve


description:
Python interpreter constraints for this tool
https://www.pantsbuild.org/v2.16/docs/reference-debugpy#interpreter_constraints


description:
If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.16/docs/reference-debugpy#requirements


key: dependees

description: List all targets that depend on any of the input files/targets.

default: \n


key: closed

description:
Include the input targets in the output, along with the dependents
https://www.pantsbuild.org/v2.16/docs/reference-dependees#closed


description:
Output the goal's stdout to this file
https://www.pantsbuild.org/v2.16/docs/reference-dependees#output_file


key: sep

description:
String to use to separate lines in line-oriented output
https://www.pantsbuild.org/v2.16/docs/reference-dependees#sep


key: transitive

description:
List all transitive dependents
https://www.pantsbuild.org/v2.16/docs/reference-dependees#transitive


key: dependencies

description: List the dependencies of the input files/targets.


description:
Include the input targets in the output, along with the dependencies
https://www.pantsbuild.org/v2.16/docs/reference-dependencies#closed


description:
Output the goal's stdout to this file
https://www.pantsbuild.org/v2.16/docs/reference-dependencies#output_file


description:
String to use to separate lines in line-oriented output
https://www.pantsbuild.org/v2.16/docs/reference-dependencies#sep


description:
List all transitive dependencies
https://www.pantsbuild.org/v2.16/docs/reference-dependencies#transitive


key: dependents


description:
Include the input targets in the output, along with the dependents
https://www.pantsbuild.org/v2.16/docs/reference-dependents#closed


description:
Output the goal's stdout to this file
https://www.pantsbuild.org/v2.16/docs/reference-dependents#output_file


description:
String to use to separate lines in line-oriented output
https://www.pantsbuild.org/v2.16/docs/reference-dependents#sep


description:
List all transitive dependents
https://www.pantsbuild.org/v2.16/docs/reference-dependents#transitive


key: docformatter

description: The Python docformatter tool (https://github.com/myint/docformatter).

default: docformatter


description:
Arguments to pass directly to docformatter, e.g. `--docformatter-args='--wrap-summaries=100 --pre-summary-newline'`
https://www.pantsbuild.org/v2.16/docs/reference-docformatter#args


description:
The console script for the tool
https://www.pantsbuild.org/v2.16/docs/reference-docformatter#console_script


description:
The entry point for the tool
https://www.pantsbuild.org/v2.16/docs/reference-docformatter#entry_point


description:
If specified, install the tool using the lockfile for this named resolve
https://www.pantsbuild.org/v2.16/docs/reference-docformatter#install_from_resolve


description:
Python interpreter constraints for this tool
https://www.pantsbuild.org/v2.16/docs/reference-docformatter#interpreter_constraints


description:
If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.16/docs/reference-docformatter#requirements


key: skip

description:
If true, don't use docformatter when running `pants fmt` and `pants lint`
https://www.pantsbuild.org/v2.16/docs/reference-docformatter#skip


key: docker

description: Options for interacting with Docker.

default: {name}


description:
Global build arguments (for Docker `--build-arg` options) to use for all `docker build` invocations
https://www.pantsbuild.org/v2.16/docs/reference-docker#build_args


description:
Global default value for `target_stage` on `docker_image` targets, overriding the field value on the targets, if there is a matching stage in the `Dockerfile`
https://www.pantsbuild.org/v2.16/docs/reference-docker#build_target_stage


description:
Whether to log the Docker output to the console
https://www.pantsbuild.org/v2.16/docs/reference-docker#build_verbose


Provide a default Docker build context root path for `docker_image` targets that does not specify their own `context_root` field
https://www.pantsbuild.org/v2.16/docs/reference-docker#default_context_root


description:
Configure the default repository name used in the Docker image tag
https://www.pantsbuild.org/v2.16/docs/reference-docker#default_repository


description:
Environment variables to set for `docker` invocations
https://www.pantsbuild.org/v2.16/docs/reference-docker#env_vars


description:
The PATH value that will be used to find the Docker client and any tools required
https://www.pantsbuild.org/v2.16/docs/reference-docker#executable_search_paths


key: registries

description:
Configure Docker registries
https://www.pantsbuild.org/v2.16/docs/reference-docker#registries


description:
Additional arguments to use for `docker run` invocations
https://www.pantsbuild.org/v2.16/docs/reference-docker#run_args


key: tailor

description:
If true, add `docker_image` targets with the `tailor` goal
https://www.pantsbuild.org/v2.16/docs/reference-docker#tailor


key: tools

description:
List any additional executable tools required for Docker to work
https://www.pantsbuild.org/v2.16/docs/reference-docker#tools


key: dockerfile-parser

description: Used to parse Dockerfile build specs to infer their dependencies.


description:
If specified, install the tool using the lockfile for this named resolve
https://www.pantsbuild.org/v2.16/docs/reference-dockerfile-parser#install_from_resolve


description:
Python interpreter constraints for this tool
https://www.pantsbuild.org/v2.16/docs/reference-dockerfile-parser#interpreter_constraints


key: requirements

description:
If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.16/docs/reference-dockerfile-parser#requirements


key: environments-preview

description: A highly experimental subsystem to allow setting environment variables and executable search paths for different environments, e.g. macOS vs. Linux.


key: names

description:
A mapping of logical names to addresses to environment targets
https://www.pantsbuild.org/v2.16/docs/reference-environments-preview#names


key: experimental-bsp

description: Setup repository for Build Server Protocol (https://build-server-protocol.github.io/).


description:
A list of config files that define groups of Pants targets to expose to IDEs via Build Server Protocol
https://www.pantsbuild.org/v2.16/docs/reference-experimental-bsp#groups_config_files


description:
Environment variables to set in the BSP runner script when setting up BSP in a repository
https://www.pantsbuild.org/v2.16/docs/reference-experimental-bsp#runner_env_vars


key: server

description:
Run the Build Server Protocol server
https://www.pantsbuild.org/v2.16/docs/reference-experimental-bsp#server


key: experimental-deploy

description: Perform a deployment process.


key: experimental-explorer

description: Run the Pants Explorer Web UI server.

default: localhost


key: address

description:
Server address to bind to
https://www.pantsbuild.org/v2.16/docs/reference-experimental-explorer#address


key: port

description:
Server port to bind to
https://www.pantsbuild.org/v2.16/docs/reference-experimental-explorer#port


key: export

description: Export Pants data for use in other tools, such as IDEs.


Export Python resolves using this format
https://www.pantsbuild.org/v2.16/docs/reference-export#py_resolve_format


key: resolve

description:
Export the specified resolve(s)
https://www.pantsbuild.org/v2.16/docs/reference-export#resolve


key: export-codegen

description: Write generated files to `dist/codegen` for use outside of Pants.


key: filedeps

description: List all source and BUILD files a target depends on.


key: absolute

description:
If True, output with absolute path
https://www.pantsbuild.org/v2.16/docs/reference-filedeps#absolute


key: globs

description:
Instead of outputting filenames, output the original globs used in the BUILD file
https://www.pantsbuild.org/v2.16/docs/reference-filedeps#globs


description:
Output the goal's stdout to this file
https://www.pantsbuild.org/v2.16/docs/reference-filedeps#output_file


key: sep

description:
String to use to separate lines in line-oriented output
https://www.pantsbuild.org/v2.16/docs/reference-filedeps#sep


key: transitive

description:
If True, list files from all dependencies, including transitive dependencies
https://www.pantsbuild.org/v2.16/docs/reference-filedeps#transitive


key: filter

description:
Filter the input targets based on various criteria.

Most of the filtering options below are comma-separated lists of filtering criteria, with an implied logical OR between them, so that a target passes the filter if it matches any of the criteria in the list. A '-' prefix inverts the sense of the entire comma-separated list, so that a target passes the filter only if it matches none of the criteria in the list.

Each of the filtering options may be specified multiple times, with an implied logical AND between them.

default: all

enum: all file BUILD


description:
Filter on target addresses matching these regexes
https://www.pantsbuild.org/v2.16/docs/reference-filter#address_regex


key: granularity

description:
Filter to rendering only targets declared in BUILD files, only file-level targets, or all targets
https://www.pantsbuild.org/v2.16/docs/reference-filter#granularity


description:
Output the goal's stdout to this file
https://www.pantsbuild.org/v2.16/docs/reference-filter#output_file


description:
String to use to separate lines in line-oriented output
https://www.pantsbuild.org/v2.16/docs/reference-filter#sep


description:
Filter on targets with tags matching these regexes
https://www.pantsbuild.org/v2.16/docs/reference-filter#tag_regex


description:
Filter on these target types, e.g. `resources` or `python_sources`
https://www.pantsbuild.org/v2.16/docs/reference-filter#target_type


key: fix

description: Autofix source code.


description:
The target number of files to be included in each fixer batch
https://www.pantsbuild.org/v2.16/docs/reference-fix#batch_size


key: only

description:
Only run these fixers and skip all others
https://www.pantsbuild.org/v2.16/docs/reference-fix#only


description:
If true, skip running all formatters
https://www.pantsbuild.org/v2.16/docs/reference-fix#skip_formatters


description: The Flake8 Python linter (https://flake8.pycqa.org/).


key: args

description:
Arguments to pass directly to Flake8, e.g. `--flake8-args='--ignore E123,W456 --enable-extensions H111'`
https://www.pantsbuild.org/v2.16/docs/reference-flake8#args


key: config

description:
Path to an INI config file understood by Flake8 (https://flake8.pycqa.org/en/latest/user/configuration.html)
https://www.pantsbuild.org/v2.16/docs/reference-flake8#config


description:
If true, Pants will include any relevant config files during runs (`.flake8`, `flake8`, `setup.cfg`, and `tox.ini`)
https://www.pantsbuild.org/v2.16/docs/reference-flake8#config_discovery


description:
The console script for the tool
https://www.pantsbuild.org/v2.16/docs/reference-flake8#console_script


description:
The entry point for the tool
https://www.pantsbuild.org/v2.16/docs/reference-flake8#entry_point


description:
Paths to extra files to include in the sandbox
https://www.pantsbuild.org/v2.16/docs/reference-flake8#extra_files


description:
If specified, install the tool using the lockfile for this named resolve
https://www.pantsbuild.org/v2.16/docs/reference-flake8#install_from_resolve


key: requirements

description:
If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.16/docs/reference-flake8#requirements


key: skip

description:
If true, don't use Flake8 when running `pants lint`
https://www.pantsbuild.org/v2.16/docs/reference-flake8#skip


description:
An optional list of `python_sources` target addresses to load first-party plugins
https://www.pantsbuild.org/v2.16/docs/reference-flake8#source_plugins


key: fmt

description: Autoformat source code.


description:
The target number of files to be included in each formatter batch
https://www.pantsbuild.org/v2.16/docs/reference-fmt#batch_size


description:
Only run these formatters and skip all others
https://www.pantsbuild.org/v2.16/docs/reference-fmt#only


key: generate-lockfiles

description: Generate lockfiles for third-party dependencies.


description:
If set, lockfile headers will say to run this command to regenerate the lockfile, rather than running `pants generate-lockfiles --resolve=<name>` like normal
https://www.pantsbuild.org/v2.16/docs/reference-generate-lockfiles#custom_command


key: diff

description:
Print a summary of changed distributions after generating the lockfile
https://www.pantsbuild.org/v2.16/docs/reference-generate-lockfiles#diff


description:
Include unchanged distributions in the diff summary output
https://www.pantsbuild.org/v2.16/docs/reference-generate-lockfiles#diff_include_unchanged


key: resolve

description:
Only generate lockfiles for the specified resolve(s)
https://www.pantsbuild.org/v2.16/docs/reference-generate-lockfiles#resolve


key: go-generate

description:
Run each command in a package described by a `//go:generate` directive. This is equivalent to running `go generate` on a Go package.

Note: Just like with `go generate`, the `go-generate` goal is never run as part of the build and must be run manually to invoke the commands described by the //go:generate directives.

See https://go.dev/blog/generate for details.


description:
Environment variables to set when invoking generator programs
https://www.pantsbuild.org/v2.16/docs/reference-go-generate#env_vars


key: go-test

description: Options for Go tests.

default: set

enum: set count atomic


description:
Arguments to pass directly to Go test binary, e.g. `--go-test-args='-run TestFoo -v'`
https://www.pantsbuild.org/v2.16/docs/reference-go-test#args


description:
Capture a goroutine blocking profile from the execution of the test runner
https://www.pantsbuild.org/v2.16/docs/reference-go-test#block_profile


description:
Coverage mode to use when running Go tests with coverage analysis enabled via --test-use-coverage
https://www.pantsbuild.org/v2.16/docs/reference-go-test#cover_mode


description:
If true, then convert coverage reports to HTML format and write a `coverage.html` file next to the raw coverage data
https://www.pantsbuild.org/v2.16/docs/reference-go-test#coverage_html


description:
Path to write the Go coverage reports to
https://www.pantsbuild.org/v2.16/docs/reference-go-test#coverage_output_dir


description:
A list of "import path patterns" for determining which import paths will be instrumented for code coverage
https://www.pantsbuild.org/v2.16/docs/reference-go-test#coverage_packages


description:
Capture a CPU profile from the execution of the test runner
https://www.pantsbuild.org/v2.16/docs/reference-go-test#cpu_profile


description:
If true, then always enable interoperation between Go and the C/C++ "address sanitizer" when running tests regardless of the test-by-test `asan` field on the relevant `go_package` target
https://www.pantsbuild.org/v2.16/docs/reference-go-test#force_asan


description:
If true, then always enable interoperation between Go and the C/C++ "memory sanitizer" when running tests regardless of the test-by-test `msan` field on the relevant `go_package` target
https://www.pantsbuild.org/v2.16/docs/reference-go-test#force_msan


description:
If true, then always enable the Go data race detector when running tests regardless of the test-by-test `test_race` field on the relevant `go_package` target
https://www.pantsbuild.org/v2.16/docs/reference-go-test#force_race


description:
Capture an allocation profile from the execution of the test runner after tests have passed
https://www.pantsbuild.org/v2.16/docs/reference-go-test#mem_profile


description:
Capture a mutex contention profile from the execution of the test runner when all tests are complete
https://www.pantsbuild.org/v2.16/docs/reference-go-test#mutex_profile


description:
Write the test binary to the test extra output directory
https://www.pantsbuild.org/v2.16/docs/reference-go-test#output_test_binary


description:
If true, don't use Go test binary when running `pants test`
https://www.pantsbuild.org/v2.16/docs/reference-go-test#skip


key: trace

description:
Capture an execution trace from the execution of the test runner
https://www.pantsbuild.org/v2.16/docs/reference-go-test#trace


key: gofmt

description: Gofmt-specific options.


description:
Arguments to pass directly to gofmt, e.g. `--gofmt-args='-s -e'`
https://www.pantsbuild.org/v2.16/docs/reference-gofmt#args


description:
If true, don't use gofmt when running `pants fmt` and `pants lint`
https://www.pantsbuild.org/v2.16/docs/reference-gofmt#skip


key: golang

description: Options for Golang support.

default: bin

default: go-sdk

default: gfortran

default: gcc


description:
The path relative to an ASDF install directory to use to find the `bin` directory within an installed Go distribution
https://www.pantsbuild.org/v2.16/docs/reference-golang#asdf_bin_relpath


description:
The ASDF tool name to use when searching for installed Go distributions using the ASDF tool manager (https://asdf-vm.com/)
https://www.pantsbuild.org/v2.16/docs/reference-golang#asdf_tool_name


description:
Compiler options used when compiling C code when Cgo is enabled
https://www.pantsbuild.org/v2.16/docs/reference-golang#cgo_c_flags


description:
Compiler options used when compiling C++ code when Cgo is enabled
https://www.pantsbuild.org/v2.16/docs/reference-golang#cgo_cxx_flags


description:
Enable Cgo support, which allows Go and C code to interact
https://www.pantsbuild.org/v2.16/docs/reference-golang#cgo_enabled


description:
Name of the tool to use to compile fortran code included via CGo in a Go package
https://www.pantsbuild.org/v2.16/docs/reference-golang#cgo_fortran_binary_name


description:
Compiler options used when compiling Fortran code when Cgo is enabled
https://www.pantsbuild.org/v2.16/docs/reference-golang#cgo_fortran_flags


description:
Name of the tool to use to compile C code included via CGo in a Go package
https://www.pantsbuild.org/v2.16/docs/reference-golang#cgo_gcc_binary_name


description:
Name of the tool to use to compile C++ code included via CGo in a Go package
https://www.pantsbuild.org/v2.16/docs/reference-golang#cgo_gxx_binary_name


description:
Compiler options used when linking native code when Cgo is enabled
https://www.pantsbuild.org/v2.16/docs/reference-golang#cgo_linker_flags


description:
A list of paths to search for tools needed by CGo (e.g., gcc, g++)
https://www.pantsbuild.org/v2.16/docs/reference-golang#cgo_tool_search_paths


description:
Name of the tool to use as the "external linker" when invoking `go tool link`
https://www.pantsbuild.org/v2.16/docs/reference-golang#external_linker_binary_name


description:
A list of paths to search for Go
https://www.pantsbuild.org/v2.16/docs/reference-golang#go_search_paths


description:
The minimum Go version the distribution discovered by Pants must support
https://www.pantsbuild.org/v2.16/docs/reference-golang#minimum_expected_version


description:
Environment variables to set when invoking the `go` tool
https://www.pantsbuild.org/v2.16/docs/reference-golang#subprocess_env_vars


description:
If true, add a `go_binary` target with the `tailor` goal in every directory with a `.go` file with `package main`
https://www.pantsbuild.org/v2.16/docs/reference-golang#tailor_binary_targets


description:
If true, add a `go_mod` target with the `tailor` goal wherever there is a `go.mod` file
https://www.pantsbuild.org/v2.16/docs/reference-golang#tailor_go_mod_targets


description:
If true, add a `go_package` target with the `tailor` goal in every directory with a `.go` file
https://www.pantsbuild.org/v2.16/docs/reference-golang#tailor_package_targets


key: google-java-format

description: Google Java Format (https://github.com/google/google-java-format)

default: <default>


key: aosp

description:
Use AOSP style instead of Google Style (4-space indentation). ("AOSP" is the Android Open Source Project.)
https://www.pantsbuild.org/v2.16/docs/reference-google-java-format#aosp


key: artifacts

description:
Artifact requirements for this tool using specified as either the address of a `jvm_artifact` target or, alternatively, as a colon-separated Maven coordinates (e.g., group:name:version)
https://www.pantsbuild.org/v2.16/docs/reference-google-java-format#artifacts


description:
List of JVM options to pass to `google-java-format` JVM processes
https://www.pantsbuild.org/v2.16/docs/reference-google-java-format#jvm_options


key: lockfile

description:
Path to a lockfile used for installing the tool
https://www.pantsbuild.org/v2.16/docs/reference-google-java-format#lockfile


description:
If true, don't use Google Java Format when running `pants fmt` and `pants lint`
https://www.pantsbuild.org/v2.16/docs/reference-google-java-format#skip


key: version

description:
Version string for the tool
https://www.pantsbuild.org/v2.16/docs/reference-google-java-format#version


key: graphql

description: Options for the explorer GraphQL API.


description:
Open a new web browser tab with GraphiQL
https://www.pantsbuild.org/v2.16/docs/reference-graphql#open_graphiql


key: hadolint

description: A linter for Dockerfiles.

default: error


key: args

description:
Arguments to pass directly to Hadolint, e.g. `--hadolint-args='--format json'`
https://www.pantsbuild.org/v2.16/docs/reference-hadolint#args


key: config

description:
Path to an YAML config file understood by Hadolint (https://github.com/hadolint/hadolint#configure)
https://www.pantsbuild.org/v2.16/docs/reference-hadolint#config


description:
If true, Pants will include all relevant config files during runs (`.hadolint.yaml` and `.hadolint.yml`)
https://www.pantsbuild.org/v2.16/docs/reference-hadolint#config_discovery


description:
Known versions to verify downloads against
https://www.pantsbuild.org/v2.16/docs/reference-hadolint#known_versions


key: skip

description:
If true, don't use Hadolint when running `pants lint`
https://www.pantsbuild.org/v2.16/docs/reference-hadolint#skip


description:
A dictionary mapping platforms to strings to be used when generating the URL to download the tool
https://www.pantsbuild.org/v2.16/docs/reference-hadolint#url_platform_mapping


description:
URL to download the tool, either as a single binary file or a compressed file (e.g. zip file)
https://www.pantsbuild.org/v2.16/docs/reference-hadolint#url_template


description:
What action to take in case the requested version of Hadolint is not supported
https://www.pantsbuild.org/v2.16/docs/reference-hadolint#use_unsupported_version


description:
Use this version of Hadolint
https://www.pantsbuild.org/v2.16/docs/reference-hadolint#version


key: help

description: Display usage message.


key: help-advanced

description: Help for advanced options.


key: help-all

description: Print a JSON object containing all help info.


description: [Internal] Generate test lockfile fixtures for Pants tests.


key: ipython

description: The IPython enhanced REPL (https://ipython.org/).

default: ipython


description:
The console script for the tool
https://www.pantsbuild.org/v2.16/docs/reference-ipython#console_script


description:
The entry point for the tool
https://www.pantsbuild.org/v2.16/docs/reference-ipython#entry_point


description:
Whether to tell IPython not to put the CWD on the import path
https://www.pantsbuild.org/v2.16/docs/reference-ipython#ignore_cwd


description:
If specified, install the tool using the lockfile for this named resolve
https://www.pantsbuild.org/v2.16/docs/reference-ipython#install_from_resolve


key: requirements

description:
If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.16/docs/reference-ipython#requirements


key: isort

description: The Python import sorter tool (https://pycqa.github.io/isort/).

default: isort


description:
Arguments to pass directly to isort, e.g. `--isort-args='--case-sensitive --trailing-comma'`
https://www.pantsbuild.org/v2.16/docs/reference-isort#args


description:
Path to config file understood by isort (https://pycqa.github.io/isort/docs/configuration/config_files/)
https://www.pantsbuild.org/v2.16/docs/reference-isort#config


description:
If true, Pants will include any relevant config files during runs (`.isort.cfg`, `pyproject.toml`, `setup.cfg`, `tox.ini` and `.editorconfig`)
https://www.pantsbuild.org/v2.16/docs/reference-isort#config_discovery


description:
The console script for the tool
https://www.pantsbuild.org/v2.16/docs/reference-isort#console_script


description:
The entry point for the tool
https://www.pantsbuild.org/v2.16/docs/reference-isort#entry_point


description:
If specified, install the tool using the lockfile for this named resolve
https://www.pantsbuild.org/v2.16/docs/reference-isort#install_from_resolve


description:
Python interpreter constraints for this tool
https://www.pantsbuild.org/v2.16/docs/reference-isort#interpreter_constraints


description:
If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.16/docs/reference-isort#requirements


description:
If true, don't use isort when running `pants fmt` and `pants lint`
https://www.pantsbuild.org/v2.16/docs/reference-isort#skip


key: jarjar

description: The Jar Jar Abrams tool (https://github.com/eed3si9n/jarjar-abrams)

enum: fatal skip omit move


description:
Artifact requirements for this tool using specified as either the address of a `jvm_artifact` target or, alternatively, as a colon-separated Maven coordinates (e.g., group:name:version)
https://www.pantsbuild.org/v2.16/docs/reference-jarjar#artifacts


description:
List of JVM options to pass to `jarjar` JVM processes
https://www.pantsbuild.org/v2.16/docs/reference-jarjar#jvm_options


description:
Path to a lockfile used for installing the tool
https://www.pantsbuild.org/v2.16/docs/reference-jarjar#lockfile


description:
The strategy to use when processing class files that are in the wrong package
https://www.pantsbuild.org/v2.16/docs/reference-jarjar#misplaced_class_strategy


description:
Skip the processing of the JAR manifest
https://www.pantsbuild.org/v2.16/docs/reference-jarjar#skip_manifest


description:
Version string for the tool
https://www.pantsbuild.org/v2.16/docs/reference-jarjar#version


key: java-dump-source-analysis

description: Dump source analysis for java_source[s] targets.


key: java-infer

description: Options controlling which dependencies will be inferred for Java targets.


description:
Infer a target's dependencies by parsing consumed types from sources
https://www.pantsbuild.org/v2.16/docs/reference-java-infer#consumed_types


key: imports

description:
Infer a target's dependencies by parsing import statements from sources
https://www.pantsbuild.org/v2.16/docs/reference-java-infer#imports


description:
A dictionary mapping a Java package path to a JVM artifact coordinate (GROUP:ARTIFACT) without the version
https://www.pantsbuild.org/v2.16/docs/reference-java-infer#third_party_import_mapping


key: javac

description: The javac Java source compiler.


description:
Arguments to pass directly to javac, e.g. `--javac-args='-g -deprecation'`
https://www.pantsbuild.org/v2.16/docs/reference-javac#args


description:
If true, add `java_sources` and `java_tests` targets with the `tailor` goal
https://www.pantsbuild.org/v2.16/docs/reference-javac#tailor_source_targets


key: junit

description: The JUnit test framework (https://junit.org)


description:
Arguments to pass directly to JUnit, e.g. `--junit-args='--disable-ansi-colors'`
https://www.pantsbuild.org/v2.16/docs/reference-junit#args


key: artifacts

description:
Artifact requirements for this tool using specified as either the address of a `jvm_artifact` target or, alternatively, as a colon-separated Maven coordinates (e.g., group:name:version)
https://www.pantsbuild.org/v2.16/docs/reference-junit#artifacts


description:
List of JVM options to pass to `junit` JVM processes
https://www.pantsbuild.org/v2.16/docs/reference-junit#jvm_options


key: lockfile

description:
Path to a lockfile used for installing the tool
https://www.pantsbuild.org/v2.16/docs/reference-junit#lockfile


description:
If true, don't use JUnit when running `pants test`
https://www.pantsbuild.org/v2.16/docs/reference-junit#skip


key: version

description:
Version string for the tool
https://www.pantsbuild.org/v2.16/docs/reference-junit#version


key: jvm

description:
Options for general JVM functionality.

JDK strings will be passed directly to Coursier's `--jvm` parameter. Run `cs java --available` to see a list of available JVM versions on your platform.

If the string 'system' is passed, Coursier's `--system-jvm` option will be used instead, but note that this can lead to inconsistent behavior since the JVM version will be whatever happens to be found first on the system's PATH.

default: jvm-default


description:
Extra JVM arguments to use when running tests in debug mode
https://www.pantsbuild.org/v2.16/docs/reference-jvm#debug_args


description:
The default value used for the `resolve` and `compatible_resolves` fields
https://www.pantsbuild.org/v2.16/docs/reference-jvm#default_resolve


description:
List of JVM options to pass to all JVM processes
https://www.pantsbuild.org/v2.16/docs/reference-jvm#global_options


key: jdk

description:
The JDK to use
https://www.pantsbuild.org/v2.16/docs/reference-jvm#jdk


description:
The time in milliseconds to delay speculation of nailgun processes while reading from the remote cache
https://www.pantsbuild.org/v2.16/docs/reference-jvm#nailgun_remote_cache_speculation_delay


description:
When enabled, JAR files produced by JVM tools will have timestamps stripped
https://www.pantsbuild.org/v2.16/docs/reference-jvm#reproducible_jars


key: resolves

description:
A dictionary mapping resolve names to the path of their lockfile
https://www.pantsbuild.org/v2.16/docs/reference-jvm#resolves


description:
The JDK to use when building and running Pants' internal JVM support code and other non-compiler tools
https://www.pantsbuild.org/v2.16/docs/reference-jvm#tool_jdk


key: jvm-symbol-map

description: Dump the JVM dependency inference symbol mapping.


key: lint

description: Run linters/formatters/fixers in check mode.


description:
The target number of files to be included in each linter batch
https://www.pantsbuild.org/v2.16/docs/reference-lint#batch_size


key: only

description:
Only run these linters and skip all others
https://www.pantsbuild.org/v2.16/docs/reference-lint#only


description:
If true, skip running all fixers in check-only mode
https://www.pantsbuild.org/v2.16/docs/reference-lint#skip_fixers


description:
If true, skip running all formatters in check-only mode
https://www.pantsbuild.org/v2.16/docs/reference-lint#skip_formatters


key: list

description: Lists all targets matching the file or target arguments.


key: documented

description:
Print only targets that are documented with a description
https://www.pantsbuild.org/v2.16/docs/reference-list#documented


description:
Output the goal's stdout to this file
https://www.pantsbuild.org/v2.16/docs/reference-list#output_file


key: sep

description:
String to use to separate lines in line-oriented output
https://www.pantsbuild.org/v2.16/docs/reference-list#sep


key: mypy

description: The MyPy Python type checker (http://mypy-lang.org/).

default: mypy


key: args

description:
Arguments to pass directly to MyPy, e.g. `--mypy-args='--python-version 3.7 --disallow-any-expr'`
https://www.pantsbuild.org/v2.16/docs/reference-mypy#args


key: config

description:
Path to a config file understood by MyPy (https://mypy.readthedocs.io/en/stable/config_file.html)
https://www.pantsbuild.org/v2.16/docs/reference-mypy#config


description:
If true, Pants will include any relevant config files during runs (`mypy.ini`, `.mypy.ini`, and `setup.cfg`)
https://www.pantsbuild.org/v2.16/docs/reference-mypy#config_discovery


description:
The console script for the tool
https://www.pantsbuild.org/v2.16/docs/reference-mypy#console_script


description:
The entry point for the tool
https://www.pantsbuild.org/v2.16/docs/reference-mypy#entry_point


description:
If specified, install the tool using the lockfile for this named resolve
https://www.pantsbuild.org/v2.16/docs/reference-mypy#install_from_resolve


description:
Python interpreter constraints for this tool
https://www.pantsbuild.org/v2.16/docs/reference-mypy#interpreter_constraints


key: requirements

description:
If install_from_resolve is specified, install these requirements, at the versions provided by the specified resolve's lockfile
https://www.pantsbuild.org/v2.16/docs/reference-mypy#requirements


key: skip

description:
If true, don't use MyPy when running `pants check`
https://www.pantsbuild.org/v2.16/docs/reference-mypy#skip


description:
An optional list of `python_sources` target addresses to load first-party plugins
https://www.pantsbuild.org/v2.16/docs/reference-mypy#source_plugins


key: package

description: Create a distributable package.


key: pants-releases

description: Options for Pants's release process.


description:
A dict from branch name to release notes rst-file location
https://www.pantsbuild.org/v2.16/docs/reference-pants-releases#release_notes


key: paths

description: List the paths between two addresses.


key: from

description:
The path starting address
https://www.pantsbuild.org/v2.16/docs/reference-paths#from


description:
Output the goal's stdout to this file
https://www.pantsbuild.org/v2.16/docs/reference-paths#output_file


key: to

description:
The path end address
https://www.pantsbuild.org/v2.16/docs/reference-paths#to


key: peek

description: Display BUILD target info


description:
Whether to leave off values that match the target-defined default values
https://www.pantsbuild.org/v2.16/docs/reference-peek#exclude_defaults


description:
Whether to include `_dependencies_rules`, `_dependents_rules` and `_applicable_dep_rules` that apply to the target and its dependencies
https://www.pantsbuild.org/v2.16/docs/reference-peek#include_dep_rules


description:
Output the goal's stdout to this file
https://www.pantsbuild.org/v2.16/docs/reference-peek#output_file


key: pex

description: How Pants uses Pex to run Python subprocesses.


description:
The PATH value that will be used by the PEX subprocess and any subprocesses it spawns
https://www.pantsbuild.org/v2.16/docs/reference-pex#executable_search_paths


description:
When possible, use venvs whose site-packages directories are populated with symlinks
https://www.pantsbuild.org/v2.16/docs/reference-pex#venv_use_symlinks


key: verbosity

description:
Set the verbosity level of PEX logging, from 0 (no logging) up to 9 (max logging)
https://www.pantsbuild.org/v2.16/docs/reference-pex#verbosity


key: pex-binary-defaults

description: Default settings for creating PEX executables.


description:
Whether built PEX binaries should emit PEX warnings at runtime by default
https://www.pantsbuild.org/v2.16/docs/reference-pex-binary-defaults#emit_warnings


description:
For each of the `platforms` specified for a `pex_binary` target, attempt to find a local interpreter that matches
https://www.pantsbuild.org/v2.16/docs/reference-pex-binary-defaults#resolve_local_platforms


key: pex-cli

description: The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex).


description:
Known versions to verify downloads against
https://www.pantsbuild.org/v2.16/docs/reference-pex-cli#known_versions


description:
A dictionary mapping platforms to strings to be used when generating the URL to download the tool
https://www.pantsbuild.org/v2.16/docs/reference-pex-cli#url_platform_mapping


description:
URL to download the tool, either as a single binary file or a compressed file (e.g. zip file)
https://www.pantsbuild.org/v2.16/docs/reference-pex-cli#url_template


description:
What action to take in case the requested version of pex is not supported
https://www.pantsbuild.org/v2.16/docs/reference-pex-cli#use_unsupported_version


key: version

description:
Use this version of pex
https://www.pantsbuild.org/v2.16/docs/reference-pex-cli#version


key: preamble

description:
Formats files with a preamble, with the preamble looked up based on path.

This is useful for things such as copyright headers or shebang lines.

Pants substitutes the following identifiers (following Python's string.Template substitutions): - $year: The current year (only used when actually writing the year to the file).


description:
If true, don't use preamble when running `pants fmt`
https://www.pantsbuild.org/v2.16/docs/reference-preamble#skip


description:
Which preamble template to use based on the path globs (relative to the build root)
https://www.pantsbuild.org/v2.16/docs/reference-preamble#template_by_globs


key: publish

description: Publish deliverables (assets, distributions, images, etc).


key: output

description:
Filename for JSON structured publish information
https://www.pantsbuild.org/v2.16/docs/reference-publish#output


key: py-constraints

description: Determine what Python interpreter constraints are used by files/targets.


description:
Output the goal's stdout to this file
https://www.pantsbuild.org/v2.16/docs/reference-py-constraints#output_file


key: summary

description:
Output a CSV summary of interpreter constraints for your whole repository
https://www.pantsbuild.org/v2.16/docs/reference-py-constraints#summary


description:
If False, use the legacy, misleading `#Dependees` header name in the summary CSV table
https://www.pantsbuild.org/v2.16/docs/reference-py-constraints#summary_use_new_header


key: pyoxidizer

description:
The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html).

Used with the `pyoxidizer_binary` target.

default: pyoxidizer


key: args

description:
Arguments to pass directly to PyOxidizer, e.g. `--pyoxidizer-args='--release'`
https://www.pantsbuild.org/v2.16/docs/reference-pyoxidizer#args


description:
The console script for the tool
https://www.pantsbuild.org/v2.16/docs/reference-pyoxidizer#console_script


description:
The entry point for the tool
https://www.pantsbuild.org/v2.16/docs/reference-pyoxidizer#entry_point


description:
If specified, install the tool using the lockfile for this named resolve
https://www.pantsbuild.org/v2.16/docs/reference-pyoxidizer#install_from_resolve