justfile-docs

Files (4)

• .netconfig
• SKILL.md
• justfile
• README.md · references/docs/

SKILL.md (first lines)

- Homepage: <https://github.com/casey/just>
- Version: bundled official README snapshot from the just repository
- Last updated: 2026-08-02
- This document is generated by gpt-5.6-sol

# Justfile Docs

This skill helps agents answer questions and make changes involving `just`,
`justfile`, and Just recipes by using the bundled official README at
`references/docs/README.md`.

The skill body is intentionally a guide to the bundled README, not a replacement
for it. If the answer depends on exact syntax, edge-case behavior, or command
semantics, read the relevant README section before answering or editing code.

## When to use this skill

Use this skill when the user asks about:

1. Writing, editing, reviewing, or debugging a `justfile`.
2. Recipe syntax, parameters, dependencies, aliases, groups, attributes, private
   recipes, default recipes, or documentation comments.
3. Variables, assignments, constants, expressions, substitutions, strings,
   conditional expressions, or built-in functions.
4. Shell configuration, shebang recipes, script recipes, backticks, working
   directories, environment variables, or signal and error behavior.
5. Imports, modules, global or user justfiles, fallback to parent justfiles,
   remote justfiles, markdown justfiles, or hidden justfiles.
6. The `just` CLI, including command-line options, listing recipes, formatting,
   dumping, completion scripts, parallelism, timestamps, or watch-style reruns.
7. Platform-sensitive behavior such as Windows paths, argument splitting, shell
   aliases, Node.js `package.json` script compatibility, Python recipes with
   `uv`, or safer Bash shebang patterns.
8. Comparing just with Make, Cargo build scripts, shell scripts, or other prior
   art.

## How to use the references

The bundled `references/docs/README.md` is large. Never load the whole file into
context. Start from the user's concrete task, search the README for exact terms
or nearby just terminology, then read only the relevant section and enough
surrounding lines to understand it.

Use heading locations to bound each read. Start at the closest relevant heading
and stop at the next heading of the same or higher level. Load another section
only when the first section explicitly depends on it.

Example searches:

```bash
rg -n "shebang|script recipe|shell" references/docs/README.md
rg -n "parameter|argument|dependency" references/docs/README.md
rg -n "windows|path|working directory" references/docs/README.md
```

If results are broad, search for the nearest Markdown heading before reading
the matching section. Do not fall back to loading the entire README.

## Working rules

When using this skill:

1. Prefer the bundled README over memory for exact just behavior.
2. Search before reading and never load the entire README into context.
3. Read the relevant README section before making syntax-sensitive claims or
   edits.
4. Keep answers grounded in the official docs and say which section informed
   the result when that helps the user verify it.
5. If the user asks for a justfile change, inspect the existing file first and
   preserve its style, shell assumptions, and line endings.
6. Do not use this `SKILL.md` alone as proof of just syntax or semantics. It is
   only the routing layer for the official README.

## Scope of bundled docs

The bundled reference is a snapshot of the official just README. It contains
broad project documentation in one large file, so consult only the sections
needed for the current task.

Use this skill for how to use just: syntax, recipes, settings, command-line
behavior, shell behavior, modules, imports, paths, environment handling,
portability, and comparisons. For topics not covered by the README, recognize
that the bundled snapshot may not contain the answer.

## Further reference

The bundled `references/docs/README.md` is the official just README snapshot for
this skill. It covers the just language, command-line interface, recipes,
settings, shell behavior, platform notes, and project information this skill
intentionally omits from the main body to stay lean.

Do not fetch the homepage or other online documentation for information already
covered by the bundled README.

From Cologler/Skills, MIT.

More from Cologler/Skills