Pantsbuild

Silence warnings/errors about running Pants on these versions of macOS. Pants only supports recent versions of macOS. You can try running on older versions, but it may or may not work https://www.pantsbuild.org/v2.31/docs/reference-global#allow_deprecated_macos_versions

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

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

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

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

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.31/docs/reference-global#ca_certs_path

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

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

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

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

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

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

Enable fine grained target analysis based on line numbers https://www.pantsbuild.org/v2.31/docs/reference-global#enable_target_origin_sources_blocks

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

When Pants downloads files (for example, for the http_source source), Pants will retry the download if a "retryable" error occurs https://www.pantsbuild.org/v2.31/docs/reference-global#file_downloads_max_attempts

When Pants downloads files (for example, for the http_source source), Pants will retry the download if a "retryable" error occurs https://www.pantsbuild.org/v2.31/docs/reference-global#file_downloads_retry_delay

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Include patterns from .gitignore, .git/info/exclude, and the global gitignore files in the option [GLOBAL].pants_ignore, which is used for Pants to ignore filesystem operations on those patterns https://www.pantsbuild.org/v2.31/docs/reference-global#pants_ignore_use_gitignore

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

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

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

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

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.31/docs/reference-global#pantsd

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

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

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

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

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

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

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.31/docs/reference-global#plugins

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

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

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

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.31/docs/reference-global#process_execution_graceful_shutdown_timeout

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

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

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

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

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

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

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.31/docs/reference-global#remote_ca_certs_path

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

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

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

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

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

Path to a PEM file containing client certificates used for verifying secure connections to [GLOBAL].remote_execution_address and [GLOBAL].remote_store_address when using client authentication (mTLS) https://www.pantsbuild.org/v2.31/docs/reference-global#remote_client_certs_path

Path to a PEM file containing a private key used for verifying secure connections to [GLOBAL].remote_execution_address and [GLOBAL].remote_store_address when using client authentication (mTLS) https://www.pantsbuild.org/v2.31/docs/reference-global#remote_client_key_path

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

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

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

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

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

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

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

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

An oauth token to use for gGRPC connections to [GLOBAL].remote_execution_address and [GLOBAL].remote_store_address https://www.pantsbuild.org/v2.31/docs/reference-global#remote_oauth_bearer_token

The type of provider to use, if using a remote cache and/or remote execution, See https://www.pantsbuild.org/2.31/docs/using-pants/remote-caching-and-execution for details https://www.pantsbuild.org/v2.31/docs/reference-global#remote_provider

The URI of a server/entity used as a remote file store https://www.pantsbuild.org/v2.31/docs/reference-global#remote_store_address

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.31/docs/reference-global#remote_store_batch_api_size_limit

Whether to enable batch load requests to the remote store https://www.pantsbuild.org/v2.31/docs/reference-global#remote_store_batch_load_enabled

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

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

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

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

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

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

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

Enables use of the sandboxer process https://www.pantsbuild.org/v2.31/docs/reference-global#sandboxer

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.31/docs/reference-global#session_end_tasks_timeout

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

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

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

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

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

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

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

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

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.31/docs/reference-global#unmatched_build_file_globs

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Arguments to pass directly to Buildifier, e.g. --buildifier-args='-lint=fix' https://www.pantsbuild.org/v2.31/docs/reference-buildifier#args

Known versions to verify downloads against https://www.pantsbuild.org/v2.31/docs/reference-buildifier#known_versions

If true, don't use Buildifier when running pants fmt https://www.pantsbuild.org/v2.31/docs/reference-buildifier#skip

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

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

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

Use this version of Buildifier https://www.pantsbuild.org/v2.31/docs/reference-buildifier#version

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

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

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

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

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

Which shell completion type should be printed to stdout https://www.pantsbuild.org/v2.31/docs/reference-complete#shell

The JVM index to be used by Coursier https://www.pantsbuild.org/v2.31/docs/reference-coursier#jvm_index

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

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

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

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

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

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

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

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

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

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

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

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.31/docs/reference-coverage-py#filter

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Output format for listing dependencies https://www.pantsbuild.org/v2.31/docs/reference-dependencies#format

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

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

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

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

Output format for listing dependents https://www.pantsbuild.org/v2.31/docs/reference-dependents#format

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

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

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

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

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

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

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

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

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

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

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

Hosts entries to be added to the /etc/hosts file in all built images https://www.pantsbuild.org/v2.31/docs/reference-docker#build_hosts

