1JUST(1)                           Just Manual                          JUST(1)
2
3
4

NAME

6       just - save and run commands
7

DESCRIPTION

9       just  1.16.0 - Please see https://github.com/casey/just for more infor‐
10       mation.
11
12   USAGE:
13              just [FLAGS] [OPTIONS] [--] [ARGUMENTS]...
14
15   FLAGS:
16       --changelog
17              Print changelog
18
19       --check
20              Run `--fmt` in 'check' mode. Exits with 0 if justfile is format‐
21              ted  correctly.  Exits with 1 and prints a diff if formatting is
22              required.
23
24       --choose
25              Select one or more recipes to run using a binary. If `--chooser`
26              is   not   passed   the   chooser   defaults  to  the  value  of
27              $JUST_CHOOSER, falling back to `fzf`
28
29       --clear-shell-args
30              Clear shell arguments
31
32       -n, --dry-run
33              Print what just would do without doing it
34
35       --dump Print justfile
36
37       -e, --edit
38              Edit justfile with editor given by $VISUAL or  $EDITOR,  falling
39              back to `vim`
40
41       --evaluate
42              Evaluate and print all variables. If a variable name is given as
43              an argument, only print that variable's value.
44
45       --fmt  Format and overwrite justfile
46
47       --highlight
48              Highlight echoed recipe lines in bold
49
50       --init Initialize new justfile in project root
51
52       -l, --list
53              List available recipes and their arguments
54
55       --no-dotenv
56              Don't load `.env` file
57
58       --no-highlight
59              Don't highlight echoed recipe lines in bold
60
61       -q, --quiet
62              Suppress all output
63
64       --shell-command
65              Invoke <COMMAND> with the shell used to  run  recipe  lines  and
66              backticks
67
68       --summary
69              List names of available recipes
70
71       -u, --unsorted
72              Return list and summary entries in source order
73
74       --unstable
75              Enable unstable features
76
77       --variables
78              List names of variables
79
80       -v, --verbose
81              Use verbose output
82
83       -h, --help
84              Print help information
85
86       -V, --version
87              Print version information
88
89   OPTIONS:
90       --chooser <CHOOSER>
91              Override binary invoked by `--choose`
92
93       --color <COLOR>
94
95       Print colorful output [default: auto]
96              [possible values: auto, always, never]
97
98       -c, --command <COMMAND>
99
100              Run  an  arbitrary  command  with the working directory, `.env`,
101              overrides, and exports set
102
103       --command-color <COMMAND-COLOR>
104
105              Echo recipe lines in <COMMAND-COLOR>  [possible  values:  black,
106              blue, cyan, green, purple, red, yellow]
107
108       --completions <SHELL>
109
110              Print shell completion script for <SHELL> [possible values: zsh,
111              bash, fish, powershell, elvish]
112
113       --dotenv-filename <DOTENV-FILENAME>
114              Search for environment file named <DOTENV-FILENAME>  instead  of
115              `.env`
116
117       --dotenv-path <DOTENV-PATH>
118              Load  environment file at <DOTENV-PATH> instead of searching for
119              one
120
121       --dump-format <FORMAT>
122
123       Dump justfile as <FORMAT> [default: just]
124              [possible values: just, json]
125
126       -f, --justfile <JUSTFILE>
127              Use <JUSTFILE> as justfile
128
129       --list-heading <TEXT>
130              Print <TEXT> before list
131
132       --list-prefix <TEXT>
133              Print <TEXT> before each list item
134
135       --set <VARIABLE> <VALUE>
136              Override <VARIABLE> with <VALUE>
137
138       --shell <SHELL>
139              Invoke <SHELL> to run recipes
140
141       --shell-arg <SHELL-ARG>...
142              Invoke shell with <SHELL-ARG> as an argument
143
144       -s, --show <RECIPE>
145              Show information about <RECIPE>
146
147       -d, --working-directory <WORKING-DIRECTORY>
148
149              Use <WORKING-DIRECTORY> as working  directory.  --justfile  must
150              also be set
151
152   ARGS:
153       <ARGUMENTS>...
154              Overrides  and  recipe(s) to run, defaulting to the first recipe
155              in the justfile
156
157
158
159just 1.16.0                      November 2023                         JUST(1)