cf3141306e
- Bump version: 1.26.0 → 1.27.0 - Update changelog - Update changelog contributor credits - Update dependencies - Update man page - Update version references in readme
196 lines
5.7 KiB
Groff
196 lines
5.7 KiB
Groff
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.TH just 1 "just 1.27.0"
|
|
.SH NAME
|
|
just \- 🤖 Just a command runner \- https://github.com/casey/just
|
|
.SH SYNOPSIS
|
|
\fBjust\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] [\fIARGUMENTS\fR]
|
|
.SH DESCRIPTION
|
|
🤖 Just a command runner \- https://github.com/casey/just
|
|
.SH OPTIONS
|
|
.TP
|
|
\fB\-\-check\fR
|
|
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.
|
|
.TP
|
|
\fB\-\-chooser\fR
|
|
Override binary invoked by `\-\-choose`
|
|
.RS
|
|
May also be specified with the \fBJUST_CHOOSER\fR environment variable.
|
|
.RE
|
|
.TP
|
|
\fB\-\-color\fR [default: auto]
|
|
Print colorful output
|
|
.br
|
|
|
|
.br
|
|
[\fIpossible values: \fRauto, always, never]
|
|
.RS
|
|
May also be specified with the \fBJUST_COLOR\fR environment variable.
|
|
.RE
|
|
.TP
|
|
\fB\-\-command\-color\fR
|
|
Echo recipe lines in <COMMAND\-COLOR>
|
|
.br
|
|
|
|
.br
|
|
[\fIpossible values: \fRblack, blue, cyan, green, purple, red, yellow]
|
|
.RS
|
|
May also be specified with the \fBJUST_COMMAND_COLOR\fR environment variable.
|
|
.RE
|
|
.TP
|
|
\fB\-\-yes\fR
|
|
Automatically confirm all recipes.
|
|
.TP
|
|
\fB\-n\fR, \fB\-\-dry\-run\fR
|
|
Print what just would do without doing it
|
|
.RS
|
|
May also be specified with the \fBJUST_DRY_RUN\fR environment variable.
|
|
.RE
|
|
.TP
|
|
\fB\-\-dump\-format\fR=\fIFORMAT\fR [default: just]
|
|
Dump justfile as <FORMAT>
|
|
.br
|
|
|
|
.br
|
|
[\fIpossible values: \fRjust, json]
|
|
.TP
|
|
\fB\-\-highlight\fR
|
|
Highlight echoed recipe lines in bold
|
|
.TP
|
|
\fB\-\-list\-heading\fR=\fITEXT\fR
|
|
Print <TEXT> before list
|
|
.TP
|
|
\fB\-\-list\-prefix\fR=\fITEXT\fR
|
|
Print <TEXT> before each list item
|
|
.TP
|
|
\fB\-\-no\-aliases\fR
|
|
Don\*(Aqt show aliases in list
|
|
.TP
|
|
\fB\-\-no\-deps\fR
|
|
Don\*(Aqt run recipe dependencies
|
|
.TP
|
|
\fB\-\-no\-dotenv\fR
|
|
Don\*(Aqt load `.env` file
|
|
.TP
|
|
\fB\-\-no\-highlight\fR
|
|
Don\*(Aqt highlight echoed recipe lines in bold
|
|
.TP
|
|
\fB\-f\fR, \fB\-\-justfile\fR
|
|
Use <JUSTFILE> as justfile
|
|
.RS
|
|
May also be specified with the \fBJUST_JUSTFILE\fR environment variable.
|
|
.RE
|
|
.TP
|
|
\fB\-q\fR, \fB\-\-quiet\fR
|
|
Suppress all output
|
|
.RS
|
|
May also be specified with the \fBJUST_QUIET\fR environment variable.
|
|
.RE
|
|
.TP
|
|
\fB\-\-set\fR=\fIVARIABLE 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
|
|
\fB\-\-shell\-command\fR
|
|
Invoke <COMMAND> with the shell used to run recipe lines and backticks
|
|
.TP
|
|
\fB\-\-clear\-shell\-args\fR
|
|
Clear shell arguments
|
|
.TP
|
|
\fB\-u\fR, \fB\-\-unsorted\fR
|
|
Return list and summary entries in source order
|
|
.TP
|
|
\fB\-\-unstable\fR
|
|
Enable unstable features
|
|
.RS
|
|
May also be specified with the \fBJUST_UNSTABLE\fR environment variable.
|
|
.RE
|
|
.TP
|
|
\fB\-v\fR, \fB\-\-verbose\fR
|
|
Use verbose output
|
|
.RS
|
|
May also be specified with the \fBJUST_VERBOSE\fR environment variable.
|
|
.RE
|
|
.TP
|
|
\fB\-d\fR, \fB\-\-working\-directory\fR
|
|
Use <WORKING\-DIRECTORY> as working directory. \-\-justfile must also be set
|
|
.RS
|
|
May also be specified with the \fBJUST_WORKING_DIRECTORY\fR environment variable.
|
|
.RE
|
|
.TP
|
|
\fB\-\-changelog\fR
|
|
Print changelog
|
|
.TP
|
|
\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`
|
|
.TP
|
|
\fB\-c\fR, \fB\-\-command\fR
|
|
Run an arbitrary command with the working directory, `.env`, overrides, and exports set
|
|
.TP
|
|
\fB\-\-completions\fR=\fISHELL\fR
|
|
Print shell completion script for <SHELL>
|
|
.br
|
|
|
|
.br
|
|
[\fIpossible values: \fRbash, elvish, fish, powershell, zsh]
|
|
.TP
|
|
\fB\-\-dump\fR
|
|
Print justfile
|
|
.TP
|
|
\fB\-e\fR, \fB\-\-edit\fR
|
|
Edit justfile with editor given by $VISUAL or $EDITOR, falling back to `vim`
|
|
.TP
|
|
\fB\-\-evaluate\fR
|
|
Evaluate and print all variables. If a variable name is given as an argument, only print that variable\*(Aqs value.
|
|
.TP
|
|
\fB\-\-fmt\fR
|
|
Format and overwrite justfile
|
|
.TP
|
|
\fB\-\-init\fR
|
|
Initialize new justfile in project root
|
|
.TP
|
|
\fB\-l\fR, \fB\-\-list\fR
|
|
List available recipes and their arguments
|
|
.TP
|
|
\fB\-\-groups\fR
|
|
List recipe groups
|
|
.TP
|
|
\fB\-\-man\fR
|
|
Print man page
|
|
.TP
|
|
\fB\-s\fR, \fB\-\-show\fR=\fIRECIPE\fR
|
|
Show information about <RECIPE>
|
|
.TP
|
|
\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
|
|
\fB\-g\fR, \fB\-\-global\-justfile\fR
|
|
Use global justfile
|
|
.TP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
Print help
|
|
.TP
|
|
\fB\-V\fR, \fB\-\-version\fR
|
|
Print version
|
|
.TP
|
|
[\fIARGUMENTS\fR]
|
|
Overrides and recipe(s) to run, defaulting to the first recipe in the justfile
|
|
.SH VERSION
|
|
v1.27.0
|
|
.SH AUTHORS
|
|
Casey Rodarmor <casey@rodarmor.com>
|