Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.aspect.build/llms.txt

Use this file to discover all available pages before exploring further.

sh_binary rule definition.

​
Rule: sh_binary

The sh_binary rule is used to declare executable shell scripts. (sh_binary is a misnomer: its outputs aren’t necessarily binaries.) This rule ensures that all dependencies are built, and appear in the runfiles area at execution time. We recommend that you name your sh_binary() rules after the name of the script minus the extension (e.g. .sh); the rule name and the file name must be distinct. sh_binary respects shebangs, so any available interpreter may be used (eg. #!/bin/zsh)

​
Example

For a simple shell script with no dependencies and some data files: 
sh_binary(
    name = "foo",
    srcs = ["foo.sh"],
    data = glob(["datafiles/*.txt"]),
)
Kind: Executable rule

​
Attributes

​
name
name
required
A unique name for this target.
​
srcs
list of labels
default:"[]"
The file containing the shell script.This attribute must be a singleton list, whose element is the shell script. This script must be executable, and may be a source file or a generated file. All other files required at runtime (whether scripts or data) belong in the data attribute.
​
data
list of labels
default:"[]"
​
deps
list of labels
default:"[]"
The list of “library” targets to be aggregated into this target. See general comments about deps at Typical attributes defined by most build rulesThis attribute should be used to list other sh_library rules that provide interpreted program source code depended on by the code in srcs. The files provided by these rules will be present among the runfiles of this target.
​
env
dictionary: String → String
default:"{}"
​
env_inherit
list of strings
default:"[]"
​
use_bash_launcher
boolean
default:"False"
Use a bash launcher initializing the runfiles library