Skip to main content
Version: 2.0 (deprecated)

list

pants list [args]

Lists all targets matching the file or target arguments.

Backend: ``

Config section: [list]

Basic options​

documented​

--[no-]list-documented
PANTS_LIST_DOCUMENTED
pants.toml
[list]
documented = <bool>
default: False

Print only targets that are documented with a description.

output_file​

--list-output-file=<path>
PANTS_LIST_OUTPUT_FILE
pants.toml
[list]
output_file = <path>
default: None

Output the goal's stdout to this file. If unspecified, outputs to stdout.

provides​

--[no-]list-provides
PANTS_LIST_PROVIDES
pants.toml
[list]
provides = <bool>
default: False

List only targets that provide an artifact, displaying the columns specified by --provides-columns.

sep​

--list-sep=<separator>
PANTS_LIST_SEP
pants.toml
[list]
sep = <separator>
default: \n

String to use to separate lines in line-oriented output.

Advanced options​

None

Deprecated options​

provides_columns​

--list-provides-columns=<str>
PANTS_LIST_PROVIDES_COLUMNS
pants.toml
[list]
provides_columns = <str>
default: address,artifact_id
Deprecated, will be removed in version: 2.1.0.dev0.
The option `--provides-columns` no longer does anything. It was specific to the JVM backend, so no longer makes sense with Pants 2.0 initially only supporting Python.

Display these columns when --provides is specified. Available columns are: address, artifact_id, repo_name, repo_url, push_db_basedir

None