Usage
Quickstart
Install scut and wire a supported agent in a few commands.
Scut is a CLI companion for LLM agents. It installs hook commands, formats files after agent edits, renders a Claude Code status line, and diagnoses whether local agent configuration is ready.
Install the CLI
Use the release installer for the current platform:
curl -fsSL https://install-scut.ajbeck.dev | sh
By default the installer places scut in ~/.local/bin. Make sure that directory is on PATH before wiring hooks.
Configure agents
Preview the planned config changes, then apply them:
scut init --all --dry-run
scut init --all
The dry run shows which agent configuration files would be changed. The real run writes scut-owned entries into .claude/settings.json and .codex/hooks.json when those agents are selected: the post-tool-use formatter hook for both agents, plus the status line for Claude Code. Other hook events are opt-in via scut claude config install --only=....
Check the setup
Check the resulting setup in human-readable output, or emit JSON for automation:
scut doctor
scut doctor --json
Doctor checks PATH visibility, missing hook entries, parse errors, Codex inline hook conflicts, disabled Codex hooks, and project trust reminders.
Use the formatter hook
The most visible behavior is the PostToolUse formatter. After Claude Code writes or edits a Go, Markdown, or MDX file, scut formats that file in place and returns an empty JSON response to the agent.
Supported formatter behavior:
| File type | Formatter | Notes |
|---|---|---|
.go | Go formatter via go/format | Syntax errors are left unchanged. |
.md, .mdx | goldmark-prettier-markdown | Preserves prose wrapping style. |
| other | none | The file is passed through unchanged. |