Skip to main content
Version: 2.10 (deprecated)

run


pants run [args]

Runs a binary target.

This goal propagates the return code of the underlying executable.

If your application can safely be restarted while it is running, you can pass restartable=True on your binary target (for supported types), and the run goal will automatically restart them as all relevant files change. This can be particularly useful for server applications.

Backend: pants.core

Config section: [run]

Basic options

args

--run-args="[<shell_str>, <shell_str>, ...]", ... -- [<shell_str> [<shell_str> [...]]]
PANTS_RUN_ARGS
pants.toml
[run]
args = [
<shell_str>,
<shell_str>,
...,
]
default: []

Arguments to pass directly to the executed target, e.g. --run-args="val1 val2 --debug"

cleanup

--[no-]run-cleanup
PANTS_RUN_CLEANUP
pants.toml
[run]
cleanup = <bool>
default: True

Whether to clean up the temporary directory in which the binary is chrooted. Set to false to retain the directory, e.g., for debugging.

Advanced options

None

Deprecated options

None

None