2021-02-09 01:20:57 -08:00
|
|
|
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.15.
|
|
|
|
|
.TH JUST "1" "February 2021" "just 0.8.4" "Just Manual"
|
2019-07-18 21:58:06 -07:00
|
|
|
.SH NAME
|
|
|
|
|
just \- save and run commands
|
|
|
|
|
.SH DESCRIPTION
|
2021-02-09 01:20:57 -08:00
|
|
|
just 0.8.4
|
2019-07-18 21:58:06 -07:00
|
|
|
\- Please see https://github.com/casey/just for more information.
|
|
|
|
|
.SS "USAGE:"
|
|
|
|
|
.IP
|
|
|
|
|
just [FLAGS] [OPTIONS] [\-\-] [ARGUMENTS]...
|
|
|
|
|
.SS "FLAGS:"
|
|
|
|
|
.TP
|
2020-09-17 19:51:46 -07:00
|
|
|
\fB\-\-choose\fR
|
2020-10-15 20:17:38 -07:00
|
|
|
Select one or more recipes to run using a binary. 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
|
2019-12-11 17:08:48 -08:00
|
|
|
\fB\-\-clear\-shell\-args\fR
|
|
|
|
|
Clear shell arguments
|
|
|
|
|
.TP
|
2019-07-18 21:58:06 -07:00
|
|
|
\fB\-\-dry\-run\fR
|
|
|
|
|
Print what just would do without doing it
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-dump\fR
|
|
|
|
|
Print entire justfile
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-e\fR, \fB\-\-edit\fR
|
2019-12-11 17:08:48 -08:00
|
|
|
Edit justfile with editor given by $VISUAL or $EDITOR, falling back to `vim`
|
2019-07-18 21:58:06 -07:00
|
|
|
.TP
|
|
|
|
|
\fB\-\-evaluate\fR
|
|
|
|
|
Print evaluated variables
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-highlight\fR
|
|
|
|
|
Highlight echoed recipe lines in bold
|
|
|
|
|
.TP
|
2019-12-11 17:08:48 -08:00
|
|
|
\fB\-\-init\fR
|
|
|
|
|
Initialize new justfile in project root
|
|
|
|
|
.TP
|
2019-07-18 21:58:06 -07:00
|
|
|
\fB\-l\fR, \fB\-\-list\fR
|
|
|
|
|
List available recipes and their arguments
|
|
|
|
|
.TP
|
2020-05-23 20:59:11 -07:00
|
|
|
\fB\-\-no\-dotenv\fR
|
|
|
|
|
Don't load `.env` file
|
|
|
|
|
.TP
|
2019-12-11 17:08:48 -08:00
|
|
|
\fB\-\-no\-highlight\fR
|
|
|
|
|
Don't highlight echoed recipe lines in bold
|
|
|
|
|
.TP
|
2019-07-18 21:58:06 -07:00
|
|
|
\fB\-q\fR, \fB\-\-quiet\fR
|
|
|
|
|
Suppress all output
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-summary\fR
|
|
|
|
|
List names of available recipes
|
|
|
|
|
.TP
|
2020-08-23 20:21:08 -07:00
|
|
|
\fB\-u\fR, \fB\-\-unsorted\fR
|
|
|
|
|
Return list and summary entries in source order
|
|
|
|
|
.TP
|
2020-03-18 09:03:21 -07:00
|
|
|
\fB\-\-variables\fR
|
|
|
|
|
List names of variables
|
|
|
|
|
.TP
|
2019-07-18 21:58:06 -07:00
|
|
|
\fB\-v\fR, \fB\-\-verbose\fR
|
|
|
|
|
Use verbose output
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
|
|
|
Print help information
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-V\fR, \fB\-\-version\fR
|
|
|
|
|
Print version information
|
|
|
|
|
.SS "OPTIONS:"
|
2020-09-17 19:51:46 -07:00
|
|
|
.TP
|
|
|
|
|
\fB\-\-chooser\fR <CHOOSER>
|
|
|
|
|
Override binary invoked by `\-\-choose`
|
2019-07-18 21:58:06 -07:00
|
|
|
.HP
|
|
|
|
|
\fB\-\-color\fR <COLOR>
|
|
|
|
|
.TP
|
|
|
|
|
Print colorful output [default: auto]
|
|
|
|
|
[possible values: auto, always, never]
|
2020-01-15 02:16:13 -08:00
|
|
|
.HP
|
|
|
|
|
\fB\-\-completions\fR <SHELL>
|
|
|
|
|
.IP
|
|
|
|
|
Print shell completion script for <SHELL> [possible values: zsh, bash, fish, powershell, elvish]
|
2019-07-18 21:58:06 -07:00
|
|
|
.TP
|
|
|
|
|
\fB\-f\fR, \fB\-\-justfile\fR <JUSTFILE>
|
2021-02-09 01:20:57 -08:00
|
|
|
Use <JUSTFILE> as justfile
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-list\-heading\fR <TEXT>
|
|
|
|
|
Print <TEXT> before list
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-\-list\-prefix\fR <TEXT>
|
|
|
|
|
Print <TEXT> before each list item
|
2019-07-18 21:58:06 -07:00
|
|
|
.TP
|
|
|
|
|
\fB\-\-set\fR <VARIABLE> <VALUE>
|
2019-12-11 17:08:48 -08:00
|
|
|
Override <VARIABLE> with <VALUE>
|
2019-07-18 21:58:06 -07:00
|
|
|
.TP
|
|
|
|
|
\fB\-\-shell\fR <SHELL>
|
|
|
|
|
Invoke <SHELL> to run recipes [default: sh]
|
|
|
|
|
.TP
|
2019-12-11 17:08:48 -08:00
|
|
|
\fB\-\-shell\-arg\fR <SHELL\-ARG>...
|
|
|
|
|
Invoke shell with <SHELL\-ARG> as an argument [default: \fB\-cu]\fR
|
|
|
|
|
.TP
|
2019-07-18 21:58:06 -07:00
|
|
|
\fB\-s\fR, \fB\-\-show\fR <RECIPE>
|
|
|
|
|
Show information about <RECIPE>
|
|
|
|
|
.HP
|
|
|
|
|
\fB\-d\fR, \fB\-\-working\-directory\fR <WORKING\-DIRECTORY>
|
|
|
|
|
.IP
|
|
|
|
|
Use <WORKING\-DIRECTORY> as working directory. \fB\-\-justfile\fR must also be set
|
|
|
|
|
.SS "ARGS:"
|
|
|
|
|
.TP
|
|
|
|
|
<ARGUMENTS>...
|
2019-12-11 17:08:48 -08:00
|
|
|
Overrides and recipe(s) to run, defaulting to the first recipe in the justfile
|
