Documentation
README
CLI Builder — Agent-Friendly Tool Design
Overview
A CLI tool is a contract between your code and the agent that calls it. Every design decision is part of that contract:
| CLI Element | Contract Purpose |
|---|---|
--help output |
Schema — what the tool offers, what flags it accepts |
| Subcommand structure | API surface — the operations the agent can perform |
--json output fields |
Data contract — guaranteed keys and their types |
| Exit codes | Status signals — success, usage error, runtime failure |
| Stderr messages | Error contract — what went wrong and how to fix it |
--dry-run output |
Preview contract — what would happen |
This is the opening of the README. Read the full README on GitHub.