Do not use the Docker cache when building images https://www.pantsbuild.org/v2.31/docs/reference-docker#build_no_cache

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.31/docs/reference-docker#build_target_stage

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

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

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

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

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

List any additional executables which are not mandatory for Docker to work, but which should be included if available https://www.pantsbuild.org/v2.31/docs/reference-docker#optional_tools

If true, publish images non-interactively https://www.pantsbuild.org/v2.31/docs/reference-docker#publish_noninteractively

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

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

When true and, the docker_image build fails, enrich the logs with suggestions for renaming source file COPY instructions where possible https://www.pantsbuild.org/v2.31/docs/reference-docker#suggest_renames

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

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

Use buildx (and BuildKit) for builds https://www.pantsbuild.org/v2.31/docs/reference-docker#use_buildx

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

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

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

Use the new Rust-based, multithreaded, in-process dependency parser https://www.pantsbuild.org/v2.31/docs/reference-dockerfile-parser#use_rust_parser

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

If true, perform a dry run without deploying anything https://www.pantsbuild.org/v2.31/docs/reference-experimental-deploy#dry_run

If false, don't publish target dependencies before deploying the target https://www.pantsbuild.org/v2.31/docs/reference-experimental-deploy#publish_dependencies

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

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

Export the specified binaries https://www.pantsbuild.org/v2.31/docs/reference-export#bin

When exporting a mutable virtualenv for a resolve, do PEP-660 editable installs of all python_distribution targets that own code in the exported resolve https://www.pantsbuild.org/v2.31/docs/reference-export#py_editable_in_resolve

When exporting a mutable virtualenv for a resolve listed in this option, generate sources which result from code generation (for example, the protobuf_sources and thrift_sources target types) into the mutable virtualenv exported for that resolve https://www.pantsbuild.org/v2.31/docs/reference-export#py_generated_sources_in_resolve

When exporting a mutable virtualenv for a resolve listed in this option, by default console script shebang lines will be made "hermetic" https://www.pantsbuild.org/v2.31/docs/reference-export#py_non_hermetic_scripts_in_resolve

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

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

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

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

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

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

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

Filter targets based on each target's address matching the provided regular expressions https://www.pantsbuild.org/v2.31/docs/reference-filter#address_regex

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

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

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

Filter targets based on whether any of each target's tags (in the target's tags field) matches the provided regular expressions https://www.pantsbuild.org/v2.31/docs/reference-filter#tag_regex

Filter targets based each targets's target type, e.g. resources or python_sources https://www.pantsbuild.org/v2.31/docs/reference-filter#target_type

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

If set, lockfile metadata 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.31/docs/reference-generate-lockfiles#custom_command

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

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

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

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

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

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

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

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.31/docs/reference-go-test#coverage_html

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

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

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

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.31/docs/reference-go-test#force_asan

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.31/docs/reference-go-test#force_msan

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.31/docs/reference-go-test#force_race

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

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

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

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

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

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

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

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.31/docs/reference-golang#asdf_bin_relpath

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.31/docs/reference-golang#asdf_tool_name

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

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

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

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

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

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

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

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

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

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

List any additional executable tools required for the go tool to work https://www.pantsbuild.org/v2.31/docs/reference-golang#extra_tools

A list of paths to search for Go and extra tools needed by go https://www.pantsbuild.org/v2.31/docs/reference-golang#go_search_paths

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

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

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.31/docs/reference-golang#tailor_binary_targets

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

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

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

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.31/docs/reference-google-java-format#artifacts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.31/docs/reference-jar_tool#artifacts

List of JVM options to pass to jar_tool JVM processes https://www.pantsbuild.org/v2.31/docs/reference-jar_tool#jvm_options

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

Version string for the tool https://www.pantsbuild.org/v2.31/docs/reference-jar_tool#version

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.31/docs/reference-jarjar#artifacts

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

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

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

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

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

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

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

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

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.31/docs/reference-java-parser#artifacts

List of JVM options to pass to java-parser JVM processes https://www.pantsbuild.org/v2.31/docs/reference-java-parser#jvm_options

Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.31/docs/reference-java-parser#lockfile

Version string for the tool https://www.pantsbuild.org/v2.31/docs/reference-java-parser#version

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

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

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

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.31/docs/reference-junit#artifacts

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

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

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

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

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

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

A list of patterns to exclude from all deploy jars https://www.pantsbuild.org/v2.31/docs/reference-jvm#deploy_jar_exclude_files

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

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

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

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

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

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

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

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

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

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

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

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

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

