2024-05-15 00:28:50 -07:00
.ie \n (.g .ds Aq \(aq
.el .ds Aq '
2024-05-25 02:37:51 -07:00
.TH just 1 "just 1.27.0"
2019-07-18 21:58:06 -07:00
.SH NAME
2024-05-15 00:28:50 -07:00
just \- 🤖 Just a command runner \- https://github.com/casey/just
.SH SYNOPSIS
2024-05-25 02:37:51 -07:00
\fB just\fR [\fB \- \- check\fR ] [\fB \- \- chooser\fR ] [\fB \- \- color\fR ] [\fB \- \- command\- color\fR ] [\fB \- \- yes\fR ] [\fB \- n\fR |\fB \- \- dry\- run\fR ] [\fB \- \- dump\- format\fR ] [\fB \- \- highlight\fR ] [\fB \- \- list\- heading\fR ] [\fB \- \- list\- prefix\fR ] [\fB \- \- no\- aliases\fR ] [\fB \- \- no\- deps\fR ] [\fB \- \- no\- dotenv\fR ] [\fB \- \- no\- highlight\fR ] [\fB \- f\fR |\fB \- \- justfile\fR ] [\fB \- q\fR |\fB \- \- quiet\fR ] [\fB \- \- set\fR ] [\fB \- \- shell\fR ] [\fB \- \- shell\- arg\fR ] [\fB \- \- shell\- command\fR ] [\fB \- \- clear\- shell\- args\fR ] [\fB \- u\fR |\fB \- \- unsorted\fR ] [\fB \- \- unstable\fR ] [\fB \- v\fR |\fB \- \- verbose\fR ]... [\fB \- d\fR |\fB \- \- working\- directory\fR ] [\fB \- \- changelog\fR ] [\fB \- \- choose\fR ] [\fB \- c\fR |\fB \- \- command\fR ] [\fB \- \- completions\fR ] [\fB \- \- dump\fR ] [\fB \- e\fR |\fB \- \- edit\fR ] [\fB \- \- evaluate\fR ] [\fB \- \- fmt\fR ] [\fB \- \- init\fR ] [\fB \- l\fR |\fB \- \- list\fR ] [\fB \- \- groups\fR ] [\fB \- \- man\fR ] [\fB \- s\fR |\fB \- \- show\fR ] [\fB \- \- summary\fR ] [\fB \- \- variables\fR ] [\fB \- \- dotenv\- filename\fR ] [\fB \- E\fR |\fB \- \- dotenv\- path\fR ] [\fB \- g\fR |\fB \- \- global\- justfile\fR ] [\fB \- h\fR |\fB \- \- help\fR ] [\fB \- V\fR |\fB \- \- version\fR ] [\fI ARGUMENTS\fR ]
2019-07-18 21:58:06 -07:00
.SH DESCRIPTION
2024-05-15 00:28:50 -07:00
🤖 Just a command runner \- https://github.com/casey/just
.SH OPTIONS
2021-08-02 18:44:01 -07:00
.TP
2021-11-21 17:08:00 -08:00
\fB \- \- check\fR
2024-05-15 00:28:50 -07:00
Run `\- \- fmt` in \* (Aqcheck\* (Aq mode. Exits with 0 if justfile is formatted correctly. Exits with 1 and prints a diff if formatting is required.
2021-11-21 17:08:00 -08:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- chooser\fR
Override binary invoked by `\- \- choose`
.RS
May also be specified with the \fB JUST_CHOOSER\fR environment variable.
.RE
.TP
\fB \- \- color\fR [default: auto]
Print colorful output
.br
.br
[\fI possible values: \fR auto, always, never]
2024-05-25 02:37:51 -07:00
.RS
May also be specified with the \fB JUST_COLOR\fR environment variable.
.RE
2024-05-15 00:28:50 -07:00
.TP
\fB \- \- command\- color\fR
Echo recipe lines in <COMMAND\- COLOR>
.br
.br
[\fI possible values: \fR black, blue, cyan, green, purple, red, yellow]
2024-05-25 02:37:51 -07:00
.RS
May also be specified with the \fB JUST_COMMAND_COLOR\fR environment variable.
.RE
2020-09-17 19:51:46 -07:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- yes\fR
Automatically confirm all recipes.
2019-12-11 17:08:48 -08:00
.TP
2023-01-24 21:43:03 -08:00
\fB \- n\fR , \fB \- \- dry\- run\fR
2019-07-18 21:58:06 -07:00
Print what just would do without doing it
2024-05-25 02:37:51 -07:00
.RS
May also be specified with the \fB JUST_DRY_RUN\fR environment variable.
.RE
2019-07-18 21:58:06 -07:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- dump\- format\fR =\fI FORMAT\fR [default: just]
Dump justfile as <FORMAT>
.br
.br
[\fI possible values: \fR just, json]
2021-06-12 15:49:27 -07:00
.TP
2019-07-18 21:58:06 -07:00
\fB \- \- highlight\fR
Highlight echoed recipe lines in bold
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- list\- heading\fR =\fI TEXT\fR
Print <TEXT> before list
2019-12-11 17:08:48 -08:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- list\- prefix\fR =\fI TEXT\fR
Print <TEXT> before each list item
2019-07-18 21:58:06 -07:00
.TP
2024-05-13 20:48:14 -07:00
\fB \- \- no\- aliases\fR
2024-05-15 00:28:50 -07:00
Don\* (Aqt show aliases in list
2024-05-13 20:48:14 -07:00
.TP
2024-01-12 18:54:12 -08:00
\fB \- \- no\- deps\fR
2024-05-15 00:28:50 -07:00
Don\* (Aqt run recipe dependencies
2024-01-12 18:54:12 -08:00
.TP
2020-05-23 20:59:11 -07:00
\fB \- \- no\- dotenv\fR
2024-05-15 00:28:50 -07:00
Don\* (Aqt load `.env` file
2020-05-23 20:59:11 -07:00
.TP
2019-12-11 17:08:48 -08:00
\fB \- \- no\- highlight\fR
2024-05-15 00:28:50 -07:00
Don\* (Aqt highlight echoed recipe lines in bold
.TP
\fB \- f\fR , \fB \- \- justfile\fR
Use <JUSTFILE> as justfile
2024-05-25 02:37:51 -07:00
.RS
May also be specified with the \fB JUST_JUSTFILE\fR environment variable.
.RE
2019-12-11 17:08:48 -08:00
.TP
2019-07-18 21:58:06 -07:00
\fB \- q\fR , \fB \- \- quiet\fR
Suppress all output
2024-05-25 02:37:51 -07:00
.RS
May also be specified with the \fB JUST_QUIET\fR environment variable.
.RE
2019-07-18 21:58:06 -07:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- set\fR =\fI VARIABLE VALUE\fR
Override <VARIABLE> with <VALUE>
.TP
\fB \- \- shell\fR
Invoke <SHELL> to run recipes
.TP
\fB \- \- shell\- arg\fR
Invoke shell with <SHELL\- ARG> as an argument
.TP
2021-05-16 09:11:34 -07:00
\fB \- \- shell\- command\fR
2022-01-30 12:45:42 -08:00
Invoke <COMMAND> with the shell used to run recipe lines and backticks
2021-05-16 09:11:34 -07:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- clear\- shell\- args\fR
Clear shell arguments
2019-07-18 21:58:06 -07:00
.TP
2020-08-23 20:21:08 -07:00
\fB \- u\fR , \fB \- \- unsorted\fR
Return list and summary entries in source order
.TP
2021-06-12 15:49:27 -07:00
\fB \- \- unstable\fR
Enable unstable features
2024-05-15 00:28:50 -07:00
.RS
May also be specified with the \fB JUST_UNSTABLE\fR environment variable.
.RE
2020-03-18 09:03:21 -07:00
.TP
2019-07-18 21:58:06 -07:00
\fB \- v\fR , \fB \- \- verbose\fR
Use verbose output
2024-05-25 02:37:51 -07:00
.RS
May also be specified with the \fB JUST_VERBOSE\fR environment variable.
.RE
2019-07-18 21:58:06 -07:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- d\fR , \fB \- \- working\- directory\fR
Use <WORKING\- DIRECTORY> as working directory. \- \- justfile must also be set
2024-05-25 02:37:51 -07:00
.RS
May also be specified with the \fB JUST_WORKING_DIRECTORY\fR environment variable.
.RE
2023-12-19 18:33:33 -08:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- changelog\fR
Print changelog
2019-07-18 21:58:06 -07:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- choose\fR
Select one or more recipes to run using a binary chooser. If `\- \- chooser` is not passed the chooser defaults to the value of $JUST_CHOOSER, falling back to `fzf`
2020-09-17 19:51:46 -07:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- c\fR , \fB \- \- command\fR
2021-05-16 09:11:34 -07:00
Run an arbitrary command with the working directory, `.env`, overrides, and exports set
2021-11-21 17:08:00 -08:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- completions\fR =\fI SHELL\fR
Print shell completion script for <SHELL>
.br
.br
[\fI possible values: \fR bash, elvish, fish, powershell, zsh]
2019-07-18 21:58:06 -07:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- dump\fR
Print justfile
2021-02-09 01:20:57 -08:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- e\fR , \fB \- \- edit\fR
Edit justfile with editor given by $VISUAL or $EDITOR, falling back to `vim`
2021-02-09 01:20:57 -08:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- evaluate\fR
Evaluate and print all variables. If a variable name is given as an argument, only print that variable\* (Aqs value.
2019-07-18 21:58:06 -07:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- fmt\fR
Format and overwrite justfile
2019-07-18 21:58:06 -07:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- init\fR
Initialize new justfile in project root
2022-01-29 13:18:28 -08:00
.TP
2024-05-15 00:28:50 -07:00
\fB \- l\fR , \fB \- \- list\fR
List available recipes and their arguments
2019-12-11 17:08:48 -08:00
.TP
2024-05-25 02:37:51 -07:00
\fB \- \- groups\fR
List recipe groups
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- man\fR
Print man page
.TP
\fB \- s\fR , \fB \- \- show\fR =\fI RECIPE\fR
2019-07-18 21:58:06 -07:00
Show information about <RECIPE>
.TP
2024-05-15 00:28:50 -07:00
\fB \- \- summary\fR
List names of available recipes
.TP
\fB \- \- variables\fR
List names of variables
.TP
\fB \- \- dotenv\- filename\fR
Search for environment file named <DOTENV\- FILENAME> instead of `.env`
.TP
\fB \- E\fR , \fB \- \- dotenv\- path\fR
Load <DOTENV\- PATH> as environment file instead of searching for one
.TP
2024-05-25 02:37:51 -07:00
\fB \- g\fR , \fB \- \- global\- justfile\fR
Use global justfile
.TP
2024-05-15 00:28:50 -07:00
\fB \- h\fR , \fB \- \- help\fR
Print help
.TP
\fB \- V\fR , \fB \- \- version\fR
Print version
.TP
[\fI ARGUMENTS\fR ]
2022-01-30 12:45:42 -08:00
Overrides and recipe(s) to run, defaulting to the first recipe in the justfile
2024-05-15 00:28:50 -07:00
.SH VERSION
2024-05-25 02:37:51 -07:00
v1.27.0
2024-05-15 00:28:50 -07:00
.SH AUTHORS
Casey Rodarmor <casey@rodarmor.com>