Just 命令运行器完整指南：创建 justfile、编写配方、自动化任务

cli-just by paulrberg/agent-skills

145 周安装量

42 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/paulrberg/agent-skills --skill cli-just

自动化命令行工具工程/构建系统

🇨🇳中文介绍

Just 命令运行器

概述

Just 是一款受 make 语法启发的命令运行器，本技能提供专家级指导。可用于创建 justfile 文件、编写配方、配置设置以及实现任务自动化工作流。

核心功能：

创建并合理组织具有正确结构的 justfile 文件
编写包含属性、依赖项和参数的配方
配置 shell、模块和导入的设置
使用内置常量进行终端格式化
为代码质量工具实现检查/写入模式

快速参考

基本设置

set allow-duplicate-recipes       # 允许配方覆盖导入的配方
set allow-duplicate-variables     # 允许变量覆盖导入的变量
set shell := ["bash", "-euo", "pipefail", "-c"]  # 启用严格错误处理的 bash
set unstable                      # 启用不稳定功能（模块、script 属性）
set dotenv-load                   # 自动加载 .env 文件
set positional-arguments          # 将配方参数作为 $1, $2 等传递

常用属性

属性	用途
`[arg("p", long, ...)]`	将参数配置为 `--flag` 选项（v1.46）

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

配方参数标志（v1.46.0+）

[arg()] 属性将参数配置为 CLI 风格的选项：

# 长选项 (--target)
[arg("target", long)]
build target:
    cargo build --target {{ target }}

# 短选项 (-v)
[arg("verbose", short="v")]
run verbose="false":
    echo "Verbose: {{ verbose }}"

# 长选项 + 短选项组合
[arg("output", long, short="o")]
compile output:
    gcc main.c -o {{ output }}

# 无值标志（存在即设置为 "true"）
[arg("release", long, value="true")]
build release="false":
    cargo build {{ if release == "true" { "--release" } else { "" } }}

# 帮助字符串（在 `just --usage` 中显示）
[arg("target", long, help="Build target architecture")]
build target:
    cargo build --target {{ target }}

just build --target x86_64
just build --target=x86_64
just compile -o main
just build --release
just --usage build    # 显示配方参数帮助

多个属性可以组合使用：

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

终端格式化常量全局可用（无需定义）：

常量	描述
`CYAN`, `GREEN`, `RED`, `YELLOW`, `BLUE`, `MAGENTA`	文本颜色
`BOLD`, `ITALIC`, `UNDERLINE`, `STRIKETHROUGH`	文本样式
`NORMAL`	重置格式化
`BG_*`	背景颜色（BG_RED, BG_GREEN 等）
`HEX`, `HEXLOWER`	十六进制数字

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

# 要求可执行文件存在（如果未找到则使配方失败）
jq := require("jq")

# 获取环境变量（带默认值）
log_level := env("LOG_LEVEL", "info")

# 获取 justfile 目录路径
root := justfile_dir()

状态报告器模式

在多步骤工作流中显示格式化的状态：

@_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

为代码质量工具配对检查（验证）和写入（修复）配方：