Dump the migration plan as JSON https://www.pantsbuild.org/v2.31/docs/reference-migrate-call-by-name#json

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

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

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

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

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

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

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

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

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

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

Environment variables to set for corepack invocations https://www.pantsbuild.org/v2.31/docs/reference-nodejs#corepack_env_vars

The PATH value that will be used to find any tools required to run nodejs processes https://www.pantsbuild.org/v2.31/docs/reference-nodejs#executable_search_paths

Environment variables to set during package manager operations https://www.pantsbuild.org/v2.31/docs/reference-nodejs#extra_env_vars

Known versions to verify downloads against https://www.pantsbuild.org/v2.31/docs/reference-nodejs#known_versions

List any additional executable which are not mandatory for node processes to work, but which should be included if available https://www.pantsbuild.org/v2.31/docs/reference-nodejs#optional_tools

Default Node.js package manager to use https://www.pantsbuild.org/v2.31/docs/reference-nodejs#package_manager

A mapping of package manager versions to semver releases https://www.pantsbuild.org/v2.31/docs/reference-nodejs#package_managers

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

A list of paths to search for Node.js distributions https://www.pantsbuild.org/v2.31/docs/reference-nodejs#search_path

List any additional executable tools required for node processes to work https://www.pantsbuild.org/v2.31/docs/reference-nodejs#tools

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

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

Use this version of nodejs https://www.pantsbuild.org/v2.31/docs/reference-nodejs#version

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

Infer a package_json's dependencies by parsing entry point statements from the package.json file https://www.pantsbuild.org/v2.31/docs/reference-nodejs-infer#package_json_entry_points

How to handle imports that don't have an inferable owner https://www.pantsbuild.org/v2.31/docs/reference-nodejs-infer#unowned_dependency_behavior

Path to write the NodeJS coverage reports to https://www.pantsbuild.org/v2.31/docs/reference-nodejs-test#coverage_output_dir

If true, don't use Node.js tests when running pants test https://www.pantsbuild.org/v2.31/docs/reference-nodejs-test#skip

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

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

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

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

Whether to include additional information generated by plugins https://www.pantsbuild.org/v2.31/docs/reference-peek#include_additional_info

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

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

If warnings from Pex should be logged by Pants to the console https://www.pantsbuild.org/v2.31/docs/reference-pex#emit_warnings

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

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

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

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

Arguments to pass directly to pex, e.g. --pex-cli-args='--check=error --no-compile' https://www.pantsbuild.org/v2.31/docs/reference-pex-cli#global_args

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

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

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

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

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

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

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

Arguments to pass directly to Prettier, e.g. --prettier-args='--version' https://www.pantsbuild.org/v2.31/docs/reference-prettier#args

Override the binary to run for this tool https://www.pantsbuild.org/v2.31/docs/reference-prettier#binary_name

If specified, install the tool using the lockfile for this named resolve, instead of the version configured in this subsystem https://www.pantsbuild.org/v2.31/docs/reference-prettier#install_from_resolve

If true, don't use Prettier when running pants fmt and pants lint https://www.pantsbuild.org/v2.31/docs/reference-prettier#skip

Version string for the tool in the form package@version (e.g. [email protected]) https://www.pantsbuild.org/v2.31/docs/reference-prettier#version

Show stdout/stderr when publishing with noninteractively https://www.pantsbuild.org/v2.31/docs/reference-publish#noninteractive_process_output

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

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

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

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

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

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

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

Python interpreter constraints for this tool https://www.pantsbuild.org/v2.31/docs/reference-pyoxidizer#interpreter_constraints

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

If true, treat pytest exit code 5 ("No tests were collected") as success https://www.pantsbuild.org/v2.31/docs/reference-pytest#allow_empty_test_collection

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

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.31/docs/reference-pytest#config

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

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

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

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.31/docs/reference-pytest#execution_slot_var

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

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

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

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

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.31/docs/reference-pytest#xdist_enabled

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

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

For Python targets with both resolve and interpreter_constraints fields, default to using the interpreter_constraints field of the resolve if interpreter_constraints is not set on the target itself https://www.pantsbuild.org/v2.31/docs/reference-python#default_to_resolve_interpreter_constraints

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

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

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

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.31/docs/reference-python#interpreter_versions_universe

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.31/docs/reference-python#invalid_lockfile_behavior

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

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

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

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

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

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

