just

just

`just` is a handy way to save and run project-specific commands. This readme is also available as a [book](https://just.systems/man/en/). The book reflects the latest release, whereas the [readme on GitHub](https://github.com/casey/just/blob/master/README.md) reflects latest master. (中文文档在 [这里](https://github.com/casey/just/blob/master/README.中文.md), 快看过来!) Commands, called recipes, are stored in a file called `justfile` with syntax inspired by `make`: You can then run them with `just RECIPE`: ```console $ just test-all cc *.c -o main ./test --all Yay, all your tests passed! ``` `just` has a ton of useful features, and many improvements over `make`: - `just` is a command runner, not a build system, so it avoids much of [`make`'s complexity and idiosyncrasies](#what-are-the-idiosyncrasies-of-make-that-just-avoids). No need for `.PHONY` recipes! - Linux, macOS, Windows, and other reasonable unixes are supported with no additional dependencies. (Although if your system doesn't have an `sh`, you'll need to [choose a different shell](#shell).) - Errors are specific and informative, and syntax errors are reported along with their source context. - Recipes can accept [command line arguments](#recipe-parameters), including [flags and options](#recipe-flags-and-options). - `just` has a rich [expression language](#expressions) and many built-in-functions. - Wherever possible, errors are resolved statically. Unknown recipes and circular dependencies are reported before anything runs. - `just` [loads `.env` files](#dotenv-settings), making it easy to populate environment variables. - Recipes can be [listed from the command line](#listing-available-recipes). - Command line completion scripts are [available for most popular shells](#shell-completion-scripts). - Recipes can be written in [arbitrary languages](#shebang-recipes), like Python or Node.js. - `just` can be invoked from any subdirectory, not just the directory that contains the `justfile`. - `justfiles` can be organized into multiple files using [modules](#modules) and [imports](#imports). - And [much more](https://just.systems/man/en/)! If you need help with `just`, please feel free to open an issue or ping me on [Discord](https://discord.gg/ezYScXR). Feature requests and bug reports are always welcome! Installation ------------ Just can be installed using your favorite [package manager](#packages), by downloading [pre-built binaries](#pre-built-binaries), or building from source with `cargo install just`. ### Prerequisites `just` should run on any system with a reasonable `sh`, including Linux, macOS, and the BSDs. #### Windows On Windows, `just` works with the `sh` provided by [Git for Windows](https://git-scm.com), [GitHub Desktop](https://desktop.github.com), or [Cygwin](http://www.cygwin.com). After installation, `sh` must be available in the `PATH` of the shell you want to invoke `just` from. If you'd rather not install `sh`, you can use the `shell` setting to use the shell of your choice. Like PowerShell: ```just # use PowerShell instead of sh: set shell := ["powershell.exe", "-c"] hello: Write-Host "Hello, world!" ``` …or `cmd.exe`: ```just # use cmd.exe instead of sh: set shell := ["cmd.exe", "/c"] list: dir ``` You can also set the shell using command-line arguments. For example, to use PowerShell, launch `just` with `--shell powershell.exe --shell-arg -c`. (PowerShell is installed by default on Windows 7 SP1 and Windows Server 2008 R2 SP1 and later, and `cmd.exe` is quite fiddly, so PowerShell is recommended for most Windows users.) ### Packages #### Cross-platform Package Manager Package Command arkade just arkade get just asdf just asdf plugin add just
asdf install just <version> Cargo just cargo install just Cargo Binstall just cargo binstall just Conda just conda install -c conda-forge just Homebrew just brew install just Nix just nix-env -iA nixpkgs.just npm rust-just npm install -g rust-just pipx rust-just pipx install rust-just Snap just snap install --edge --classic just Spack just spack install just uv rust-just uv tool install rust-just #### BSD Operating System Package Manager Package Command FreeBSD pkg just pkg install just OpenBSD pkg_* just pkg_add just #### Linux Operating System Package Manager Package Command Alpine apk-tools just apk add just Arch pacman just pacman -S just Debian 13 and Ubuntu 24.04 derivatives apt just apt install just Fedora DNF just dnf install just Gentoo Portage dev-build/just emerge -av dev-build/just NixOS Nix just nix-env -iA nixos.just openSUSE Zypper just zypper in just Solus eopkg just eopkg install just Void XBPS just xbps-install -S just #### Windows Package Manager Package Command Chocolatey just choco install just Scoop just scoop install just Windows Package Manager Casey/Just winget install --id Casey.Just --exact #### macOS Package Manager Package Command MacPorts just port install just ### Pre-Built Binaries Pre-built binaries for Linux, macOS, and Windows can be found on [the releases page](https://github.com/casey/just/releases). You can use the following command on Linux, macOS, or Windows to download the latest release, just replace `DEST` with the directory where you'd like to put `just`: ```console curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | bash -s -- --to DEST ``` For example, to install `just` to `~/bin`: ```console # create ~/bin mkdir -p ~/bin # download and extract just to ~/bin/just curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | bash -s -- --to ~/bin # add `~/bin` to the paths that your shell searches for executables # this line should be added to your shell's initia