level

Set the logging level.

colors

Whether Pants should use colors in output or not. This may also impact whether some tools Pants run use color.

Read additional specs (target addresses, files, and/or globs), one per line,from these files.

Display a dynamically-updating console UI as Pants runs. This is true by default if Pants detects a TTY and there is no 'CI' environment variable indicating that Pants is running in a continuous integration environment.

Include only targets with these tags (optional '+' prefix) or without these tags ('-' prefix). See https://www.pantsbuild.org/v2.2/docs/advanced-target-selection.

Exclude targets that match these regexes. This does not impact file arguments.

Run goals continuously as file changes are detected. Alpha feature.

Register functionality from these backends.

The backend packages must be present on the PYTHONPATH, typically because they are in the Pants core dist, in a plugin dist, or available as sources in the repo.

Allow backends to be loaded from these plugins (usually released through PyPI). The default backends for each plugin will be loaded automatically. Other backends in a plugin can be loaded by listing them in `backend_packages` in the `[GLOBAL]` scope.

Re-resolve plugins, even if previously resolved.

Cache resolved plugin requirements here.

Display the target where a log message originates in that log message's output. This can be helpful when paired with --log-levels-by-target.

Set a more specific logging level for one or more logging targets. The names of logging targets are specified in log strings when the --show-log-target option is set. The logging levels are one of: "error", "warn", "info", "debug", "trace". All logging targets not specified here use the global log level set with --level. For example, you can set `--log-levels-by-target='{"workunit_store": "info", "pants.engine.rules": "warn"}'`.

Whether to show/hide logging done by 3rdparty Rust crates used by the Pants engine.

Regexps matching warning strings to ignore, e.g. ["DEPRECATED: the option `--my-opt` will be removed"]. The regex patterns will be matched from the start of the warning string, and are case-insensitive.

Use this Pants version. Note that Pants only uses this to verify that you are using the requested version, as Pants cannot dynamically change the version it is using once the program is already running.

If you use the ./pants script from https://www.pantsbuild.org/v2.2/docs/installation, however, changing the value in your pants.toml will cause the new version to be installed and run automatically.

Run ./pants --version to check what is being used.

The name of the script or binary used to invoke Pants. Useful when printing help messages.

Write intermediate logs and output files to this dir.

When set, a base directory in which to store `--pants-workdir` contents. If this option is a set, the workdir will be created as symlink into a per-workspace subdirectory.

Unused. Will be deprecated in 2.2.0.

Write end products, such as the results of `./pants package`, to this dir.

The directory to use for tracking subprocess metadata. This should live outside of the dir used by `pants_workdir` to allow for tracking subprocesses that outlive the workdir data.

[
  "/Users/eric/DocsLocal/code/projects/pants/pants.toml"
]

Paths to Pants config files. This may only be set through the environment variable `PANTS_CONFIG_FILES` and the command line argument `--pants-config-files`; it will be ignored if in a config file like `pants.toml`.

Use pantsrc files located at the paths specified in the global option `pantsrc_files`.

[
  "/etc/pantsrc",
  "~/.pants.rc"
]

Override config with values from these files, using syntax matching that of `--pants-config-files`.

Add these directories to PYTHONPATH to search for plugins. This does not impact the PYTHONPATH used by Pants when running your Python code.

Verify that all config file values correspond to known options.

[
  ".*/",
  "/dist/"
]