The platforms the built PEX should be compatible with when generating lockfiles https://www.pantsbuild.org/v2.31/docs/reference-python#resolves_to_complete_platforms

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

Specifies requirements to exclude from a resolve and its https://www.pantsbuild.org/v2.31/docs/reference-python#resolves_to_excludes

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

The style of lock to generate https://www.pantsbuild.org/v2.31/docs/reference-python#resolves_to_lock_style

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

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.31/docs/reference-python#resolves_to_only_binary

Specifies a transitive requirement to override in a resolve https://www.pantsbuild.org/v2.31/docs/reference-python#resolves_to_overrides

Defines a limited scope to use a named find links repo or https://www.pantsbuild.org/v2.31/docs/reference-python#resolves_to_sources

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.31/docs/reference-python#run_against_entire_lockfile

If set, lockfile metadata will be written to a separate sibling file, rather than prepended as a header to the lockfile (which has various disadvantages) https://www.pantsbuild.org/v2.31/docs/reference-python#separate_lockfile_metadata_file

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.31/docs/reference-python#tailor_ignore_empty_init_files

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.31/docs/reference-python#tailor_pex_binary_targets

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

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

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

True if Pants should generate a deprecation warning when Python 2.x is used in interpreter constraints https://www.pantsbuild.org/v2.31/docs/reference-python#warn_on_python2_usage

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

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

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

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

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

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.31/docs/reference-python-infer#assets

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

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

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

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

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

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.31/docs/reference-python-infer#init_files

Infer a target's dependencies based on strings that look like dynamic dependencies, such as Django settings files expressing dependencies as strings or pytest plugins listed in the pytest_plugins variable in a test module or a conftest file https://www.pantsbuild.org/v2.31/docs/reference-python-infer#string_imports

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.31/docs/reference-python-infer#string_imports_min_dots

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

Use the new Rust-based, multithreaded, in-process dependency parser https://www.pantsbuild.org/v2.31/docs/reference-python-infer#use_rust_parser

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

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

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

URLs of PEP-503 compatible code repository indexes to look for requirements https://www.pantsbuild.org/v2.31/docs/reference-python-repos#indexes

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

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

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

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

Arguments to pass directly to the repl program, e.g. --repl-args='-i helloworld/main.py' https://www.pantsbuild.org/v2.31/docs/reference-repl#args

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

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

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

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

Arguments to pass directly to Ruff, e.g. --ruff-args='--exclude=foo --ignore=E501' https://www.pantsbuild.org/v2.31/docs/reference-ruff#args

