Skip to main content
Version: 2.24 (prerelease)

shell-setup

Options for Pants's Shell support.

Backend: pants.backend.shell

Config section: [shell-setup]

Basic options​

None

Advanced options​

dependency_inference​

--[no-]shell-setup-dependency-inference
PANTS_SHELL_SETUP_DEPENDENCY_INFERENCE
pants.toml
[shell-setup]
dependency_inference = <bool>
default: True

Infer Shell dependencies on other Shell files by analyzing source statements.

executable_search_paths​

--shell-setup-executable-search-paths="[<binary-paths>, <binary-paths>, ...]"
PANTS_SHELL_SETUP_EXECUTABLE_SEARCH_PATHS
pants.toml
[shell-setup]
executable_search_paths = [
    <binary-paths>,
    <binary-paths>,
    ...,
]
default: 
[
  "<PATH>"
]

The PATH value that will be used to find shells and to run certain processes like the shunit2 test runner. The special string "<PATH>" will expand to the contents of the PATH env var.

Can be overriden by fieldshell_setup_executable_search_paths on local_environment, docker_environment, or remote_environmenttargets.

tailor_shunit2_tests​

--[no-]shell-setup-tailor-shunit2-tests
PANTS_SHELL_SETUP_TAILOR_SHUNIT2_TESTS
pants.toml
[shell-setup]
tailor_shunit2_tests = <bool>
default: True

If true, add shunit2_tests targets with the tailor goal.

tailor_sources​

--[no-]shell-setup-tailor-sources
PANTS_SHELL_SETUP_TAILOR_SOURCES
pants.toml
[shell-setup]
tailor_sources = <bool>
default: True

If true, add shell_sources targets with the tailor goal.

Deprecated options​

tailor​

--[no-]shell-setup-tailor
PANTS_SHELL_SETUP_TAILOR
pants.toml
[shell-setup]
tailor = <bool>
default: True
Deprecated, will be removed in version: 2.25.0.dev0.
Use `tailor_sources` and/or `tailor_shunit2_tests` instead. For backwards compatibility, if this option is `False`, it will override the other options.

If true, add shell_sources targets with the tailor goal.

None