[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

完整检查/写入模式

聚合所有检查并附带状态报告：

[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

配方	别名	配方	别名
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

Just 通过两种方法支持任何语言的内联脚本：

脚本属性（推荐）

使用 [script("interpreter")] 以获得跨平台兼容性：

[script("node")]
fetch-data:
    const response = await fetch('https://api.example.com/data');
    const data = await response.json();
    console.log(data);

[script("python3")]
analyze:
    import json
    with open('package.json') as f:
        pkg = json.load(f)
    print(f"Package: {pkg['name']}@{pkg['version']}")

[script("bash")]
deploy:
    set -e
    npm run build
    aws s3 sync dist/ s3://bucket/

在配方开头使用 #!/usr/bin/env interpreter：

node-script:
    #!/usr/bin/env node
    console.log(`Node ${process.version}`);
    console.log(JSON.stringify(process.env, null, 2));

python-script:
    #!/usr/bin/env python3
    import sys
    print(f"Python {sys.version}")

bash-script:
    #!/usr/bin/env bash
    set -euo pipefail
    echo "Running on $(uname -s)"

何时使用哪种方法：

[script()] - 更好的跨平台支持，语法更清晰
Shebang - 传统的 Unix 方法，无需 set unstable 即可工作

从另一个文件包含配方：

import "./just/settings.just"
import "./just/base.just"
import? "./local.just"    # 可选（如果缺失不报错）

加载子模块（需要 set unstable）：

mod foo                   # 加载 foo.just 或 foo/justfile
mod bar "path/to/bar"     # 自定义路径
mod? optional             # 可选模块

# 调用模块中的配方
just foo::build

适用于使用 @sablier/devkit 的项目：

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

标准章节标题格式：

# ---------------------------------------------------------------------------- #
#                                 依赖项
# ---------------------------------------------------------------------------- #

常见章节（按顺序）：

依赖项 - 必需工具及其 URL
常量 - 全局模式、环境变量
配方 / 命令 - 主要入口点
检查 - 代码质量配方
工具 / 内部助手 - 私有助手

始终定义一个默认配方：

# 显示可用命令
default:
    @just --list

在顶部记录必需的工具：

# ---------------------------------------------------------------------------- #
#                                 依赖项
# ---------------------------------------------------------------------------- #

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

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

# 用法：直接在配方中调用（不要使用插值）
build:
    bun next build

注意： require() 在配方求值时验证工具是否存在。直接使用变量名（例如 bun），不要使用插值（{{ bun }}）。

Context7 备用方案

对于本技能未涵盖的 Just 功能（新属性、高级函数、边缘情况），请获取最新文档：

使用 library ID 为 `/websites/just_systems-man` 的 context7 MCP 来获取最新的 Just 文档。

可搜索的示例主题：

modules import mod - 模块系统详情
settings - 所有可用设置
attributes - 配方属性
functions - 内置函数
script recipes - 脚本块语法

如需详细模式和全面覆盖范围，请查阅：

references/settings.md - 设置配置和模块系统
references/recipes.md - 配方属性、参数、依赖项和前缀
references/syntax.md - 常量、函数、变量和 CLI 选项
references/patterns.md - 既定约定、章节组织、助手模式

examples/ 目录中的工作 justfile 模板：

devkit.just - 导入 @sablier/devkit 的最小模板
standalone.just - 包含所有模式的完整独立模板

官方手册：https://just.systems/man/en/
GitHub 仓库：https://github.com/casey/just
Context7 Library ID：/websites/just_systems-man

无 Justfile 格式化器

不要使用 just --fmt 或 just --dump。用户有特定的格式化偏好，内置格式化器无法满足。请按原样保留现有格式。

使用 @ 前缀来抑制命令回显：@echo "quiet"
使用 + 表示可变参数：test +args
使用 * 表示可选的可变参数：build *flags
在变量中引用全局模式：GLOBS := "\"**/*.json\""
在 monorepo 中使用 [no-cd] 以保持在当前目录
私有配方以 _ 开头或使用 [private]
始终在配方名称后定义别名以提高可发现性

🇺🇸English

Just Command Runner

Overview

Expert guidance for Just, a command runner with syntax inspired by make. Use this skill for creating justfiles, writing recipes, configuring settings, and implementing task automation workflows.

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)
set dotenv-load                   # Auto-load .env file
set positional-arguments          # Pass recipe args as $1, $2, etc.

Common Attributes

Attribute	Purpose
`[arg("p", long, ...)]`	Configure parameter as `--flag` option (v1.46)
`[arg("p", pattern="…")]`	Constrain parameter to match regex pattern
`[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

Recipe Argument Flags (v1.46.0+)

The [arg()] attribute configures parameters as CLI-style options:

# Long option (--target)
[arg("target", long)]
build target:
    cargo build --target {{ target }}

# Short option (-v)
[arg("verbose", short="v")]
run verbose="false":
    echo "Verbose: {{ verbose }}"

# Combined long + short
[arg("output", long, short="o")]
compile output:
    gcc main.c -o {{ output }}

# Flag without value (presence sets to "true")
[arg("release", long, value="true")]
build release="false":
    cargo build {{ if release == "true" { "--release" } else { "" } }}

# Help string (shown in `just --usage`)
[arg("target", long, help="Build target architecture")]
build target:
    cargo build --target {{ target }}

Usage examples:

just build --target x86_64
just build --target=x86_64
just compile -o main
just build --release
just --usage build    # Show recipe argument help

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`, `MAGENTA`	Text colors
`BOLD`, `ITALIC`, `UNDERLINE`, `STRIKETHROUGH`

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

Inline Scripts

Just supports inline scripts in any language via two methods:

Script Attribute (Recommended)

Use [script("interpreter")] for cross-platform compatibility:

[script("node")]
fetch-data:
    const response = await fetch('https://api.example.com/data');
    const data = await response.json();
    console.log(data);

[script("python3")]
analyze:
    import json
    with open('package.json') as f:
        pkg = json.load(f)
    print(f"Package: {pkg['name']}@{pkg['version']}")

[script("bash")]
deploy:
    set -e
    npm run build
    aws s3 sync dist/ s3://bucket/

Shebang Method

Use #!/usr/bin/env interpreter at the recipe start:

node-script:
    #!/usr/bin/env node
    console.log(`Node ${process.version}`);
    console.log(JSON.stringify(process.env, null, 2));

python-script:
    #!/usr/bin/env python3
    import sys
    print(f"Python {sys.version}")

bash-script:
    #!/usr/bin/env bash
    set -euo pipefail
    echo "Running on $(uname -s)"

When to use which:

[script()] - Better cross-platform support, cleaner syntax
Shebang - Traditional Unix approach, works without set unstable

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")

# Usage: invoke directly in recipes (not with interpolation)
build:
    bun next build

Note: require() validates the tool exists at recipe evaluation time. Use the variable name directly (e.g., bun), not with interpolation ({{ bun }}).

Context7 Fallback

For Just features not covered in this skill (new attributes, advanced functions, edge cases), fetch the latest documentation:

Use context7 MCP with library ID `/websites/just_systems-man` to get up-to-date Just documentation.

Example topics to search:

modules import mod - Module system details
settings - All available settings
attributes - Recipe attributes
functions - Built-in functions
script recipes - Script block syntax

Additional Resources

Reference Files

For detailed patterns and comprehensive coverage, consult:

references/settings.md - Settings configuration and module system
references/recipes.md - Recipe attributes, parameters, dependencies, and prefixes
references/syntax.md - Constants, functions, variables, and CLI options
references/patterns.md - Established conventions, section organization, helper patterns

Example Templates

Working justfile templates in examples/:

devkit.just - Minimal template importing @sablier/devkit
standalone.just - Full standalone template with all patterns

External Documentation

Official Manual : https://just.systems/man/en/
GitHub Repository : https://github.com/casey/just
Context7 Library ID : /websites/just_systems-man

No Justfile Formatter

Do not use just --fmt or just --dump. The user has bespoke formatting preferences that the built-in formatter does not respect. Preserve existing formatting as-is.

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]

Weekly Installs

116

Repository

paulrberg/agent-skills

GitHub Stars

First Seen

Feb 9, 2026

Security Audits

Gen Agent Trust HubPass SocketPass SnykWarn

Installed on

claude-code104

codex96

opencode96

gemini-cli95

github-copilot95

amp95

Skills CLI 使用指南：AI Agent 技能包管理器安装与管理教程

43,100 周安装

Always define aliases after recipe names for discoverability

Just 命令运行器完整指南：创建 justfile、编写配方、自动化任务

🇨🇳中文介绍

Just 命令运行器

概述

快速参考

基本设置

常用属性

相关 Skills

配方参数标志（v1.46.0+）

内置常量

关键函数

配方模式

状态报告器模式

检查/写入模式