just(1)

🎀 just(1) — General Commands Manual 🎀

okay so you pulled up the just(1) page out of the General Commands Manual and bestie, you have absolutely come to the right place 💅 this is the whole thing, nothing skipped, let's go 🦋

---

🤖 NAME 🤖

just — 🤖 Just a command runner - https://github.com/casey/just

---

✨ SYNOPSIS ✨

like, here's the whole shape of the vibe, every bracket included, no cap:

just [--alias-style] [--allow-missing] [--ceiling] [--check] [--chooser]
[--clear-shell-args] [--color] [--command-color] [--complete-aliases]
[--cygpath] [--default-list] [--dotenv-command] [-F|--dotenv-filename]
[-E|--dotenv-path] [-n|--dry-run] [--dump-format] [--evaluate-format]
[--explain] [-g|--global-justfile] [--group] [--highlight]
[--indentation] [--jobs] [-f|--justfile] [--justfile-name]
[--list-heading] [--list-prefix] [--list-submodules] [--no-aliases]
[--no-cache] [--no-deps] [--no-dotenv] [--no-highlight] [--one]
[-q|--quiet] [--set] [--shell] [--shell-arg] [--shell-command]
[--changelog] [--choose] [--clean] [-c|--command] [--completions]
[--dump] [-e|--edit] [--evaluate] [--fmt] [--groups] [--init] [--json]
[-l|--list] [--man] [-s|--show] [--summary] [--usage] [--variables]
[--tempdir] [--time] [--timestamp] [--timestamp-format] [-u|--unsorted]
[--unstable] [-v|--verbose]... [-d|--working-directory] [--yes]
[-h|--help] [-V|--version] [ARGUMENTS]

---

🌸 DESCRIPTION 🌸

🤖 Just a command runner - https://github.com/casey/just

that's it, that's the whole description, it's giving minimalist main character energy and we respect it 👑

---

💖 OPTIONS 💖

no skipping, no summarising, every single one is here:

• --alias-style <ALIAS_STYLE> — set the alias display style for the list command. [default: right] possible values:
  • left
  • right
  • separate
• --allow-missing — just... ignore missing recipe and module errors. the drama? declined 💀
• --ceiling <CEILING> — do not ascend above <CEILING> directory when searching for a justfile. that's the roof, bestie, we do not go past it.
• --check — runs --fmt in 'check' mode. exits with 0 if the justfile is formatted correctly. exits with 1 and prints a diff if formatting is required. it's literally grading your formatting ✨
• --chooser <CHOOSER> — override the binary that --choose invokes.
• --clear-shell-args — clear shell arguments.
• --color <COLOR> — print colorful output. [default: auto] possible values:
  • always
  • auto
  • never
• --command-color <COMMAND_COLOR> — echo recipe lines in <COMMAND-COLOR>. possible values:
  • black
  • blue
  • cyan
  • green
  • purple
  • red
  • yellow
• --complete-aliases — auto-complete recipe aliases 🫶
• --cygpath <CYGPATH> — use the binary at <CYGPATH> to convert between unix and Windows paths. [default: cygpath]
• --default-list — list recipes when no arguments are provided.
• --dotenv-command <COMMAND> — run <COMMAND> and load its output as an environment file.
• -F, --dotenv-filename <DOTENV_FILENAME> — search for an environment file named <DOTENV-FILENAME> instead of .env.
• -E, --dotenv-path <DOTENV_PATH> — load <DOTENV-PATH> as an environment file instead of searching for one.
• -n, --dry-run — print what just would do without doing it. lowkey the safest way to live 🙈
• --dump-format <FORMAT> — dump the justfile as <FORMAT>. [default: just] possible values:
  • json
  • just
• --evaluate-format <FORMAT> — print evaluated variables in <FORMAT>. [default: just] possible values:
  • just
  • shell
