codeforerunner

codeForerunner

Model-agnostic repository documentation tooling. Ships a prompt pack for codebase analysis and doc generation, a thin Python CLI, an MCP server, drift-detection rules that keep docs honest — and native slash-command skills for Claude Code, Codex, Gemini CLI, and other agent CLIs.

Install

Install forerunner's prompt pack as skills into your agent CLI. Each documentation task becomes a slash command (/forerunner-readme, /forerunner-check, etc.) available inside Claude Code, Codex, Gemini CLI, and other agents. Authentication is handled by your existing agent subscription — no separate API key needed.

# From a cloned repo
./install.sh

# One-liner (auto-detects Claude Code, Codex, Gemini CLI)
curl -fsSL https://raw.githubusercontent.com/derek-palmer/codeforerunner/main/install.sh | bash

# npm
npx -y codeforerunner
npm install -g codeforerunner

# Windows
irm https://raw.githubusercontent.com/derek-palmer/codeforerunner/main/install.ps1 | iex

# Via Python CLI
pip install codeforerunner
forerunner install --all claude
forerunner install --all codex

Then in your agent:

/forerunner-scan        ← scan the repo first
/forerunner-readme      ← generate README
/forerunner-check       ← detect doc drift
/forerunner-refresh     ← scan + update all stale docs

Slash commands

Command	Task	Purpose
/forerunner-scan	scan	Collect repo evidence (run first)
/forerunner-readme	readme	Generate or refresh README.md
/forerunner-api-docs	api-docs	Generate API reference docs
/forerunner-diagrams	diagrams	Generate Mermaid architecture diagrams
/forerunner-flows	flows	Document system flows
/forerunner-arch-review	arch-review	Rank architecture improvement candidates, inspired by Matt Pocock's /improve-codebase-architecture
/forerunner-stack-docs	stack-docs	Stack-specific developer docs
/forerunner-version-audit	version-audit	Audit pinned versions vs EOL
/forerunner-check	check	Check docs for staleness
/forerunner-review	review	Doc-impact summary for PR review
/forerunner-audit	audit	Security and dependency audit
/forerunner-changelog	changelog	Generate changelog from git log
/forerunner-init	init-agent-onboarding	Bootstrap or refresh AGENTS.md
/forerunner-refresh	refresh	Scan + check + update all stale docs in one pass

Slash command availability depends on the agent CLI. Claude Code, Codex, and Gemini CLI support all commands after install.

Skill install options

Flag	Effect
./install.sh	Auto-detect agents, prompt for global vs local, prompt which agents to install
./install.sh --global	Skip location prompt, install to global agent dirs (all projects)
./install.sh --local	Skip location prompt, install to .claude/skills/ and .agents/skills/ in cwd
./install.sh --non-interactive	Skip all prompts, install globally to all detected agents (useful in CI / curl|bash)
./install.sh --only claude	Claude Code only (skips agent selection prompt)
./install.sh --only codex	Codex only
./install.sh --only gemini	Gemini CLI only
./install.sh --dry-run	Preview, write nothing
./install.sh --list	Show detected agents + skill list
./install.sh --uninstall	Remove all installed skills

CLI

pip install codeforerunner

Command	Purpose
forerunner init	Resolve agent-onboarding bundle to stdout.
forerunner scan	Resolve scan bundle to stdout.
forerunner doc <task>	Resolve base + partials + task bundle to stdout.
forerunner refresh	Output scan + check + all doc-task bundles in sequence for a full doc refresh.
forerunner check	Run drift-detection rules; no-op without forerunner.config.yaml.
forerunner doctor	Health report: skill parity, config. Add --fix to write a starter config.
forerunner mcp-server	Serve prompt bundles as MCP tools over stdio (JSON-RPC 2.0).
forerunner install <agent>	Install canonical skill into agent-specific directory. Add --all for all per-task skills.

Quick start

# Install skills into Claude Code
curl -fsSL https://raw.githubusercontent.com/derek-palmer/codeforerunner/main/install.sh | bash

# Or via npm
# npx -y codeforerunner