Operation	Just Recipe	Instead Of
Run tests	`just test`	`npm test`, `cargo test`, `pytest`
Build	`just build`	`npm run build`, `cargo build`
Lint	`just lint`	`npm run lint`, `cargo clippy`
Format	`just fmt`	`npm run format`, `cargo fmt`
Check	`just check`	`npm run check`, `cargo check`
Coverage	`just coverage`	`npm run coverage`, `cargo llvm-cov`
Audit	`just audit`	`npm audit`, `cargo audit`
Dev server	`just dev`	`npm run dev`, `cargo run`
Clean	`just clean`	`rm -rf dist`, `cargo clean`

Common Recipe Naming Conventions

test / t - Run test suite
build / b - Build project
lint - Run linter
fmt - Format code
check - Type checking / static analysis
coverage - Generate coverage report
audit - Security audit
dev / serve - Start development server
clean - Remove build artifacts
full-check / fc - Run all checks

Key capabilities:

Create and organize justfiles with proper structure
Write recipes with attributes, dependencies, and parameters
Configure settings for shell, modules, and imports
Use built-in constants for terminal formatting
Implement check/write patterns for code quality tools

Quick Reference

Essential Settings

set allow-duplicate-recipes       # Allow recipes to override imported ones
set allow-duplicate-variables     # Allow variables to override imported ones
set shell := ["bash", "-euo", "pipefail", "-c"]  # Strict bash with error handling
set unstable                      # Enable unstable features (modules, script attribute)

Environment Variables: Use mise for environment variable management instead of Just's dotenv settings. mise provides project-scoped env vars via .mise.toml with better tooling integration.

Common Attributes

Attribute	Purpose
`[group("name")]`	Group recipes in `just --list` output
`[no-cd]`	Don't change to justfile directory
`[private]`	Hide from `just --list` (same as `_` prefix)
`[script]`	Execute recipe as single script block
`[script("interpreter")]`	Use specific interpreter (bash, python, etc.)
`[confirm("prompt")]`	Require user confirmation before running
`[doc("text")]`	Override recipe documentation
`[positional-arguments]`	Enable positional args for this recipe only

Multiple attributes can be combined:

[no-cd, private]
[group("checks")]
recipe:
    echo "hello"

Built-in Constants

Terminal formatting constants are globally available (no definition needed):

Constant	Description
`CYAN`, `GREEN`, `RED`, `YELLOW`, `BLUE`, `PURPLE`	Text colors
`BOLD`, `ITALIC`, `UNDERLINE`, `STRIKETHROUGH`	Text styles
`NORMAL`	Reset formatting
`BG_*`	Background colors (BG_RED, BG_GREEN, etc.)
`HEX`, `HEXLOWER`	Hexadecimal digits

Usage:

@status:
    echo -e '{{ GREEN }}Success!{{ NORMAL }}'
    echo -e '{{ BOLD + CYAN }}Building...{{ NORMAL }}'

Key Functions

# Require executable exists (fails recipe if not found)
jq := require("jq")

# Get environment variable with default
log_level := env("LOG_LEVEL", "info")

# Get justfile directory path
root := justfile_dir()

Recipe Patterns

Status Reporter Pattern

Display formatted status during multi-step workflows:

@_run-with-status recipe *args:
    echo ""
    echo -e '{{ CYAN }}→ Running {{ recipe }}...{{ NORMAL }}'
    just {{ recipe }} {{ args }}
    echo -e '{{ GREEN }}✓ {{ recipe }} completed{{ NORMAL }}'
alias rws := _run-with-status

Check/Write Pattern

Pair check (verify) and write (fix) recipes for code quality tools:

[group("checks")]
@biome-check +globs=".":
    na biome check {{ globs }}
alias bc := biome-check

[group("checks")]
@biome-write +globs=".":
    na biome check --write {{ globs }}
alias bw := biome-write

Full Check/Write Pattern

Aggregate all checks with status reporting:

[group("checks")]
@full-check:
    just _run-with-status biome-check
    just _run-with-status prettier-check
    just _run-with-status tsc-check
    echo ""
    echo -e '{{ GREEN }}All code checks passed!{{ NORMAL }}'
alias fc := full-check

[group("checks")]
@full-write:
    just _run-with-status biome-write
    just _run-with-status prettier-write
    echo ""
    echo -e '{{ GREEN }}All code fixes applied!{{ NORMAL }}'
alias fw := full-write

Standard Alias Conventions

Recipe	Alias	Recipe	Alias
full-check	fc	full-write	fw
biome-check	bc	biome-write	bw
prettier-check	pc	prettier-write	pw
mdformat-check	mc	mdformat-write	mw
tsc-check	tc	ruff-check	rc
test	t	build	b

Modules & Imports

Import Pattern

Include recipes from another file:

import "./just/settings.just"
import "./just/base.just"
import? "./local.just"    # Optional (no error if missing)

Module Pattern

Load submodule (requires set unstable):

mod foo                   # Loads foo.just or foo/justfile
mod bar "path/to/bar"     # Custom path
mod? optional             # Optional module

# Call module recipes
just foo::build

Devkit Import Pattern

For projects using @sablier/devkit:

import "./node_modules/@sablier/devkit/just/base.just"
import "./node_modules/@sablier/devkit/just/npm.just"

Section Organization

Standard section header format:

# ---------------------------------------------------------------------------- #
#                                 DEPENDENCIES                                 #
# ---------------------------------------------------------------------------- #

Common sections (in order):

DEPENDENCIES - Required tools with URLs
CONSTANTS - Glob patterns, environment vars
RECIPES / COMMANDS - Main entry points
CHECKS - Code quality recipes
UTILITIES / INTERNAL HELPERS - Private helpers

Default Recipe

Always define a default recipe:

# Show available commands
default:
    @just --list

Dependencies Declaration

Document required tools at the top:

# ---------------------------------------------------------------------------- #
#                                 DEPENDENCIES                                 #
# ---------------------------------------------------------------------------- #

# Bun: https://bun.sh
bun := require("bun")

# Ni: https://github.com/antfu-collective/ni
na := require("na")
ni := require("ni")
nlx := require("nlx")

Additional Resources

Reference Files

For detailed patterns and comprehensive coverage, consult:

reference.md - Complete settings, modules, attributes, functions reference
patterns.md - Established conventions, section organization, helper patterns

External Documentation

Official Manual: https://just.systems/man/en/
GitHub Repository: https://github.com/casey/just

Important Limitations

Just does not support flags. Recipe parameters are positional only:

# WRONG: Flags don't work
build --release:  # This won't work!

# CORRECT: Use positional parameters
build mode="debug":
    cargo build {{ if mode == "release" { "--release" } else { "" } }}

# Usage: just build release

For complex flag-like behavior, use environment variables or positional parameters with defaults.

Tips

Use @ prefix to suppress command echo: @echo "quiet"
Use + for variadic parameters: test +args
Use * for optional variadic: build *flags
Quote glob patterns in variables: GLOBS := "\"**/*.json\""
Use [no-cd] in monorepos to stay in current directory
Private recipes start with _ or use [private]
Always define aliases after recipe names for discoverability

just-cli

Just Command Runner

Overview

Justfile Discovery Protocol

Discovery Steps