Path to the pyproject.toml or ruff.toml file to use for configuration (https://github.com/astral-sh/ruff#configuration) https://www.pantsbuild.org/v2.31/docs/reference-ruff#config

If true, Pants will include any relevant config files during runs (pyproject.toml, and ruff.toml) https://www.pantsbuild.org/v2.31/docs/reference-ruff#config_discovery

Known versions to verify downloads against https://www.pantsbuild.org/v2.31/docs/reference-ruff#known_versions

If true, don't use Ruff when running pants fmt and pants fix and pants lint https://www.pantsbuild.org/v2.31/docs/reference-ruff#skip

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

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

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

Use this version of Ruff https://www.pantsbuild.org/v2.31/docs/reference-ruff#version

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

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.31/docs/reference-run#debug_adapter

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

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.31/docs/reference-scala#version_for_resolve

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

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

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

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

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.31/docs/reference-scala-parser#artifacts

List of JVM options to pass to scala-parser JVM processes https://www.pantsbuild.org/v2.31/docs/reference-scala-parser#jvm_options

Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.31/docs/reference-scala-parser#lockfile

Version string for the tool https://www.pantsbuild.org/v2.31/docs/reference-scala-parser#version

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

A dictionary mapping JVM resolve names to additional arguments to pass to scalac for that resolve https://www.pantsbuild.org/v2.31/docs/reference-scalac#args_for_resolve

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.31/docs/reference-scalac#plugins_for_resolve

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.31/docs/reference-scalafix#artifacts

Name of a config file understood by scalafix (https://scalacenter.github.io/scalafix/docs/users/configuration.html) https://www.pantsbuild.org/v2.31/docs/reference-scalafix#config_file_name

List of JVM options to pass to scalafix JVM processes https://www.pantsbuild.org/v2.31/docs/reference-scalafix#jvm_options

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

Whether to ignore, error or show a warning when files are found that are not covered by the config file provided in [scalafix].config_file_name setting https://www.pantsbuild.org/v2.31/docs/reference-scalafix#orphan_files_behavior

List of targets providing additional Scalafix rules https://www.pantsbuild.org/v2.31/docs/reference-scalafix#rule_targets

Whether semantic rules are enabled or not https://www.pantsbuild.org/v2.31/docs/reference-scalafix#semantic_rules

If true, don't use scalafix when running pants fix and pants lint https://www.pantsbuild.org/v2.31/docs/reference-scalafix#skip

Version string for the tool https://www.pantsbuild.org/v2.31/docs/reference-scalafix#version

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.31/docs/reference-scalafmt#artifacts

Name of a config file understood by scalafmt (https://scalameta.org/scalafmt/docs/configuration.html) https://www.pantsbuild.org/v2.31/docs/reference-scalafmt#config_file_name

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

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

Whether to ignore, error or show a warning when files are found that are not covered by the config file provided in [scalafmt].config_file_name setting https://www.pantsbuild.org/v2.31/docs/reference-scalafmt#orphan_files_behavior

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

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

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

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.31/docs/reference-scalatest#artifacts

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

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

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

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

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

Known versions to verify downloads against https://www.pantsbuild.org/v2.31/docs/reference-scc#known_versions

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

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

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

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

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

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

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

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

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

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

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

Python interpreter constraints for this tool https://www.pantsbuild.org/v2.31/docs/reference-setuptools-scm#interpreter_constraints

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

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

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.31/docs/reference-shell-setup#executable_search_paths

If true, add shunit2_tests targets with the tailor goal https://www.pantsbuild.org/v2.31/docs/reference-shell-setup#tailor_shunit2_tests

If true, add shell_sources targets with the tailor goal https://www.pantsbuild.org/v2.31/docs/reference-shell-setup#tailor_sources

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

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

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

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

If true, don't use Shellcheck when running pants lint https://www.pantsbuild.org/v2.31/docs/reference-shellcheck#skip

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

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

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

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

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

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

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

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

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

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

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

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

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

If true, don't use shunit2 when running pants test https://www.pantsbuild.org/v2.31/docs/reference-shunit2#skip

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

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

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

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

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

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

Output format for reporting stats https://www.pantsbuild.org/v2.31/docs/reference-stats#format

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.31/docs/reference-stats#log

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

Output the stats to this file https://www.pantsbuild.org/v2.31/docs/reference-stats#output_file

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.31/docs/reference-strip-jar#artifacts

List of JVM options to pass to strip-jar JVM processes https://www.pantsbuild.org/v2.31/docs/reference-strip-jar#jvm_options

Path to a lockfile used for installing the tool https://www.pantsbuild.org/v2.31/docs/reference-strip-jar#lockfile

Version string for the tool https://www.pantsbuild.org/v2.31/docs/reference-strip-jar#version

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

The PATH value that will searched for executables https://www.pantsbuild.org/v2.31/docs/reference-system-binaries#system_binary_paths

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

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

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

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

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

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

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

Arguments to pass directly to Taplo, e.g. --taplo-args='--option=align_entries=false' https://www.pantsbuild.org/v2.31/docs/reference-taplo#args

If true, Pants will include a taplo.toml or .taplo.toml file found in the build root during a run https://www.pantsbuild.org/v2.31/docs/reference-taplo#config_discovery

A list of glob patterns of files to include/exclude in formatting relative to the build root https://www.pantsbuild.org/v2.31/docs/reference-taplo#glob_pattern

Known versions to verify downloads against https://www.pantsbuild.org/v2.31/docs/reference-taplo#known_versions

If true, don't use Taplo when running pants fmt and pants lint https://www.pantsbuild.org/v2.31/docs/reference-taplo#skip

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

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

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

Use this version of Taplo https://www.pantsbuild.org/v2.31/docs/reference-taplo#version

The number of attempts to run tests, in case of a test failure https://www.pantsbuild.org/v2.31/docs/reference-test#attempts_default

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

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

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.31/docs/reference-test#debug_adapter

Report information about the test results https://www.pantsbuild.org/v2.31/docs/reference-test#experimental_report_test_result_info

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

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

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

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

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

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

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.31/docs/reference-test#shard

If tests fail, show an appropriate pants test ... invocation to rerun just those tests https://www.pantsbuild.org/v2.31/docs/reference-test#show_rerun_command

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

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

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

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

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

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

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

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

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

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