Skip to main content
Version: 2.8 (deprecated)

experimental_shell_command

Execute any external tool for its side effects.

Example BUILD file:

experimental_shell_command(
  command="./my-script.sh --flag",
  tools=["tar", "curl", "cat", "bash", "env"],
  dependencies=[":scripts"],
  outputs=["results/", "logs/my-script.log"],
)

shell_sources(name="scripts")

Remember to add this target to the dependencies of each consumer, such as your python_tests or docker_image. When relevant, Pants will run your command and insert the outputs into that consumer's context.

The command may be retried and/or cancelled, so ensure that it is idempotent.

Backend: ``

command​

str
required

Shell command to execute.

The command is executed as 'bash -c <command>' by default.

tools​

Iterable[str]
required

Specify required executable tools that might be used.

Only the tools explicitly provided will be available on the search PATH, and these tools must be found on the paths provided by [shell-setup].executable_search_paths (which defaults to the system PATH).

dependencies​

Iterable[str] | None
default: None

Addresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib'].

Alternatively, you may include file names. Pants will find which target owns that file, and create a new target from that which only includes the file in its sources field. For files relative to the current BUILD file, prefix with ./; otherwise, put the full path, e.g. ['./sibling.txt', 'resources/demo.json'].

You may exclude dependencies by prefixing with !, e.g. ['!helloworld/subdir:lib', '!./sibling.txt']. Ignores are intended for false positives with dependency inference; otherwise, simply leave off the dependency from the BUILD file.

description​

str | None
default: None

A human-readable description of the target.

Use ./pants list --documented :: to see all targets with descriptions.

log_output​

bool
default: False

Set to true if you want the output from the command logged to the console.

outputs​

Iterable[str] | None
default: None

Specify the shell command output files and directories.

Use a trailing slash on directory names, i.e. my_dir/.

tags​

Iterable[str] | None
default: None

Arbitrary strings to describe a target.

For example, you may tag some test targets with 'integration_test' so that you could run ./pants --tag='integration_test' test :: to only run on targets with that tag.

timeout​

int | None
default: 30

Command execution timeout (in seconds).