• --explain — print the recipe doc comment before running it 📝
• -g, --global-justfile — use the global justfile.
• --group <GROUP> — only list recipes in <GROUP>.
• --highlight — highlight echoed recipe lines in bold.
• --indentation <INDENTATION> — indent recipe bodies with <INDENTATION>.
• --jobs <N> — run at most <N> recipes simultaneously with the [parallel] attribute ⚡
• -f, --justfile <JUSTFILE> — use <JUSTFILE> as the justfile, or - to read from standard input.
• --justfile-name <NAME> — search for a justfile named <NAME>, accepts multiple ,-separated values and may be repeated.
• --list-heading <TEXT> — print <TEXT> before the list. [default: Available recipes:\n]
• --list-prefix <TEXT> — print <TEXT> before each list item. [default: ] (that's four whole spaces, iconique)
• --list-submodules — list recipes in submodules.
• --no-aliases — don't show aliases in the list.
• --no-cache — bypass the recipe cache.
• --no-deps — don't run recipe dependencies.
• --no-dotenv — don't load the .env file.
• --no-highlight — don't highlight echoed recipe lines in bold.
• --one — forbid multiple recipes from being invoked on the command line. one (1) recipe. that's the rule ✋
• -q, --quiet — suppress all output. silence, but make it fashion.
• --set <VARIABLE> <VALUE> — override <VARIABLE> with <VALUE>.
• --shell <SHELL> — invoke <SHELL> to run recipes.
• --shell-arg <SHELL_ARG> — invoke the shell with <SHELL-ARG> as an argument.
• --shell-command — invoke <COMMAND> with the shell used to run recipe lines and backticks.
• --tempdir <TEMPDIR> — save temporary files to <TEMPDIR>.
• --time — print recipe execution time ⏱️
• --timestamp — print recipe command timestamps.
• --timestamp-format <TIMESTAMP_FORMAT> — timestamp format string. [default: %H:%M:%S]
• -u, --unsorted — return list and summary entries in source order.
• --unstable — enable unstable features. buckle up 🎢
• -v, --verbose — use verbose output. (you can stack it: -v... iykyk)
• -d, --working-directory <WORKING_DIRECTORY> — use <WORKING-DIRECTORY> as the working directory.
• --yes — automatically confirm all recipes.
• -h, --help — print help.
• -V, --version — print version.
• [ARGUMENTS] — overrides and recipe(s) to run, defaulting to the first recipe in the justfile.

---

🌈 COMMANDS 🌈

these ones are the doing commands, and yes, they're listed separately, that's just how this page rolls:

• --changelog — print changelog.
• --choose — 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.
• --clean [<RECIPE_PATH>...] — clear the recipe cache, optionally restricted to recipes whose path begins with <RECIPE_PATH>.
• -c, --command <COMMAND>... — run an arbitrary command with the working directory, .env, overrides, and exports set.
• --completions <SHELL> — print a shell completion script for <SHELL>. possible values:
  • bash
  • elvish
  • fish
  • nushell
  • powershell
  • zsh
• --dump — print justfile.
• -e, --edit — edit the justfile with the editor given by $VISUAL or $EDITOR, falling back to vim.
• --evaluate — evaluate and print all variables. if a variable name is given as an argument, only print that variable's value.
• --fmt — format and overwrite the justfile 💅
• --groups — list recipe groups.
• --init — initialize a new justfile in the project root.
• --json — print justfile as JSON.
• -l, --list [<MODULE>...] — list available recipes in <MODULE>, or root if omitted.
• --man — print man page. (yes, this page. very meta, we love a self-reference 🪞)
• -s, --show <RECIPE_PATH>... — show recipe at <RECIPE_PATH>.
• --summary — list names of available recipes.
• --usage [<PATH>...] — print usage information for the recipe at <PATH>, or all recipes in the module at <PATH>, defaulting to all recipes in the root justfile.
• --variables — list names of variables.

---

⭐ VERSION ⭐

v1.59.0

---

👑 AUTHORS 👑

Casey Rodarmor <casey@rodarmor.com>

---

and that's the whole page bestie, you ate it 🍓 this was just 1.59.0, just(1), straight from the General Commands Manual — go forth and run your recipes, you absolute icon 💜✨