Skip to main content
Version: 2.22

cli

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

Backend: ``

Config section: [cli]

Basic options​

alias​

--cli-alias="{'key1': val1, 'key2': val2, ...}"
PANTS_CLI_ALIAS
pants.toml
[cli.alias]
key1 = val1
key2 = val2
...
default: {}

Register command line aliases.

Example:

[cli.alias]
green = "fmt lint check"
--all-changed = "--changed-since=HEAD --changed-dependents=transitive"

This would allow you to run pants green --all-changed, which is shorthand for pants fmt lint check --changed-since=HEAD --changed-dependents=transitive.

Notice: this option must be placed in a config file (e.g. pants.toml or pantsrc) to have any effect.

Advanced options​

None

Deprecated options​

None

None