Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Settings

Settings control interpretation and execution. Each setting may be specified at most once, anywhere in the justfile.

For example:

set shell := ["zsh", "-cu"]

foo:
  # this line will be run as `zsh -cu 'ls **/*.txt'`
  ls **/*.txt

Table of Settings

NameValueDefaultDescription
allow-duplicate-recipesbooleanfalseAllow recipes appearing later in a justfile to override earlier recipes with the same name.
allow-duplicate-variablesbooleanfalseAllow variables appearing later in a justfile to override earlier variables with the same name.
default-listbooleanfalseList recipes instead of running the default recipe.
default-script1.52.0booleanfalseDefault recipes to script instead of shell.
dotenv-command1.54.0string-Run a command and load its output as an environment file.
dotenv-filenamestring-Load a .env file with a custom name, if present.
dotenv-loadbooleanfalseLoad a .env file, if present.
dotenv-overridebooleanfalseOverride existing environment variables with values from the .env file.
dotenv-pathstring-Load a .env file from a custom path and error if not present. Overrides dotenv-filename.
dotenv-requiredbooleanfalseError if a .env file isn’t found.
exportbooleanfalseExport all variables as environment variables.
fallbackbooleanfalseSearch for justfile in parent directory if the first recipe on the command line is not found.
guards1.47.0booleanfalseEnable the ? guard sigil on recipe lines. See sigils.
ignore-commentsbooleanfalseIgnore recipe lines beginning with #.
lazy1.47.0booleanfalseDon’t evaluate unused variables.
lists1.53.0booleanfalseValues may be lists of strings instead of strings. Currently unstable.
minimum-version1.55.0string-Error if just is older than minimum-version. Accepts a string of the form MAJOR.MINOR.PATCH, e.g., "1.55.0".
no-cd1.51.0booleanfalseDon’t change directory when executing recipes by recipe attribute.
no-exit-message1.39.0booleanfalseDon’t print exit messages if recipes fail.
positional-argumentsbooleanfalsePass positional arguments.
quietbooleanfalseDisable echoing recipe lines before executing.
script-interpreter1.33.0[COMMAND, ARGS…]['sh', '-eu']Set command used to invoke recipes with empty [script] attribute.
shell[COMMAND, ARGS…]-Set command used to invoke recipes and evaluate backticks.
tempdirstring-Create temporary directories in tempdir instead of the system default temporary directory.
unstable1.31.0booleanfalseEnable unstable features.
windows-powershellbooleanfalseUse PowerShell on Windows as default shell. (Deprecated. Use windows-shell instead.)
windows-shell[COMMAND, ARGS…]-Set the command used to invoke recipes and evaluate backticks.
working-directory1.33.0string-Set the working directory for recipes and backticks, relative to the default working directory.

Boolean settings can be written as:

set NAME

Which is equivalent to:

set NAME := true

Non-boolean settings can be set to both strings and expressions1.46.0.

However, because settings affect the behavior of backticks and many functions, those expressions may not contain backticks or function calls, directly or transitively via reference.