Formatter Validator Minifier Escape / Unescape JSON ↔ String JSON ↔ YAML JSON → CSV NDJSON / JSON Lines JSON → Types JSON ↔ XML JSON Diff JSON Patch Canonicalize (RFC 8785) Schema Validator Schema Generator JSONPath Tester JWT Decoder JSON Errors Schemas More Tools
JSONTools / Schema registry / Pantsbuild
Schema registry

Pantsbuild

Pantsbuild configuration file

pants*.toml

Check your file against this schema

Opens the validator with this schema already loaded. Paste your pants*.toml and it validates in your browser — nothing is uploaded.

Validate a pants*.toml → View raw schema

Fields (first 250)

Generated directly from the schema, following local $refs, to two levels of nesting. This schema is large — the table is truncated; use the raw schema for the rest.

Field Type Description
GLOBALobjectOptions to control the overall behavior of Pants.
GLOBAL.allow_deprecated_macos_versionsarraySilence 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
default: []
GLOBAL.backend_packagesarrayRegister functionality from these backends https://www.pantsbuild.org/v2.32/docs/reference-global#backend_packages
default: []
GLOBAL.build_file_prelude_globsarrayPython files to evaluate and whose symbols should be exposed to all BUILD files https://www.pantsbuild.org/v2.32/docs/reference-global#build_file_prelude_globs
default: []
GLOBAL.build_ignorearrayPath globs or literals to ignore when identifying BUILD files https://www.pantsbuild.org/v2.32/docs/reference-global#build_ignore
default: []
GLOBAL.build_patternsarrayThe naming scheme for BUILD files, i.e. where you define targets https://www.pantsbuild.org/v2.32/docs/reference-global#build_patterns
default: ["BUILD", "BUILD.*"]
GLOBAL.ca_certs_pathstringPath 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.32/docs/reference-global#ca_certs_path
default: null
GLOBAL.cache_content_behaviorenumControls how the content of cache entries is handled during process execution https://www.pantsbuild.org/v2.32/docs/reference-global#cache_content_behavior
default: "fetch"
one of: "fetch", "validate", "defer"
GLOBAL.colorsbooleanWhether Pants should use colors in output or not https://www.pantsbuild.org/v2.32/docs/reference-global#colors
default: false
GLOBAL.concurrentbooleanEnable concurrent runs of Pants https://www.pantsbuild.org/v2.32/docs/reference-global#concurrent
default: false
GLOBAL.docker_executionbooleanIf true, `docker_environment` targets can be used to run builds inside a Docker container https://www.pantsbuild.org/v2.32/docs/reference-global#docker_execution
default: true
GLOBAL.dynamic_uibooleanDisplay a dynamically-updating console UI as Pants runs https://www.pantsbuild.org/v2.32/docs/reference-global#dynamic_ui
default: true
GLOBAL.dynamic_ui_rendererenumIf `--dynamic-ui` is enabled, selects the renderer https://www.pantsbuild.org/v2.32/docs/reference-global#dynamic_ui_renderer
default: "indicatif-spinner"
one of: "indicatif-spinner…, "experimental-prod…
GLOBAL.enable_stack_trampolinestringEnable `sys.activate_stack_trampoline` for Pants's own Python https://www.pantsbuild.org/v2.32/docs/reference-global#enable_stack_trampoline
default: null
GLOBAL.enable_target_origin_sources_blocksbooleanEnable fine grained target analysis based on line numbers https://www.pantsbuild.org/v2.32/docs/reference-global#enable_target_origin_sources_blocks
default: false
GLOBAL.engine_visualize_toanyA directory to write execution and rule graphs to as `dot` files https://www.pantsbuild.org/v2.32/docs/reference-global#engine_visualize_to
default: null
GLOBAL.file_downloads_max_attemptsnumberWhen 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.32/docs/reference-global#file_downloads_max_attempts
default: 4
GLOBAL.file_downloads_retry_delaynumberWhen 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.32/docs/reference-global#file_downloads_retry_delay
default: 0.2
GLOBAL.ignore_warningsarrayIgnore logs and warnings matching these strings https://www.pantsbuild.org/v2.32/docs/reference-global#ignore_warnings
default: []
GLOBAL.keep_sandboxesenumControls whether Pants will clean up local directories used as chroots for running processes https://www.pantsbuild.org/v2.32/docs/reference-global#keep_sandboxes
default: "never"
one of: "always", "on_failure", "never"
GLOBAL.levelenumSet the logging level https://www.pantsbuild.org/v2.32/docs/reference-global#level
default: "info"
one of: "trace", "debug", "info", "warn", "error"
GLOBAL.local_cachebooleanWhether to cache process executions in a local cache persisted to disk at `--local-store-dir` https://www.pantsbuild.org/v2.32/docs/reference-global#local_cache
default: true
GLOBAL.local_execution_root_dirstringDirectory to use for local process execution sandboxing https://www.pantsbuild.org/v2.32/docs/reference-global#local_execution_root_dir
default: "<tmp_dir>"
GLOBAL.local_store_dirstringDirectory to use for the local file store, which stores the results of subprocesses run by Pants https://www.pantsbuild.org/v2.32/docs/reference-global#local_store_dir
default: "$XDG_CACHE_HOME/lmdb_store"
GLOBAL.local_store_directories_max_size_bytesnumberThe maximum size in bytes of the local store containing directories https://www.pantsbuild.org/v2.32/docs/reference-global#local_store_directories_max_size_bytes
default: 16000000000
GLOBAL.local_store_files_max_size_bytesnumberThe maximum size in bytes of the local store containing files https://www.pantsbuild.org/v2.32/docs/reference-global#local_store_files_max_size_bytes
default: 256000000000
GLOBAL.local_store_processes_max_size_bytesnumberThe maximum size in bytes of the local store containing process cache entries https://www.pantsbuild.org/v2.32/docs/reference-global#local_store_processes_max_size_bytes
default: 16000000000
GLOBAL.local_store_shard_countnumberThe number of LMDB shards created for the local store https://www.pantsbuild.org/v2.32/docs/reference-global#local_store_shard_count
default: 16
GLOBAL.log_levels_by_targetobjectSet a more specific logging level for one or more logging targets https://www.pantsbuild.org/v2.32/docs/reference-global#log_levels_by_target
default: {}
GLOBAL.log_show_rust_3rdpartybooleanWhether to show/hide logging done by 3rdparty Rust crates used by the Pants engine https://www.pantsbuild.org/v2.32/docs/reference-global#log_show_rust_3rdparty
default: false
GLOBAL.logdirstringWrite logs to files under this directory https://www.pantsbuild.org/v2.32/docs/reference-global#logdir
default: null
GLOBAL.loopbooleanRun goals continuously as file changes are detected https://www.pantsbuild.org/v2.32/docs/reference-global#loop
default: false
GLOBAL.loop_maxnumberThe maximum number of times to loop when `--loop` is specified https://www.pantsbuild.org/v2.32/docs/reference-global#loop_max
default: 4294967296
GLOBAL.named_caches_dirstringDirectory to use for named global caches for tools and processes with trusted, concurrency-safe caches https://www.pantsbuild.org/v2.32/docs/reference-global#named_caches_dir
default: "$XDG_CACHE_HOME/named_caches"
GLOBAL.pants_bin_namestringThe name of the script or binary used to invoke Pants https://www.pantsbuild.org/v2.32/docs/reference-global#pants_bin_name
default: "pants"
GLOBAL.pants_config_filesarrayPaths to Pants config files https://www.pantsbuild.org/v2.32/docs/reference-global#pants_config_files
default: ["<buildroot>/pants.toml"]
GLOBAL.pants_distdirstringWrite end products, such as the results of `pants package`, to this dir https://www.pantsbuild.org/v2.32/docs/reference-global#pants_distdir
default: "<buildroot>/dist"
GLOBAL.pants_ignorearrayPaths to ignore for all filesystem operations performed by pants (e.g https://www.pantsbuild.org/v2.32/docs/reference-global#pants_ignore
default: [".*/", "/dist/", "__pycache__", "!.semgrep/", "!.github/"]
GLOBAL.pants_ignore_use_gitignorebooleanInclude 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
default: true
GLOBAL.pants_physical_workdir_basestringWhen set, a base directory in which to store `--pants-workdir` contents https://www.pantsbuild.org/v2.32/docs/reference-global#pants_physical_workdir_base
default: null
GLOBAL.pants_subprocessdirstringThe directory to use for tracking subprocess metadata https://www.pantsbuild.org/v2.32/docs/reference-global#pants_subprocessdir
default: "<buildroot>/.pants.d/pids"
GLOBAL.pants_versionstringUse this Pants version https://www.pantsbuild.org/v2.32/docs/reference-global#pants_version
default: "<pants_version>"
GLOBAL.pants_workdirstringWrite intermediate logs and output files to this dir https://www.pantsbuild.org/v2.32/docs/reference-global#pants_workdir
default: "<buildroot>/.pants.d/workdir"
GLOBAL.pantsdbooleanEnables 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
default: true
GLOBAL.pantsd_invalidation_globsarrayFilesystem events matching any of these globs will trigger a daemon restart https://www.pantsbuild.org/v2.32/docs/reference-global#pantsd_invalidation_globs
default: []
GLOBAL.pantsd_max_memory_usageanyThe maximum memory usage of the pantsd process https://www.pantsbuild.org/v2.32/docs/reference-global#pantsd_max_memory_usage
default: "4GiB"
GLOBAL.pantsd_pailgun_portnumberThe port to bind the Pants nailgun server to https://www.pantsbuild.org/v2.32/docs/reference-global#pantsd_pailgun_port
default: 0
GLOBAL.pantsd_timeout_when_multiple_invocationsnumberThe maximum amount of time to wait for the invocation to start until raising a timeout exception https://www.pantsbuild.org/v2.32/docs/reference-global#pantsd_timeout_when_multiple_invocations
default: 60.0
GLOBAL.pantsrcbooleanUse pantsrc files located at the paths specified in the global option `pantsrc_files` https://www.pantsbuild.org/v2.32/docs/reference-global#pantsrc
default: true
GLOBAL.pantsrc_filesarrayOverride config with values from these files, using syntax matching that of `--pants-config-files` https://www.pantsbuild.org/v2.32/docs/reference-global#pantsrc_files
default: ["/etc/pantsrc", "~/.pants.rc", ".pants.rc"]
GLOBAL.pluginsarrayAllow 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.32/docs/reference-global#plugins
default: []
GLOBAL.plugins_force_resolvebooleanRe-resolve plugins, even if previously resolved https://www.pantsbuild.org/v2.32/docs/reference-global#plugins_force_resolve
default: false
GLOBAL.print_stacktracebooleanPrint the full exception stack trace for any errors https://www.pantsbuild.org/v2.32/docs/reference-global#print_stacktrace
default: false
GLOBAL.process_execution_cache_namespacestringThe cache namespace for process execution https://www.pantsbuild.org/v2.32/docs/reference-global#process_execution_cache_namespace
default: null
GLOBAL.process_execution_graceful_shutdown_timeoutnumberThe 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.32/docs/reference-global#process_execution_graceful_shutdown_timeout
default: 3
GLOBAL.process_execution_local_enable_nailgunbooleanWhether or not to use nailgun to run JVM requests that are marked as supporting nailgun https://www.pantsbuild.org/v2.32/docs/reference-global#process_execution_local_enable_nailgun
default: true
GLOBAL.process_execution_local_parallelismnumberNumber of concurrent processes that may be executed locally https://www.pantsbuild.org/v2.32/docs/reference-global#process_execution_local_parallelism
default: "#cores"
GLOBAL.process_execution_remote_parallelismnumberNumber of concurrent processes that may be executed remotely https://www.pantsbuild.org/v2.32/docs/reference-global#process_execution_remote_parallelism
default: 128
GLOBAL.process_per_child_memory_usageanyThe default memory usage for a single "pooled" child process https://www.pantsbuild.org/v2.32/docs/reference-global#process_per_child_memory_usage
default: "512MiB"
GLOBAL.process_total_child_memory_usageanyThe maximum memory usage for all "pooled" child processes https://www.pantsbuild.org/v2.32/docs/reference-global#process_total_child_memory_usage
default: null
GLOBAL.pythonpatharrayAdd these directories to PYTHONPATH to search for plugins https://www.pantsbuild.org/v2.32/docs/reference-global#pythonpath
default: []
GLOBAL.remote_ca_certs_pathstringPath 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.32/docs/reference-global#remote_ca_certs_path
default: null
GLOBAL.remote_cache_readbooleanWhether to enable reading from a remote cache https://www.pantsbuild.org/v2.32/docs/reference-global#remote_cache_read
default: false
GLOBAL.remote_cache_rpc_concurrencynumberThe number of concurrent requests allowed to the remote cache service https://www.pantsbuild.org/v2.32/docs/reference-global#remote_cache_rpc_concurrency
default: 128
GLOBAL.remote_cache_rpc_timeout_millisnumberTimeout value for remote cache RPCs in milliseconds https://www.pantsbuild.org/v2.32/docs/reference-global#remote_cache_rpc_timeout_millis
default: 1500
GLOBAL.remote_cache_warningsenumHow frequently to log remote cache failures at the `warn` log level https://www.pantsbuild.org/v2.32/docs/reference-global#remote_cache_warnings
default: "backoff"
one of: "ignore", "first_only", "backoff", "always"
GLOBAL.remote_cache_writebooleanWhether to enable writing results to a remote cache https://www.pantsbuild.org/v2.32/docs/reference-global#remote_cache_write
default: false
GLOBAL.remote_client_certs_pathstringPath 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)
default: null
GLOBAL.remote_client_key_pathstringPath 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)
default: null
GLOBAL.remote_executionbooleanEnables remote workers for increased parallelism. (Alpha) https://www.pantsbuild.org/v2.32/docs/reference-global#remote_execution
default: false
GLOBAL.remote_execution_addressstringThe URI of a server/entity used as a remote execution scheduler https://www.pantsbuild.org/v2.32/docs/reference-global#remote_execution_address
default: null
GLOBAL.remote_execution_append_only_caches_base_pathstringSets the base path to use when setting up an append-only cache for a process running remotely https://www.pantsbuild.org/v2.32/docs/reference-global#remote_execution_append_only_caches_base_path
default: null
GLOBAL.remote_execution_extra_platform_propertiesarrayPlatform properties to set on remote execution requests https://www.pantsbuild.org/v2.32/docs/reference-global#remote_execution_extra_platform_properties
default: []
GLOBAL.remote_execution_headersobjectHeaders to set on remote execution requests https://www.pantsbuild.org/v2.32/docs/reference-global#remote_execution_headers
default: "{}"
GLOBAL.remote_execution_overall_deadline_secsnumberOverall timeout in seconds for each remote execution request from time of submission https://www.pantsbuild.org/v2.32/docs/reference-global#remote_execution_overall_deadline_secs
default: 3600
GLOBAL.remote_execution_rpc_concurrencynumberThe number of concurrent requests allowed to the remote execution service https://www.pantsbuild.org/v2.32/docs/reference-global#remote_execution_rpc_concurrency
default: 128
GLOBAL.remote_instance_namestringName of the remote instance to use by remote caching and remote execution https://www.pantsbuild.org/v2.32/docs/reference-global#remote_instance_name
default: null
GLOBAL.remote_oauth_bearer_tokenstringAn oauth token to use for gGRPC connections to `[GLOBAL].remote_execution_address` and `[GLOBAL].remote_store_address` https://www.pantsbuild.org/v2.32/docs/reference-global#remote_oauth_bearer_token
default: null
GLOBAL.remote_providerenumThe type of provider to use, if using a remote cache and/or remote execution, See https://www.pantsbuild.org/2.32/docs/using-pants/remote-caching-and-execution for details
default: "reapi"
one of: "reapi", "experimental-file…, "experimental-gith…
GLOBAL.remote_store_addressstringThe URI of a server/entity used as a remote file store https://www.pantsbuild.org/v2.32/docs/reference-global#remote_store_address
default: null
GLOBAL.remote_store_batch_api_size_limitnumberThe maximum total size of blobs allowed to be sent in a single batch API call to the remote store https://www.pantsbuild.org/v2.32/docs/reference-global#remote_store_batch_api_size_limit
default: 4194304
GLOBAL.remote_store_batch_load_enabledbooleanWhether to enable batch load requests to the remote store https://www.pantsbuild.org/v2.32/docs/reference-global#remote_store_batch_load_enabled
default: false
GLOBAL.remote_store_chunk_bytesnumberSize in bytes of chunks transferred to/from the remote file store https://www.pantsbuild.org/v2.32/docs/reference-global#remote_store_chunk_bytes
default: 1048576
GLOBAL.remote_store_headersobjectHeaders to set on remote store requests https://www.pantsbuild.org/v2.32/docs/reference-global#remote_store_headers
default: "{}"
GLOBAL.remote_store_rpc_concurrencynumberThe number of concurrent requests allowed to the remote store service https://www.pantsbuild.org/v2.32/docs/reference-global#remote_store_rpc_concurrency
default: 128
GLOBAL.remote_store_rpc_retriesnumberNumber of times to retry any RPC to the remote store before giving up https://www.pantsbuild.org/v2.32/docs/reference-global#remote_store_rpc_retries
default: 2
GLOBAL.remote_store_rpc_timeout_millisnumberTimeout value for remote store RPCs (not including streaming requests) in milliseconds https://www.pantsbuild.org/v2.32/docs/reference-global#remote_store_rpc_timeout_millis
default: 30000
GLOBAL.rule_threads_corenumberThe number of threads to keep active and ready to execute `@rule` logic (see also: `--rule-threads-max`) https://www.pantsbuild.org/v2.32/docs/reference-global#rule_threads_core
default: "max(2, #cores/2)"
GLOBAL.rule_threads_maxnumberThe maximum number of threads to use to execute `@rule` logic https://www.pantsbuild.org/v2.32/docs/reference-global#rule_threads_max
default: null
GLOBAL.sandboxerbooleanEnables use of the sandboxer process https://www.pantsbuild.org/v2.32/docs/reference-global#sandboxer
default: false
GLOBAL.session_end_tasks_timeoutnumberThe 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
default: 3.0
GLOBAL.show_log_targetbooleanDisplay the target where a log message originates in that log message's output https://www.pantsbuild.org/v2.32/docs/reference-global#show_log_target
default: false
GLOBAL.spec_filesarrayRead additional specs (target addresses, files, and/or globs), one per line, from these files https://www.pantsbuild.org/v2.32/docs/reference-global#spec_files
default: []
GLOBAL.stats_record_option_scopesarrayOption scopes to record in stats on run completion https://www.pantsbuild.org/v2.32/docs/reference-global#stats_record_option_scopes
default: ["*"]
GLOBAL.streaming_workunits_complete_asyncbooleanTrue if stats recording should be allowed to complete asynchronously when `pantsd` is enabled https://www.pantsbuild.org/v2.32/docs/reference-global#streaming_workunits_complete_async
default: true
GLOBAL.streaming_workunits_levelenumThe level of workunits that will be reported to streaming workunit event receivers https://www.pantsbuild.org/v2.32/docs/reference-global#streaming_workunits_level
default: "debug"
one of: "trace", "debug", "info", "warn", "error"
GLOBAL.streaming_workunits_report_intervalnumberInterval in seconds between when streaming workunit event receivers will be polled https://www.pantsbuild.org/v2.32/docs/reference-global#streaming_workunits_report_interval
default: 1.0
GLOBAL.subproject_rootsarrayPaths that correspond with build roots for any subproject that this project depends on https://www.pantsbuild.org/v2.32/docs/reference-global#subproject_roots
default: []
GLOBAL.tagarrayInclude only targets with these tags (optional '+' prefix) or without these tags ('-' prefix) https://www.pantsbuild.org/v2.32/docs/reference-global#tag
default: []
GLOBAL.unmatched_build_file_globsenumWhat to do when files and globs specified in BUILD files, such as in the `sources` field, cannot be found https://www.pantsbuild.org/v2.32/docs/reference-global#unmatched_build_file_globs
default: "warn"
one of: "ignore", "warn", "error"
GLOBAL.unmatched_cli_globsenumWhat to do when command line arguments, e.g. files and globs like `dir::`, cannot be found https://www.pantsbuild.org/v2.32/docs/reference-global#unmatched_cli_globs
default: "error"
one of: "ignore", "warn", "error"
GLOBAL.verify_configbooleanVerify that all config file values correspond to known options https://www.pantsbuild.org/v2.32/docs/reference-global#verify_config
default: true
GLOBAL.watch_filesystembooleanSet to False if Pants should not watch the filesystem for changes. `pantsd` or `loop` may not be enabled https://www.pantsbuild.org/v2.32/docs/reference-global#watch_filesystem
default: true
anonymous-telemetryobjectOptions related to sending anonymous stats to the Pants project, to aid development.
anonymous-telemetry.enabledbooleanWhether to send anonymous telemetry to the Pants project https://www.pantsbuild.org/v2.32/docs/reference-anonymous-telemetry#enabled
default: false
anonymous-telemetry.repo_idstringAn anonymized ID representing this repo https://www.pantsbuild.org/v2.32/docs/reference-anonymous-telemetry#repo_id
default: null
autoflakeobjectThe Autoflake Python code formatter (https://github.com/myint/autoflake). This version of Pants uses `autoflake` version 2.3.1 by default. Use a dedicated lockfile and the `install_from_resolve` option to control this.
autoflake.argsarrayArguments to pass directly to Autoflake, e.g. `--autoflake-args='--remove-all-unused-imports --target-version=py37 --quiet'` https://www.pantsbuild.org/v2.32/docs/reference-autoflake#args
default: ["--remove-all-unused-imports"]
autoflake.console_scriptstringThe console script for the tool https://www.pantsbuild.org/v2.32/docs/reference-autoflake#console_script
default: "autoflake"
autoflake.entry_pointstringThe entry point for the tool https://www.pantsbuild.org/v2.32/docs/reference-autoflake#entry_point
default: null
autoflake.install_from_resolvestringIf specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.32/docs/reference-autoflake#install_from_resolve
default: null
autoflake.interpreter_constraintsarrayPython interpreter constraints for this tool https://www.pantsbuild.org/v2.32/docs/reference-autoflake#interpreter_constraints
default: ["CPython>=3.9,<3.15"]
autoflake.requirementsarrayIf `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile https://www.pantsbuild.org/v2.32/docs/reference-autoflake#requirements
default: []
autoflake.skipbooleanIf true, don't use Autoflake when running `pants fmt` and `pants lint` https://www.pantsbuild.org/v2.32/docs/reference-autoflake#skip
default: false
blackobjectThe Black Python code formatter (https://black.readthedocs.io/). This version of Pants uses `black` version 24.10.0 by default. Use a dedicated lockfile and the `install_from_resolve` option to control this.
black.argsarrayArguments to pass directly to Black, e.g. `--black-args='--target-version=py37 --quiet'` https://www.pantsbuild.org/v2.32/docs/reference-black#args
default: []
black.configanyPath to a TOML config file understood by Black (https://github.com/psf/black#configuration-format) https://www.pantsbuild.org/v2.32/docs/reference-black#config
default: null
black.config_discoverybooleanIf true, Pants will include any relevant pyproject.toml config files during runs https://www.pantsbuild.org/v2.32/docs/reference-black#config_discovery
default: true
black.console_scriptstringThe console script for the tool https://www.pantsbuild.org/v2.32/docs/reference-black#console_script
default: "black"
black.entry_pointstringThe entry point for the tool https://www.pantsbuild.org/v2.32/docs/reference-black#entry_point
default: null
black.install_from_resolvestringIf specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.32/docs/reference-black#install_from_resolve
default: null
black.interpreter_constraintsarrayPython interpreter constraints for this tool https://www.pantsbuild.org/v2.32/docs/reference-black#interpreter_constraints
default: ["CPython>=3.9,<3.15"]
black.requirementsarrayIf `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile https://www.pantsbuild.org/v2.32/docs/reference-black#requirements
default: []
black.skipbooleanIf true, don't use Black when running `pants fmt` and `pants lint` https://www.pantsbuild.org/v2.32/docs/reference-black#skip
default: false
build-deprecations-fixerobjectA tool/plugin for fixing BUILD file deprecations (where possible). This includes deprecations for: - Renamed targets - Renamed fields
build-deprecations-fixer.skipbooleanIf true, don't use BUILD Deprecations Fixer when running `pants fix` https://www.pantsbuild.org/v2.32/docs/reference-build-deprecations-fixer#skip
default: false
buildifierobjectBuildifier is a tool for formatting BUILD files with a standard convention. Pants supports running Buildifier on your Pants BUILD files for several reasons: - You might like the style that buildifier uses. - You might be incrementally
buildifier.argsarrayArguments to pass directly to Buildifier, e.g. `--buildifier-args='-lint=fix'` https://www.pantsbuild.org/v2.32/docs/reference-buildifier#args
default: []
buildifier.known_versionsarrayKnown versions to verify downloads against https://www.pantsbuild.org/v2.32/docs/reference-buildifier#known_versions
default: ["8.0.3|linux_arm64 |bdd9b92e2c65d46affeecaefb54e68d34c272d1…
buildifier.skipbooleanIf true, don't use Buildifier when running `pants fmt` https://www.pantsbuild.org/v2.32/docs/reference-buildifier#skip
default: false
buildifier.url_platform_mappingobjectA dictionary mapping platforms to strings to be used when generating the URL to download the tool https://www.pantsbuild.org/v2.32/docs/reference-buildifier#url_platform_mapping
default: {"linux_arm64": "linux-arm64", "linux_x86_64"…
buildifier.url_templatestringURL to download the tool, either as a single binary file or a compressed file (e.g. zip file) https://www.pantsbuild.org/v2.32/docs/reference-buildifier#url_template
default: "https://github.com/bazelbuild/buildtools/releases/download/…
buildifier.use_unsupported_versionenumWhat action to take in case the requested version of Buildifier is not supported https://www.pantsbuild.org/v2.32/docs/reference-buildifier#use_unsupported_version
default: "error"
one of: "error", "warning"
buildifier.versionstringUse this version of Buildifier https://www.pantsbuild.org/v2.32/docs/reference-buildifier#version
default: "8.0.3"
changedobjectTell Pants to detect what files and targets have changed from Git. See https://www.pantsbuild.org/2.32/docs/using-pants/advanced-target-selection.
changed.dependentsenumInclude direct or transitive dependents of changed targets https://www.pantsbuild.org/v2.32/docs/reference-changed#dependents
default: "none"
one of: "none", "direct", "transitive"
changed.diffspecstringCalculate changes contained within a given Git spec (commit range/SHA/ref) https://www.pantsbuild.org/v2.32/docs/reference-changed#diffspec
default: null
changed.sincestringCalculate changes since this Git spec (commit range/SHA/ref) https://www.pantsbuild.org/v2.32/docs/reference-changed#since
default: null
checkobjectRun type checking or the lightest variant of compilation available for a language.
check.forcebooleanForce checks to run, even if they could be satisfied from cache https://www.pantsbuild.org/v2.32/docs/reference-check#force
default: false
check.onlyarrayOnly run these checkers and skip all others https://www.pantsbuild.org/v2.32/docs/reference-check#only
default: []
check-default-toolsobjectOptions for checking that external tool default locations are correctly typed.
cliobjectOptions for configuring CLI behavior, such as command line aliases.
cli.aliasobjectRegister command line aliases https://www.pantsbuild.org/v2.32/docs/reference-cli#alias
default: {}
completeobjectGenerates a completion script for the specified shell. The script is printed to stdout. For example, `pants complete --shell=zsh > pants-completions.zsh` will generate a zsh completion script and write it to the file
complete.shellenumWhich shell completion type should be printed to stdout https://www.pantsbuild.org/v2.32/docs/reference-complete#shell
default: "bash"
one of: "bash", "zsh"
count-locobjectCount lines of code.
coursierobjectA dependency resolver for the Maven ecosystem. (https://get-coursier.io/)
coursier.jvm_indexstringThe JVM index to be used by Coursier https://www.pantsbuild.org/v2.32/docs/reference-coursier#jvm_index
default: ""
coursier.known_versionsarrayKnown versions to verify downloads against https://www.pantsbuild.org/v2.32/docs/reference-coursier#known_versions
default: ["v2.1.24|linux_arm64 |96b4c7580d253b6999a40e94413ca6c4a9bd2…
coursier.reposarrayMaven style repositories to resolve artifacts from https://www.pantsbuild.org/v2.32/docs/reference-coursier#repos
default: ["https://maven-central.storage-download.googleapis.com/mave…
coursier.url_platform_mappingobjectA dictionary mapping platforms to strings to be used when generating the URL to download the tool https://www.pantsbuild.org/v2.32/docs/reference-coursier#url_platform_mapping
default: {"linux_arm64": "aarch64-pc-linux", "linux_x86_64"…
coursier.url_templatestringURL to download the tool, either as a single binary file or a compressed file (e.g. zip file) https://www.pantsbuild.org/v2.32/docs/reference-coursier#url_template
default: "https://github.com/coursier/coursier/releases/download/{ver…
coursier.use_unsupported_versionenumWhat action to take in case the requested version of coursier is not supported https://www.pantsbuild.org/v2.32/docs/reference-coursier#use_unsupported_version
default: "error"
one of: "error", "warning"
coursier.versionstringUse this version of coursier https://www.pantsbuild.org/v2.32/docs/reference-coursier#version
default: "v2.1.24"
coverage-pyobjectConfiguration for Python test coverage measurement. This version of Pants uses `coverage` version 7.10.7 by default. Use a dedicated lockfile and the `install_from_resolve` option to control this.
coverage-py.configanyPath to an INI or TOML config file understood by coverage.py (https://coverage.readthedocs.io/en/latest/config.html) https://www.pantsbuild.org/v2.32/docs/reference-coverage-py#config
default: null
coverage-py.config_discoverybooleanIf true, Pants will include any relevant config files during runs (`.coveragerc`, `setup.cfg`, `tox.ini`, and `pyproject.toml`) https://www.pantsbuild.org/v2.32/docs/reference-coverage-py#config_discovery
default: true
coverage-py.console_scriptstringThe console script for the tool https://www.pantsbuild.org/v2.32/docs/reference-coverage-py#console_script
default: "coverage"
coverage-py.entry_pointstringThe entry point for the tool https://www.pantsbuild.org/v2.32/docs/reference-coverage-py#entry_point
default: null
coverage-py.fail_undernumberFail if the total combined coverage percentage for all tests is less than this number https://www.pantsbuild.org/v2.32/docs/reference-coverage-py#fail_under
default: null
coverage-py.filterarrayA 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.32/docs/reference-coverage-py#filter
default: []
coverage-py.global_reportbooleanIf true, Pants will generate a global coverage report https://www.pantsbuild.org/v2.32/docs/reference-coverage-py#global_report
default: false
coverage-py.install_from_resolvestringIf specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.32/docs/reference-coverage-py#install_from_resolve
default: null
coverage-py.interpreter_constraintsarrayPython interpreter constraints for this tool https://www.pantsbuild.org/v2.32/docs/reference-coverage-py#interpreter_constraints
default: ["CPython>=3.9,<3.15"]
coverage-py.output_dirstringPath to write the Pytest Coverage report to https://www.pantsbuild.org/v2.32/docs/reference-coverage-py#output_dir
default: "{distdir}/coverage/python"
coverage-py.reportenumWhich coverage report type(s) to emit https://www.pantsbuild.org/v2.32/docs/reference-coverage-py#report
default: ["console"]
one of: "console", "xml", "html", "raw", "json", "lcov"
coverage-py.requirementsarrayIf `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile https://www.pantsbuild.org/v2.32/docs/reference-coverage-py#requirements
default: []
debug-adapterobjectOptions used to configure and launch a Debug Adapter server. See https://microsoft.github.io/debug-adapter-protocol/ for more information.
debug-adapter.hoststringThe hostname to use when launching the server https://www.pantsbuild.org/v2.32/docs/reference-debug-adapter#host
default: "127.0.0.1"
debug-adapter.portnumberThe port to use when launching the server https://www.pantsbuild.org/v2.32/docs/reference-debug-adapter#port
default: 5678
debugpyobjectAn implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy). This version of Pants uses `debugpy` version 1.6.7.post1 by default. Use a dedicated lockfile and the `install_from_resolve` option to
debugpy.argsarrayArguments to pass directly to debugpy, e.g. `--debugpy-args='--log-to-stderr'` https://www.pantsbuild.org/v2.32/docs/reference-debugpy#args
default: []
debugpy.console_scriptstringThe console script for the tool https://www.pantsbuild.org/v2.32/docs/reference-debugpy#console_script
default: null
debugpy.entry_pointstringThe entry point for the tool https://www.pantsbuild.org/v2.32/docs/reference-debugpy#entry_point
default: "debugpy"
debugpy.install_from_resolvestringIf specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.32/docs/reference-debugpy#install_from_resolve
default: null
debugpy.interpreter_constraintsarrayPython interpreter constraints for this tool https://www.pantsbuild.org/v2.32/docs/reference-debugpy#interpreter_constraints
default: ["CPython>=3.9,<3.15"]
debugpy.requirementsarrayIf `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile https://www.pantsbuild.org/v2.32/docs/reference-debugpy#requirements
default: []
dependenciesobjectList the dependencies of the input files/targets.
dependencies.closedbooleanInclude the input targets in the output, along with the dependencies https://www.pantsbuild.org/v2.32/docs/reference-dependencies#closed
default: false
dependencies.formatenumOutput format for listing dependencies https://www.pantsbuild.org/v2.32/docs/reference-dependencies#format
default: "text"
one of: "text", "json"
dependencies.output_filestringOutput the goal's stdout to this file https://www.pantsbuild.org/v2.32/docs/reference-dependencies#output_file
default: null
dependencies.sepstringString to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.32/docs/reference-dependencies#sep
default: "\\n"
dependencies.transitivebooleanList all transitive dependencies https://www.pantsbuild.org/v2.32/docs/reference-dependencies#transitive
default: false
dependentsobjectList all targets that depend on any of the input files/targets.
dependents.closedbooleanInclude the input targets in the output, along with the dependents https://www.pantsbuild.org/v2.32/docs/reference-dependents#closed
default: false
dependents.formatenumOutput format for listing dependents https://www.pantsbuild.org/v2.32/docs/reference-dependents#format
default: "text"
one of: "text", "json"
dependents.output_filestringOutput the goal's stdout to this file https://www.pantsbuild.org/v2.32/docs/reference-dependents#output_file
default: null
dependents.sepstringString to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.32/docs/reference-dependents#sep
default: "\\n"
dependents.transitivebooleanList all transitive dependents https://www.pantsbuild.org/v2.32/docs/reference-dependents#transitive
default: false
docformatterobjectThe Python docformatter tool (https://github.com/myint/docformatter). This version of Pants uses `docformatter` version 1.4 by default. Use a dedicated lockfile and the `install_from_resolve` option to control this.
docformatter.argsarrayArguments to pass directly to docformatter, e.g. `--docformatter-args='--wrap-summaries=100 --pre-summary-newline'` https://www.pantsbuild.org/v2.32/docs/reference-docformatter#args
default: []
docformatter.console_scriptstringThe console script for the tool https://www.pantsbuild.org/v2.32/docs/reference-docformatter#console_script
default: "docformatter"
docformatter.entry_pointstringThe entry point for the tool https://www.pantsbuild.org/v2.32/docs/reference-docformatter#entry_point
default: null
docformatter.install_from_resolvestringIf specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.32/docs/reference-docformatter#install_from_resolve
default: null
docformatter.interpreter_constraintsarrayPython interpreter constraints for this tool https://www.pantsbuild.org/v2.32/docs/reference-docformatter#interpreter_constraints
default: ["CPython>=3.9,<3.15"]
docformatter.requirementsarrayIf `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile https://www.pantsbuild.org/v2.32/docs/reference-docformatter#requirements
default: []
docformatter.skipbooleanIf true, don't use docformatter when running `pants fmt` and `pants lint` https://www.pantsbuild.org/v2.32/docs/reference-docformatter#skip
default: false
dockerobjectOptions for interacting with Docker.
docker.build_argsarrayGlobal build arguments (for Docker `--build-arg` options) to use for all `docker build` invocations https://www.pantsbuild.org/v2.32/docs/reference-docker#build_args
default: []
docker.build_hostsobjectHosts entries to be added to the `/etc/hosts` file in all built images https://www.pantsbuild.org/v2.32/docs/reference-docker#build_hosts
default: {}
docker.build_no_cachebooleanDo not use the Docker cache when building images https://www.pantsbuild.org/v2.32/docs/reference-docker#build_no_cache
default: false
docker.build_target_stagestringGlobal 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.32/docs/reference-docker#build_target_stage
default: null
docker.build_verbosebooleanWhether to log the Docker output to the console https://www.pantsbuild.org/v2.32/docs/reference-docker#build_verbose
default: false
docker.default_context_rootanyProvide 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.32/docs/reference-docker#default_context_root
default: ""
docker.default_repositorystringConfigure the default repository name used in the Docker image tag https://www.pantsbuild.org/v2.32/docs/reference-docker#default_repository
default: "{name}"
docker.env_varsarrayEnvironment variables to set for `docker` invocations https://www.pantsbuild.org/v2.32/docs/reference-docker#env_vars
default: []
docker.executable_search_pathsarrayThe PATH value that will be used to find the Docker client and any tools required https://www.pantsbuild.org/v2.32/docs/reference-docker#executable_search_paths
default: ["<PATH>"]
docker.optional_toolsarrayList any additional executables which are not mandatory for Docker to work, but which should be included if available https://www.pantsbuild.org/v2.32/docs/reference-docker#optional_tools
default: []
docker.publish_noninteractivelybooleanIf true, publish images non-interactively https://www.pantsbuild.org/v2.32/docs/reference-docker#publish_noninteractively
default: false
docker.push_on_packageenumThe behavior when a docker_image target would push to a registry during packaging (e.g., when output has push=true or type=registry) https://www.pantsbuild.org/v2.32/docs/reference-docker#push_on_package
default: "warn"
one of: "allow", "ignore", "warn", "error"
docker.registriesoneOfConfigure Docker registries https://www.pantsbuild.org/v2.32/docs/reference-docker#registries
default: {}
docker.run_argsarrayAdditional arguments to use for `docker run` invocations https://www.pantsbuild.org/v2.32/docs/reference-docker#run_args
default: []
docker.suggest_renamesbooleanWhen 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.32/docs/reference-docker#suggest_renames
default: true
docker.tailorbooleanIf true, add `docker_image` targets with the `tailor` goal https://www.pantsbuild.org/v2.32/docs/reference-docker#tailor
default: true
docker.toolsarrayList any additional executable tools required for Docker to work https://www.pantsbuild.org/v2.32/docs/reference-docker#tools
default: []
docker.use_buildxbooleanUse [buildx](https://github.com/docker/buildx#buildx) (and BuildKit) for builds https://www.pantsbuild.org/v2.32/docs/reference-docker#use_buildx
default: false
dockerfile-parserobjectUsed to parse Dockerfile build specs to infer their dependencies. This version of Pants uses `dockerfile` version 3.4.0 by default. Use a dedicated lockfile and the `install_from_resolve` option to control this.
dockerfile-parser.install_from_resolvestringIf specified, install the tool using the lockfile for this named resolve https://www.pantsbuild.org/v2.32/docs/reference-dockerfile-parser#install_from_resolve
default: null
dockerfile-parser.interpreter_constraintsarrayPython interpreter constraints for this tool https://www.pantsbuild.org/v2.32/docs/reference-dockerfile-parser#interpreter_constraints
default: ["CPython>=3.9,<3.15"]
dockerfile-parser.requirementsarrayIf `install_from_resolve` is specified, install these requirements, at the versions provided by the specified resolve's lockfile https://www.pantsbuild.org/v2.32/docs/reference-dockerfile-parser#requirements
default: []
dockerfile-parser.use_rust_parserbooleanUse the new Rust-based, multithreaded, in-process dependency parser https://www.pantsbuild.org/v2.32/docs/reference-dockerfile-parser#use_rust_parser
default: true
environments-previewobjectA highly experimental subsystem to allow setting environment variables and executable search paths for different environments, e.g. macOS vs. Linux.
environments-preview.namesobjectA mapping of logical names to addresses to environment targets https://www.pantsbuild.org/v2.32/docs/reference-environments-preview#names
default: {}
experimental-deployobjectPerform a deployment process.
experimental-deploy.dry_runbooleanIf true, perform a dry run without deploying anything https://www.pantsbuild.org/v2.32/docs/reference-experimental-deploy#dry_run
default: false
experimental-deploy.publish_dependenciesbooleanIf false, don't publish target dependencies before deploying the target https://www.pantsbuild.org/v2.32/docs/reference-experimental-deploy#publish_dependencies
default: true
experimental-explorerobjectRun the Pants Explorer Web UI server.
experimental-explorer.addressstringServer address to bind to https://www.pantsbuild.org/v2.32/docs/reference-experimental-explorer#address
default: "localhost"
experimental-explorer.portnumberServer port to bind to https://www.pantsbuild.org/v2.32/docs/reference-experimental-explorer#port
default: 8000
exportobjectExport Pants data for use in other tools, such as IDEs. :::caution Exporting tools requires creating a custom lockfile for them Follow [the instructions for creating tool lockfiles](../../docs/python/overview/lockfiles#lockfiles-for-tools)
export.binarrayExport the specified binaries https://www.pantsbuild.org/v2.32/docs/reference-export#bin
default: []
export.py_editable_in_resolvearrayWhen 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.32/docs/reference-export#py_editable_in_resolve
default: []
export.py_generated_sources_in_resolvearrayWhen 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
default: []
export.py_non_hermetic_scripts_in_resolvearrayWhen 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.32/docs/reference-export#py_non_hermetic_scripts_in_resolve
default: []
export.py_resolve_formatenumExport Python resolves using this format https://www.pantsbuild.org/v2.32/docs/reference-export#py_resolve_format
default: "mutable_virtualenv"
one of: "mutable_virtualen…, "symlinked_immutab…
export.resolvearrayExport the specified resolve(s) https://www.pantsbuild.org/v2.32/docs/reference-export#resolve
default: []
export-codegenobjectWrite generated files to `dist/codegen` for use outside of Pants.
filedepsobjectList all source and BUILD files a target depends on.
filedeps.absolutebooleanIf True, output with absolute path https://www.pantsbuild.org/v2.32/docs/reference-filedeps#absolute
default: false
filedeps.globsbooleanInstead of outputting filenames, output the original globs used in the BUILD file https://www.pantsbuild.org/v2.32/docs/reference-filedeps#globs
default: false
filedeps.output_filestringOutput the goal's stdout to this file https://www.pantsbuild.org/v2.32/docs/reference-filedeps#output_file
default: null
filedeps.sepstringString to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.32/docs/reference-filedeps#sep
default: "\\n"
filedeps.transitivebooleanIf True, list files from all dependencies, including transitive dependencies https://www.pantsbuild.org/v2.32/docs/reference-filedeps#transitive
default: false
filterobjectFilter 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
filter.address_regexarrayFilter targets based on each target's address matching the provided regular expressions https://www.pantsbuild.org/v2.32/docs/reference-filter#address_regex
default: []
filter.granularityenumFilter to rendering only targets declared in BUILD files, only file-level targets, or all targets https://www.pantsbuild.org/v2.32/docs/reference-filter#granularity
default: "all"
one of: "all", "file", "BUILD"
filter.output_filestringOutput the goal's stdout to this file https://www.pantsbuild.org/v2.32/docs/reference-filter#output_file
default: null
filter.sepstringString to use to separate lines in line-oriented output https://www.pantsbuild.org/v2.32/docs/reference-filter#sep
default: "\\n"
filter.tag_regexarrayFilter 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.32/docs/reference-filter#tag_regex
default: []

What we found in this schema

Specification sections for the keywords in this schema

Keyword Document Section
defaultJSON Schema Validation, draft 2020-12§9.2 — "default"
descriptionJSON Schema Validation, draft 2020-12§9.1 — "title" and "description"
enumJSON Schema Validation, draft 2020-12§6.1.2 — "enum"
formatJSON Schema Validation, draft 2020-12§7 — Vocabularies for Semantic Content With "format"
oneOfJSON Schema Core, draft 2020-12§10.2.1.3 — "oneOf"
propertiesJSON Schema Core, draft 2020-12§10.3.2.1 — "properties"
typeJSON Schema Validation, draft 2020-12§6.1.1 — "type"

Documents

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas