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

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

default: fetch

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

enum: fetch validate defer

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

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

default: indicatif-spinner

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

enum: indicatif-spinner experimental-prodash

description:
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

default: never

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

enum: always on_failure never

default: info

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

enum: trace debug info warn error

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

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

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

default: pants

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

default: <buildroot>/dist

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

default: .*/ /dist/ __pycache__

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

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

description:
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

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

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

default: #cores

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

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

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

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

default: backoff

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

enum: ignore first_only backoff

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

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

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

default: max(2, #cores/2)

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

default: debug

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

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

default: warn

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

enum: ignore warn error

default: error

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

description: Count lines of code.

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

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

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

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

description: Configuration for Python test coverage measurement.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

description: The Python docformatter tool (https://github.com/myint/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

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

description: Options for interacting with Docker.

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

description:
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

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

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

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

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

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

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

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

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

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

description: Perform a deployment process.

description: Run the Pants Explorer Web UI server.

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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/).

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

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

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

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

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

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

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

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

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

description: Options for Go tests.

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

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

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

description: Options for Golang support.

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

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

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

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

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

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

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

description: A linter for Dockerfiles.

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

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

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

description: Display usage message.

description: Help for advanced options.

description: Print a JSON object containing all help info.

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

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

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

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

description: The Python import sorter tool (https://pycqa.github.io/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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

description: Dump the JVM dependency inference symbol mapping.

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

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

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

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

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

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

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

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

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

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

description: Create a distributable package.

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

description: List the paths between two addresses.

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

description:
Python interpreter constraints for this tool
https://www.pantsbuild.org/v2.16/docs/reference-pyoxidizer#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-pyoxidizer#requirements

description: The pytest Python test framework (https://docs.pytest.org/).

description:
Arguments to pass directly to Pytest, e.g. `--pytest-args='-k test_foo --quiet'`
https://www.pantsbuild.org/v2.16/docs/reference-pytest#args

description:
Path to a config file understood by Pytest (https://docs.pytest.org/en/latest/reference/customize.html#configuration-file-formats)
https://www.pantsbuild.org/v2.16/docs/reference-pytest#config

description:
If true, Pants will include all relevant Pytest config files (e.g. `pytest.ini`) during runs
https://www.pantsbuild.org/v2.16/docs/reference-pytest#config_discovery

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

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

description:
If a non-empty string, the process execution slot id (an integer) will be exposed to tests under this environment variable name
https://www.pantsbuild.org/v2.16/docs/reference-pytest#execution_slot_var

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

description:
The format of generated junit XML files
https://www.pantsbuild.org/v2.16/docs/reference-pytest#junit_family

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-pytest#requirements

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

description:
If true, Pants will use `pytest-xdist` (https://pytest-xdist.readthedocs.io/en/latest/) to parallelize tests within each `python_test` target
https://www.pantsbuild.org/v2.16/docs/reference-pytest#xdist_enabled

description: Options for Pants's Python backend.

description:
The default value used for the `resolve` field
https://www.pantsbuild.org/v2.16/docs/reference-python#default_resolve

description:
The default value used for the `run_goal_use_sandbox` field of Python targets
https://www.pantsbuild.org/v2.16/docs/reference-python#default_run_goal_use_sandbox

description:
Create targets for all Python lockfiles defined in `[python].resolves`
https://www.pantsbuild.org/v2.16/docs/reference-python#enable_lockfile_targets

description:
Set to true to enable lockfiles for user code
https://www.pantsbuild.org/v2.16/docs/reference-python#enable_resolves

description:
The Python interpreters your codebase is compatible with
https://www.pantsbuild.org/v2.16/docs/reference-python#interpreter_constraints

description:
All known Python major/minor interpreter versions that may be used by either your code or tools used by your code
https://www.pantsbuild.org/v2.16/docs/reference-python#interpreter_versions_universe

description:
The behavior when a lockfile has requirements or interpreter constraints that are not compatible with what the current build is using
https://www.pantsbuild.org/v2.16/docs/reference-python#invalid_lockfile_behavior

description:
If set, and if running on MacOS Big Sur, use macosx_10_16 as the platform when building wheels
https://www.pantsbuild.org/v2.16/docs/reference-python#macos_big_sur_compatibility

description:
Use this version of Pip for resolving requirements and generating lockfiles
https://www.pantsbuild.org/v2.16/docs/reference-python#pip_version

description:
Whether to use the standard Python command history file when running a repl
https://www.pantsbuild.org/v2.16/docs/reference-python#repl_history

description:
Whether to allow resolution of manylinux wheels when resolving requirements for foreign linux platforms
https://www.pantsbuild.org/v2.16/docs/reference-python#resolver_manylinux

description:
A mapping of logical names to lockfile paths used in your project
https://www.pantsbuild.org/v2.16/docs/reference-python#resolves

description:
If False, Pants will not attempt to generate lockfiles for `[python].resolves` when running the `generate-lockfiles` goal
https://www.pantsbuild.org/v2.16/docs/reference-python#resolves_generate_lockfiles

description:
When generating a resolve's lockfile, use a constraints file to pin the version of certain requirements
https://www.pantsbuild.org/v2.16/docs/reference-python#resolves_to_constraints_file

description:
Override the interpreter constraints to use when generating a resolve's lockfile with the `generate-lockfiles` goal
https://www.pantsbuild.org/v2.16/docs/reference-python#resolves_to_interpreter_constraints

description:
When generating a resolve's lockfile, do not use binary packages (i.e. wheels) for these 3rdparty project names
https://www.pantsbuild.org/v2.16/docs/reference-python#resolves_to_no_binary

description:
When generating a resolve's lockfile, do not use source packages (i.e. sdists) for these 3rdparty project names, e.g `['django', 'requests']`
https://www.pantsbuild.org/v2.16/docs/reference-python#resolves_to_only_binary

description:
If enabled, when running binaries, tests, and repls, Pants will use the entire lockfile file instead of just the relevant subset
https://www.pantsbuild.org/v2.16/docs/reference-python#run_against_entire_lockfile

description:
If true, don't add `python_sources` targets for `__init__.py` files that are both empty and where there are no other Python files in the directory
https://www.pantsbuild.org/v2.16/docs/reference-python#tailor_ignore_empty_init_files

description:
If true, add `pex_binary` targets for Python files named `__main__.py` or with a `__main__` clause with the `tailor` goal
https://www.pantsbuild.org/v2.16/docs/reference-python#tailor_pex_binary_targets

description:
If true, add `resource` targets for marker files named `py.typed` with the `tailor` goal
https://www.pantsbuild.org/v2.16/docs/reference-python#tailor_py_typed_targets

description:
If true, add `python_requirements`, `poetry_requirements`, and `pipenv_requirements` target generators with the `tailor` goal
https://www.pantsbuild.org/v2.16/docs/reference-python#tailor_requirements_targets

description:
If true, add `python_sources`, `python_tests`, and `python_test_utils` targets with the `tailor` goal
https://www.pantsbuild.org/v2.16/docs/reference-python#tailor_source_targets

description:
Options used to locate Python interpreters

This subsystem controls where and how Pants will locate Python, but beyond that it does not control which Python interpreter versions are actually used for your code: see the `python` subsystem for that.

description:
A map from platform to the information needed to download Python Build Standalone
https://www.pantsbuild.org/v2.16/docs/reference-python-bootstrap#internal_python_build_standalone_info

description:
The names of Python binaries to search for
https://www.pantsbuild.org/v2.16/docs/reference-python-bootstrap#names

description:
A list of paths to search for Python interpreters
https://www.pantsbuild.org/v2.16/docs/reference-python-bootstrap#search_path

description: Dump source analysis for python_source targets.

description:
The type of information that should be returned
https://www.pantsbuild.org/v2.16/docs/reference-python-dump-source-analysis#analysis_flavor

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

description:
When multiple sources provide the same symbol, how to choose the provider to use
https://www.pantsbuild.org/v2.16/docs/reference-python-infer#ambiguity_resolution

description:
Infer a target's asset dependencies based on strings that look like Posix filepaths, such as those given to `open` or `pkgutil.get_data`
https://www.pantsbuild.org/v2.16/docs/reference-python-infer#assets

description:
If --assets is True, treat valid-looking strings with at least this many forward slash characters as potential assets
https://www.pantsbuild.org/v2.16/docs/reference-python-infer#assets_min_slashes

description:
Infer a test target's dependencies on any conftest.py files in the current directory and ancestor directories
https://www.pantsbuild.org/v2.16/docs/reference-python-infer#conftests

description:
Infer dependencies on targets' entry points, e.g. `pex_binary`'s `entry_point` field, `python_awslambda`'s `handler` field and `python_distribution`'s `entry_points` field
https://www.pantsbuild.org/v2.16/docs/reference-python-infer#entry_points

description:
Unowned imports that should be ignored
https://www.pantsbuild.org/v2.16/docs/reference-python-infer#ignored_unowned_imports

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

description:
Infer a target's dependencies on any `__init__.py` files in the packages it is located in (recursively upward in the directory structure)
https://www.pantsbuild.org/v2.16/docs/reference-python-infer#init_files

description:
Infer a target's dependencies based on strings that look like dynamic dependencies, such as Django settings files expressing dependencies as strings
https://www.pantsbuild.org/v2.16/docs/reference-python-infer#string_imports

description:
If --string-imports is True, treat valid-looking strings with at least this many dots in them as potential dynamic dependencies
https://www.pantsbuild.org/v2.16/docs/reference-python-infer#string_imports_min_dots

description:
How to handle imports that don't have an inferrable owner
https://www.pantsbuild.org/v2.16/docs/reference-python-infer#unowned_dependency_behavior

description: Options for building native code using Python, e.g. when resolving distributions.

description:
Override the `CPPFLAGS` environment variable for any forked subprocesses
https://www.pantsbuild.org/v2.16/docs/reference-python-native-code#cpp_flags

description:
Override the `LDFLAGS` environment variable for any forked subprocesses
https://www.pantsbuild.org/v2.16/docs/reference-python-native-code#ld_flags

description:
External Python code repositories, such as PyPI.

These options may be used to point to custom package indexes when resolving requirements.

description:
URLs and/or file paths corresponding to pip's `--find-links` option
https://www.pantsbuild.org/v2.16/docs/reference-python-repos#find_links

description:
URLs of [PEP-503 compatible](https://peps.python.org/pep-0503/) code repository indexes to look for requirements
https://www.pantsbuild.org/v2.16/docs/reference-python-repos#indexes

description:
Mappings to facilitate using local Python requirements when the absolute file paths are different on different users' machines
https://www.pantsbuild.org/v2.16/docs/reference-python-repos#path_mappings

description:
Lint your code using regex patterns, e.g. to check for copyright headers.

To activate this with the `lint` goal, you must set `[regex-lint].config`.

Unlike other linters, this can run on files not owned by targets, such as BUILD files.

description:
Config schema is as follows:
https://www.pantsbuild.org/v2.16/docs/reference-regex-lint#config

description:
How much detail to include in the result
https://www.pantsbuild.org/v2.16/docs/reference-regex-lint#detail_level

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

description: Open a REPL with the specified code loadable.

description:
True if the REPL should be restarted if its inputs have changed
https://www.pantsbuild.org/v2.16/docs/reference-repl#restartable

description:
Override the automatically-detected REPL program for the target(s) specified
https://www.pantsbuild.org/v2.16/docs/reference-repl#shell

description: List the repo's registered source roots.

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

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

description:
Runs a binary target.

This goal propagates the return code of the underlying executable.

If your application can safely be restarted while it is running, you can pass `restartable=True` on your binary target (for supported types), and the `run` goal will automatically restart them as all relevant files change. This can be particularly useful for server applications.

description:
Arguments to pass directly to the executed target, e.g. `--run-args='val1 val2 --debug'`
https://www.pantsbuild.org/v2.16/docs/reference-run#args

description:
Run the interactive process using a Debug Adapter (https://microsoft.github.io/debug-adapter-protocol/) for the language if supported
https://www.pantsbuild.org/v2.16/docs/reference-run#debug_adapter

description: Scala programming language

description:
If true, add `scala_sources`, `scala_junit_tests`, and `scalatest_tests` targets with the `tailor` goal
https://www.pantsbuild.org/v2.16/docs/reference-scala#tailor_source_targets

description:
A dictionary mapping the name of a resolve to the Scala version to use for all Scala targets consuming that resolve
https://www.pantsbuild.org/v2.16/docs/reference-scala#version_for_resolve

description: Dump source analysis for scala_source targets.

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

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

description:
If true, add a dependency on all scala_source targets generated by the same scala_sources target generator
https://www.pantsbuild.org/v2.16/docs/reference-scala-infer#force_add_siblings_as_dependencies

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

description:
Add dependency on the package object to every target
https://www.pantsbuild.org/v2.16/docs/reference-scala-infer#package_objects

description: The Scala compiler.

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

description:
A dictionary, whose keys are the names of each JVM resolve that requires default `scalac` plugins, and the value is a comma-separated string consisting of scalac plugin names
https://www.pantsbuild.org/v2.16/docs/reference-scalac#plugins_for_resolve

description: scalafmt (https://scalameta.org/scalafmt/)

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-scalafmt#artifacts

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

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

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

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

description: The Scalatest test framework (https://www.scalatest.org/)

description:
Arguments to pass directly to Scalatest, e.g. `--scalatest-args='-t $testname'`
https://www.pantsbuild.org/v2.16/docs/reference-scalatest#args

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-scalatest#artifacts

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

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

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

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

description: The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc).

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

description:
Known versions to verify downloads against
https://www.pantsbuild.org/v2.16/docs/reference-scc#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-scc#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-scc#url_template

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

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

description: Options to control how setup.py is generated from a `python_distribution` target.

description:
What version to set in `install_requires` when a `python_distribution` depends on other `python_distribution`s
https://www.pantsbuild.org/v2.16/docs/reference-setup-py-generation#first_party_dependency_version_scheme

description:
The default value for the `generate_setup` field on `python_distribution` targets
https://www.pantsbuild.org/v2.16/docs/reference-setup-py-generation#generate_setup_default

description: Python setuptools, used to package `python_distribution` targets.

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

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-setuptools#requirements

description: A tool for generating versions from VCS metadata (https://github.com/pypa/setuptools_scm).

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

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

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

description:
Python interpreter constraints for this tool
https://www.pantsbuild.org/v2.16/docs/reference-setuptools-scm#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-setuptools-scm#requirements

description: Options for Pants's Shell support.

description:
Infer Shell dependencies on other Shell files by analyzing `source` statements
https://www.pantsbuild.org/v2.16/docs/reference-shell-setup#dependency_inference

description:
The PATH value that will be used to find shells and to run certain processes like the shunit2 test runner
https://www.pantsbuild.org/v2.16/docs/reference-shell-setup#executable_search_path

description:
If true, add `shell_sources` and `shunit2_tests` targets with the `tailor` goal
https://www.pantsbuild.org/v2.16/docs/reference-shell-setup#tailor

description: Options for Pants' Shell test support.

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

description: A linter for shell scripts.

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

description:
If true, Pants will include all relevant `.shellcheckrc` and `shellcheckrc` files during runs
https://www.pantsbuild.org/v2.16/docs/reference-shellcheck#config_discovery

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

description:
If true, don't use Shellcheck when running `pants lint`
https://www.pantsbuild.org/v2.16/docs/reference-shellcheck#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-shellcheck#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-shellcheck#url_template

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

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

description: An autoformatter for shell scripts (https://github.com/mvdan/sh).

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

description:
If true, Pants will include all relevant `.editorconfig` files during runs
https://www.pantsbuild.org/v2.16/docs/reference-shfmt#config_discovery

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

description:
If true, don't use shfmt when running `pants fmt` and `pants lint`
https://www.pantsbuild.org/v2.16/docs/reference-shfmt#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-shfmt#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-shfmt#url_template

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

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

description: shUnit2 is a xUnit framework for Bourne based shell scripts (https://github.com/kward/shunit2)

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

description:
If true, don't use shunit2 when running `pants test`
https://www.pantsbuild.org/v2.16/docs/reference-shunit2#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-shunit2#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-shunit2#url_template

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

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

description: Configuration for roots of source trees.

description:
The presence of a file of this name in a directory indicates that the directory is a source root
https://www.pantsbuild.org/v2.16/docs/reference-source#marker_filenames

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

description:
A list of source root suffixes
https://www.pantsbuild.org/v2.16/docs/reference-source#root_patterns

description: An aggregator for Pants stats, such as cache metrics.

description:
At the end of the Pants run, log all counter metrics and summaries of observation histograms, e.g. the number of cache hits and the time saved by caching
https://www.pantsbuild.org/v2.16/docs/reference-stats#log

description:
At the end of the Pants run, report a summary of memory usage
https://www.pantsbuild.org/v2.16/docs/reference-stats#memory_summary

description: Environment settings for forked subprocesses.

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

description:
Auto-generate BUILD file targets for new source files.

Each specific `tailor` implementation may be disabled through language-specific options, e.g. `[python].tailor_pex_binary_targets` and `[shell-setup].tailor`.

description:
A mapping from standard target type to custom type to use instead
https://www.pantsbuild.org/v2.16/docs/reference-tailor#alias_mapping

description:
A header, e.g., a copyright notice, to add to the content of created BUILD files
https://www.pantsbuild.org/v2.16/docs/reference-tailor#build_file_header

description:
The indent to use when auto-editing BUILD files
https://www.pantsbuild.org/v2.16/docs/reference-tailor#build_file_indent

description:
The name to use for generated BUILD files
https://www.pantsbuild.org/v2.16/docs/reference-tailor#build_file_name

description:
Do not write changes to disk, only write back what would change
https://www.pantsbuild.org/v2.16/docs/reference-tailor#check

description:
Do not add these target definitions
https://www.pantsbuild.org/v2.16/docs/reference-tailor#ignore_adding_targets

description:
Do not edit or create BUILD files at these paths
https://www.pantsbuild.org/v2.16/docs/reference-tailor#ignore_paths

description: Run tests.

description:
The target maximum number of files to be included in each run of batch-enabled test runners
https://www.pantsbuild.org/v2.16/docs/reference-test#batch_size

description:
Run tests sequentially in an interactive process
https://www.pantsbuild.org/v2.16/docs/reference-test#debug

description:
Run tests sequentially in an interactive process, using a Debug Adapter (https://microsoft.github.io/debug-adapter-protocol/) for the language if supported
https://www.pantsbuild.org/v2.16/docs/reference-test#debug_adapter

description:
Additional environment variables to include in test processes
https://www.pantsbuild.org/v2.16/docs/reference-test#extra_env_vars

description:
Force the tests to run, even if they could be satisfied from cache
https://www.pantsbuild.org/v2.16/docs/reference-test#force

description:
If a coverage report file is generated, open it on the local system if the system supports this
https://www.pantsbuild.org/v2.16/docs/reference-test#open_coverage

description:
Show stdout/stderr for these tests
https://www.pantsbuild.org/v2.16/docs/reference-test#output

description:
Write test reports to --report-dir
https://www.pantsbuild.org/v2.16/docs/reference-test#report

description:
Path to write test reports to
https://www.pantsbuild.org/v2.16/docs/reference-test#report_dir

description:
A shard specification of the form "k/N", where N is a positive integer and k is a non-negative integer less than N
https://www.pantsbuild.org/v2.16/docs/reference-test#shard

description:
The default timeout (in seconds) for a test target if the `timeout` field is not set on the target
https://www.pantsbuild.org/v2.16/docs/reference-test#timeout_default

description:
The maximum timeout (in seconds) that may be used on a test target
https://www.pantsbuild.org/v2.16/docs/reference-test#timeout_maximum

description:
Enable test target timeouts
https://www.pantsbuild.org/v2.16/docs/reference-test#timeouts

description:
Generate a coverage report if the test runner supports it
https://www.pantsbuild.org/v2.16/docs/reference-test#use_coverage

description: The utility for publishing Python distributions to PyPI and other Python repositories.

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

description:
Path to a file containing PEM-format CA certificates used for verifying secure connections when publishing python distributions
https://www.pantsbuild.org/v2.16/docs/reference-twine#ca_certs_path

description:
Path to a .pypirc config file to use. (https://packaging.python.org/specifications/pypirc/)
https://www.pantsbuild.org/v2.16/docs/reference-twine#config

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

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

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

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

description:
Python interpreter constraints for this tool
https://www.pantsbuild.org/v2.16/docs/reference-twine#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-twine#requirements

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

description:
Format and fix safe deprecations in BUILD files.

This does not handle the full Pants upgrade. You must still manually change `pants_version` in `pants.toml` and you may need to manually address some deprecations. See https://www.pantsbuild.org/v2.16/docs/upgrade-tips for upgrade tips.

This goal is run without arguments. It will run over all BUILD files in your project.

description:
Do not write changes to disk, only write back what would change
https://www.pantsbuild.org/v2.16/docs/reference-update-build-files#check

description:
Automatically fix deprecations, such as target type renames, that are safe because they do not change semantics
https://www.pantsbuild.org/v2.16/docs/reference-update-build-files#fix_safe_deprecations

description:
Format BUILD files using Black or Yapf
https://www.pantsbuild.org/v2.16/docs/reference-update-build-files#fmt

description:
Which formatter Pants should use to format BUILD files
https://www.pantsbuild.org/v2.16/docs/reference-update-build-files#formatter

description: Display Pants version.

description: A formatter for Python files (https://github.com/google/yapf).

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

description:
Path to style file understood by yapf (https://github.com/google/yapf#formatting-style/)
https://www.pantsbuild.org/v2.16/docs/reference-yapf#config

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

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

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

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

description:
Python interpreter constraints for this tool
https://www.pantsbuild.org/v2.16/docs/reference-yapf#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-yapf#requirements

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


drupal-libraries.json

type: object

title: The library version

type: string

type: number

title: The library repository URL

title: The human-readable name of the license

title: The URL of the license file/information for the version of the library used

title: A boolean for whether this library is GPL compatible

type: boolean

title: A boolean for whether the script must be included in the header

title: Settings that needs to be attached to drupalSettings object in JavaScript

title: List of JavaScript files to load

$ref: #/definitions/file

title: List of CSS files to load

$ref: #/definitions/cssFiles

title: List libraries that should be loaded along with this library

type: array

title: Optional attributes

title: Load asset conditionally based on browser

title: Whether the asset is already minified

title: The source of the asset

title: Whether the assets should be aggregated

title: The order relative to other assets

type: integer

title: The SMACSS group in which the asset is placed

title: Media type

enum: all screen print speech

title: JSON schema for Drupal libraries file