Pants v2: Fast, consistent builds for Python and more

Welcome to the Pants v2 documentation hub!

Pants v2 is a fast, scalable build system for growing codebases. It's currently focused on Python, with support for other languages coming soon.

Here you'll find guides to help you get started with Pants v2, comprehensive documentation on how to configure, run and customize Pants v2, and information on how to get help from the Pants community.

Get Started
./pants list [args]

Lists all targets matching the file or target arguments.

Config section: [list]

Basic options

--list-output-file=<path>
PANTS_LIST_OUTPUT_FILE
output_file
default: None
Output to this file. If unspecified, outputs to stdout.

--list-sep=<separator>
PANTS_LIST_SEP
sep
default: \n
String to use to separate lines in line-oriented output.

--[no-]list-provides
PANTS_LIST_PROVIDES
provides
default: False
List only targets that provide an artifact, displaying the columns specified by --provides-columns.

--[no-]list-documented
PANTS_LIST_DOCUMENTED
documented
default: False
Print only targets that are documented with a description.

Advanced options

None

Deprecated options

--list-provides-columns=<str>
PANTS_LIST_PROVIDES_COLUMNS
provides_columns
default: address,artifact_id
Deprecated, will be removed in version: 2.0.1.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

Related subsystems

list

Updated about a month ago


list


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.