Pants v2: The ergonomic build system

Welcome to the Pants v2 documentation hub!

Pants v2 is a fast, scalable, user-friendly 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

auth-acquire

./pants auth-acquire [args]

Acquires access tokens for Toolchain service.

Config section: [auth-acquire]

Basic options

local_port

--auth-acquire-local-port=<int>
PANTS_AUTH_ACQUIRE_LOCAL_PORT
default: None

Local web server port


output

--auth-acquire-output=<OutputType>
PANTS_AUTH_ACQUIRE_OUTPUT
one of: file, console
default: file

Output method for access token. Outputing the console is useful if the token needs to be provided to CI


headless

--[no-]auth-acquire-headless
PANTS_AUTH_ACQUIRE_HEADLESS
default: False

Don't open & use a browser to acquire access token


Advanced options

test_page

--auth-acquire-test-page=<TestPage>
PANTS_AUTH_ACQUIRE_TEST_PAGE
one of: na, success, error
default: na

Helper to test success and error pages w/o triggering auth flow


Deprecated options

None

Related subsystems

auth, auth-acquire, toolchain-setup

Updated 15 days ago


auth-acquire


Suggested Edits are limited on API Reference Pages

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