Paths to ignore for all filesystem operations performed by pants (e.g. BUILD file scanning, glob matching, etc). Patterns use the gitignore syntax (https://git-scm.com/docs/gitignore). The `pants_distdir` and `pants_workdir` locations are automatically ignored. `pants_ignore` can be used in tandem with `pants_ignore_use_gitignore`; any rules specified here are applied after rules specified in a .gitignore file.

Make use of a root .gitignore file when determining whether to ignore filesystem operations performed by Pants. If used together with `--pants-ignore`, any exclude/include patterns specified there apply after .gitignore rules.

Write logs to files under this directory.

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.

Enable concurrent runs of Pants. Without this enabled, Pants will start up all concurrent invocations (e.g. in other terminals) without pantsd. Enabling this option requires parallel Pants invocations to block on the first

The maximum amount of time to wait for the invocation to start until raising a timeout exception. Because pantsd currently does not support parallel runs, any prior running Pants command must be finished for the current one to start. To never timeout, use the value -1.

The maximum memory usage of a pantsd process (in bytes). There is at most one pantsd process per workspace.

Print the full exception stack trace for any errors.

A directory to write execution and rule graphs to as `dot` files. The contents of the directory will be overwritten if any filenames collide.

The port to bind the Pants nailgun server to. Defaults to a random port.

Filesystem events matching any of these globs will trigger a daemon restart. Pants's own code, plugins, and `--pants-config-files` are inherently invalidated.

The number of threads to keep active and ready to execute `@rule` logic (see also: `--rule-threads-max`). Values less than 2 are not currently supported. This value is independent of the number of processes that may be spawned in parallel locally (controlled by `--process-execution-local-parallelism`).

The maximum number of threads to use to execute `@rule` logic. Defaults to a small multiple of `--rule-threads-core`.

Directory to use for the local file store, which stores the results of subprocesses run by Pants. The path may be absolute or relative. If the directory is within the build root, be sure to include it in `--pants-ignore`.

Directory to use for named global caches for tools and processes with trusted, concurrency-safe caches. The path may be absolute or relative. If the directory is within the build root, be sure to include it in `--pants-ignore`.

Directory to use for local process execution sandboxing. The path may be absolute or relative. If the directory is within the build root, be sure to include it in `--pants-ignore`.

Whether to keep process executions in a local cache persisted to disk.

Whether or not to cleanup directories used for local process execution (primarily useful for e.g. debugging).

Path to a file containing PEM-format CA certificates used for verifying secure connections when downloading files required by a build.

Number of concurrent processes that may be executed locally.

Number of concurrent processes that may be executed remotely.

The cache namespace for process execution. Change this value to invalidate every artifact's execution, or to prevent process cache entries from being (re)used for different usecases or users.

Number of seconds to wait before speculating a second request for a slow process. see `--process-execution-speculation-strategy`

Speculate a second request for an underlying process if the first one does not complete within `--process-execution-speculation-delay` seconds. `local_first` (default): Try to run the process locally first, and fall back to remote execution if available. `remote_first`: Run the process on the remote execution backend if available, and fall back to the local host if remote calls take longer than the speculation timeout. `none`: Do not speculate about long running processes.

Whether or not to use nailgun to run the requests that are marked as nailgunnable.

Enables remote workers for increased parallelism. (Alpha)

Whether to enable reading from a remote cache

Whether to enable writing results to a remote cache

host:port of grpc server to use as remote execution file store.

Thread count to use for the pool that interacts with the remote file store.

host:port of grpc server to use as remote execution scheduler.

Size in bytes of chunks transferred to/from the remote file store.

Timeout (in seconds) for uploads of individual chunks to the remote file store.

Number of times to retry any RPC to the remote store before giving up.

Number of remote stores to concurrently allow connections to.

Initial timeout (in milliseconds) when there is a failure in accessing a remote store.

Multiplier used to increase the timeout (starting with value of --remote-store-initial-timeout) between retry attempts in accessing a remote store.

Maximum timeout (in millseconds) to allow between retry attempts in accessing a remote store.

Name of the remote execution instance to use. Used for routing within --remote-execution-server and --remote-store-server.

Path to a PEM file containing CA certificates used for verifying secure connections to --remote-execution-server and --remote-store-server. If not specified, TLS will not be used.

Path to a file containing an oauth token to use for grpc connections to --remote-execution-server and --remote-store-server. If not specified, no authorization will be performed.

Platform properties to set on remote execution requests. Format: property=value. Multiple values should be specified as multiple occurrences of this flag. Pants itself may add additional platform properties.

Headers to set on remote execution requests. Format: header=value. Pants itself may add additional headers.

Overall timeout in seconds for each remote execution request from time of submission

What to do when files and globs specified in BUILD files, such as in the `sources` field, cannot be found. This happens when the files do not exist on your machine or when they are ignored by the `--pants-ignore` option.

What to do when file arguments do not have any owning target. This happens when there are no targets whose `sources` fields include the file argument.

[
  "BUILD",
  "BUILD.*"
]

The naming scheme for BUILD files, i.e. where you define targets. This only sets the naming scheme, not the directory paths to look for. To add ignorepatterns, use the option `--build-ignore`.

Paths to ignore when identifying BUILD files. This does not affect any other filesystem operations; use `--pants-ignore` for that instead. Patterns use the gitignore pattern syntax (https://git-scm.com/docs/gitignore).

Python files to evaluate and whose symbols should be exposed to all BUILD files. See https://www.pantsbuild.org/v2.2/docs/macros.

Paths that correspond with build roots for any subproject that this project depends on.

The maximum number of times to loop when `--loop` is specified.

Interval in seconds between when streaming workunit event receivers will be polled.

Use this option to name Subsystems which will receive streaming workunit events. For instance, `--streaming-workunits-handlers="['pants.reporting.workunit.Workunits']"` will register a Subsystem called Workunits defined in the module "pants.reporting.workunit".

Deprecated, will be removed in version: 2.3.0.dev1.
Unused.

Unused.

Deprecated, will be removed in version: 2.3.0.dev1.
Unused.

Unused.

Deprecated, will be removed in version: 2.3.0.dev0.
The pailgun client has been rewritten to no longer use this

The length of time (in seconds) to wait for further output after sending a signal to the remote pantsd process before killing it.