just

<div align=right>Table of Contents↗️</div> <h1 align=center><code>just</code></h1> <div align=center> <a href=https://crates.io/crates/just> <img src=https://img.shields.io/crates/v/just.svg alt="crates.io version"> </a> <a href=https://github.com/casey/just/actions> <img src=https://github.com/casey/just/actions/workflows/ci.yaml/badge.svg alt="build status"> </a> <a href=https://github.com/casey/just/releases> <img src=https://img.shields.io/github/downloads/casey/just/total.svg alt=downloads> </a> <a href=https://discord.gg/ezYScXR> <img src=https://img.shields.io/discord/695580069837406228?logo=discord alt="chat on discord"> </a> <a href=mailto:casey@rodarmor.com?subject=Thanks%20for%20Just!> <img src=https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg alt="say thanks"> </a> </div> <br>

just is a handy way to save and run project-specific commands.

This readme is also available as a book.

(中文文档在这里, 快看过来!)

Commands, called recipes, are stored in a file called justfile with syntax inspired by make:

screenshot

You can then run them with just RECIPE:

$ 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. No need for .PHONY recipes!
Linux, MacOS, and Windows are supported with no additional dependencies. (Although if your system doesn't have an sh, you'll need to choose a different shell.)
Errors are specific and informative, and syntax errors are reported along with their source context.
Recipes can accept command line arguments.
Wherever possible, errors are resolved statically. Unknown recipes and circular dependencies are reported before anything runs.
just loads .env files, making it easy to populate environment variables.
Recipes can be listed from the command line.
Command line completion scripts are available for most popular shells.
Recipes can be written in arbitrary languages, like Python or NodeJS.
just can be invoked from any subdirectory, not just the directory that contains the justfile.
And much more!

If you need help with just please feel free to open an issue or ping me on Discord. Feature requests and bug reports are always welcome!

Installation

Prerequisites

just should run on any system with a reasonable sh, including Linux, MacOS, and the BSDs.

On Windows, just works with the sh provided by Git for Windows, GitHub Desktop, or Cygwin.

If you'd rather not install sh, you can use the shell setting to use the shell of your choice.

Like PowerShell:

# use PowerShell instead of sh:
set shell := ["powershell.exe", "-c"]

hello:
  Write-Host "Hello, world!"

…or cmd.exe:

# 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 S1 and later, and cmd.exe is quite fiddly, so PowerShell is recommended for most Windows users.)

Packages

