Skip to content
GhostbranchdocsGitHub

Help commands

Commands that explain Ghostbranch and its codes, for people and agents.

The agent guide, and what each error, warning and exit code means. Each card shows the command’s own help: ghostbranch <command> --help prints the same. Every command also takes the global flags.

guideread-only
Print the guide for coding agents, or install a skill that points agents at it
Usage
ghostbranch guide [flags]
Description

guide prints how coding agents should use Ghostbranch: the loop, the rules, and every exit and error code. It always matches this binary. --install claude|codex writes a small user-level skill (never a file in your repo) that tells the agent to read this guide; --uninstall removes it.

Flags
FlagValueDefaultDescription
--install<string>—write a user-level skill for an agent: claude or codex
--plan——show what would be written, and write nothing
--uninstall<string>—remove the skill for an agent: claude or codex

More in How agents use Ghostbranch.

explainread-only
Explain an error, warning or exit code, and what to do about it
Usage
ghostbranch explain <CODE | exit number> [flags]
Description

explain prints what a code means, its usual causes, what to do, and whether a person must act. It needs no token and no network. --all lists every code.

Flags
FlagValueDefaultDescription
--all——list every exit, error and warning code

More in JSON output and next.