<table> <thead> <tr> <th>Operating System</th> <th>Package Manager</th> <th>Package</th> <th>Command</th> </tr> </thead> <tbody> <tr> <td><a href=https://alpinelinux.org>Alpine Linux</a></td> <td><a href=https://wiki.alpinelinux.org/wiki/Alpine_Linux_package_management>apk-tools</a></td> <td><a href=https://pkgs.alpinelinux.org/package/edge/community/x86_64/just>just</a></td> <td><code>apk add just</code></td> </tr> <tr> <td><a href=https://www.archlinux.org>Arch Linux</a></td> <td><a href=https://wiki.archlinux.org/title/Pacman>pacman</a></td> <td><a href=https://archlinux.org/packages/extra/x86_64/just/>just</a></td> <td><code>pacman -S just</code></td> </tr> <tr> <td> <a href=https://debian.org>Debian 13 (unreleased)</a> and <a href=https://ubuntu.com>Ubuntu 24.04</a> derivatives</td> <td><a href=https://en.wikipedia.org/wiki/APT_(software)>apt</a></td> <td><a href=https://packages.debian.org/trixie/just>just</a></td> <td><code>apt install just</code></td> </tr> <tr> <td><a href=https://debian.org>Debian</a> and <a href=https://ubuntu.com>Ubuntu</a> derivatives</td> <td><a href=https://mpr.makedeb.org>MPR</a></td> <td><a href=https://mpr.makedeb.org/packages/just>just</a></td> <td> <code>git clone https://mpr.makedeb.org/just</code><br> <code>cd just</code><br> <code>makedeb -si</code> </td> </tr> <tr> <td><a href=https://debian.org>Debian</a> and <a href=https://ubuntu.com>Ubuntu</a> derivatives</td> <td><a href=https://docs.makedeb.org/prebuilt-mpr>Prebuilt-MPR</a></td> <td><a href=https://mpr.makedeb.org/packages/just>just</a></td> <td> <sup><b>You must have the <a href=https://docs.makedeb.org/prebuilt-mpr/getting-started/#setting-up-the-repository>Prebuilt-MPR set up</a> on your system in order to run this command.</b></sup><br> <code>apt install just</code> </td> </tr> <tr> <td><a href=https://getfedora.org>Fedora Linux</a></td> <td><a href=https://dnf.readthedocs.io/en/latest/>DNF</a></td> <td><a href=https://src.fedoraproject.org/rpms/rust-just>just</a></td> <td><code>dnf install just</code></td> </tr> <tr> <td><a href=https://www.freebsd.org>FreeBSD</a></td> <td><a href=https://www.freebsd.org/doc/handbook/pkgng-intro.html>pkg</a></td> <td><a href=https://www.freshports.org/deskutils/just/>just</a></td> <td><code>pkg install just</code></td> </tr> <tr> <td><a href=https://www.gentoo.org>Gentoo Linux</a></td> <td><a href=https://wiki.gentoo.org/wiki/Portage>Portage</a></td> <td><a href=https://github.com/gentoo-mirror/guru/tree/master/dev-build/just>guru/dev-build/just</a></td> <td> <code>eselect repository enable guru</code><br> <code>emerge --sync guru</code><br> <code>emerge dev-build/just</code> </td> </tr> <tr> <td><a href=https://en.wikipedia.org/wiki/MacOS>macOS</a></td> <td><a href=https://www.macports.org>MacPorts</a></td> <td><a href=https://ports.macports.org/port/just/summary>just</a></td> <td><code>port install just</code></td> </tr> <tr> <td><a href=https://en.wikipedia.org/wiki/Microsoft_Windows>Microsoft Windows</a></td> <td><a href=https://chocolatey.org>Chocolatey</a></td> <td><a href=https://github.com/michidk/just-choco>just</a></td> <td><code>choco install just</code></td> </tr> <tr> <td><a href=https://en.wikipedia.org/wiki/Microsoft_Windows>Microsoft Windows</a></td> <td><a href=https://scoop.sh>Scoop</a></td> <td><a href=https://github.com/ScoopInstaller/Main/blob/master/bucket/just.json>just</a></td> <td><code>scoop install just</code></td> </tr> <tr> <td><a href=https://en.wikipedia.org/wiki/Microsoft_Windows>Microsoft Windows</a></td> <td><a href=https://learn.microsoft.com/en-us/windows/package-manager/>Windows Package Manager</a></td> <td><a href=https://github.com/microsoft/winget-pkgs/tree/master/manifests/c/Casey/Just>Casey/Just</a></td> <td><code>winget install --id Casey.Just --exact</code></td> </tr> <tr> <td><a href=https://nixos.org/nixos/>NixOS</a></td> <td><a href=https://nixos.org/nix/>Nix</a></td> <td><a href=https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/just/default.nix>just</a></td> <td><code>nix-env -iA nixos.just</code></td> </tr> <tr> <td><a href=https://opensuse.org>openSUSE</a></td> <td><a href=https://en.opensuse.org/Portal:Zypper>Zypper</a></td> <td><a href=https://build.opensuse.org/package/show/Base:System/just>just</a></td> <td><code>zypper in just</code></td> </tr> <tr> <td><a href=https://getsol.us>Solus</a></td> <td><a href=https://getsol.us/articles/package-management/basics/en>eopkg</a></td> <td><a href=https://dev.getsol.us/source/just/>just</a></td> <td><code>eopkg install just</code></td> </tr> <tr> <td><a href=https://github.com/casey/just/releases>Various</a></td> <td><a href=https://asdf-vm.com>asdf</a></td> <td><a href=https://github.com/olofvndrhr/asdf-just>just</a></td> <td> <code>asdf plugin add just</code><br> <code>asdf install just <version></code> </td> </tr> <tr> <td><a href=https://forge.rust-lang.org/release/platform-support.html>Various</a></td> <td><a href=https://www.rust-lang.org>Cargo</a></td> <td><a href=https://crates.io/crates/just>just</a></td> <td><code>cargo install just</code></td> </tr> <tr> <td><a href=https://docs.conda.io/en/latest/miniconda.html#system-requirements>Various</a></td> <td><a href=https://docs.conda.io/projects/conda/en/latest/index.html>Conda</a></td> <td><a href=https://anaconda.org/conda-forge/just>just</a></td> <td><code>conda install -c conda-forge just</code></td> </tr> <tr> <td><a href=https://docs.brew.sh/Installation>Various</a></td> <td><a href=https://brew.sh>Homebrew</a></td> <td><a href=https://formulae.brew.sh/formula/just>just</a></td> <td><code>brew install just</code></td> </tr> <tr> <td><a href=https://nixos.org/download.html#download-nix>Various</a></td> <td><a href=https://nixos.org/nix/>Nix</a></td> <td><a href=https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/just/default.nix>just</a></td> <td><code>nix-env -iA nixpkgs.just</code></td> </tr> <tr> <td><a href=https://voidlinux.org>Void Linux</a></td> <td><a href=https://wiki.voidlinux.org/XBPS>XBPS</a></td> <td><a href=https://github.com/void-linux/void-packages/blob/master/srcpkgs/just/template>just</a></td> <td><code>xbps-install -S just</code></td> </tr> </tbody> </table>

Pre-Built Binaries

Pre-built binaries for Linux, MacOS, and Windows can be found on the releases page.

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:

curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | bash -s -- --to DEST

For example, to install just to ~/bin:

# 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 shells initialization file,
# e.g. `~/.bashrc` or `~/.zshrc`
export PATH="$PATH:$HOME/bin"

# just should now be executable
just --help

Note that install.sh may fail on GitHub Actions, or in other environments where many machines share IP addresses. install.sh calls GitHub APIs in order to determine the latest version of just to install, and those API calls are rate-limited on a per-IP basis. To make install.sh more reliable in such circumstances, pass a specific tag to install with --tag.

GitHub Actions

just can be installed on GitHub Actions in a few ways.

Using package managers pre-installed on GitHub Actions runners on MacOS with brew install just, and on Windows with choco install just.

With extractions/setup-just:

- uses: extractions/setup-just@v1
  with:
    just-version: 1.5.0  # optional semver specification, otherwise latest

Or with taiki-e/install-action:

- uses: taiki-e/install-action@just

Release RSS Feed

An RSS feed of just releases is available here.

Node.js Installation

just-install can be used to automate installation of just in Node.js applications.

just is a great, more robust alternative to npm scripts. If you want to include just in the dependencies of a Node.js application, just-install will install a local,