rungrad documentation

rungrad is a Go framework, CLI tool, and spec for command-line tools used in a terminal, scripts, and CI. Start with Getting started to generate a starter CLI and score it. Use Building a CLI with rungrad when replacing the starter commands with your own code.

• Getting startedInstall, scaffold a CLI, score a CLI
• Building a CLI with rungradThe framework guide for tool authors
• Migrating from CobraPort an existing Cobra CLI without changing its public surface
• Config and auth referenceProfiles, auth files, services, and credential hooks
• Conformance and the specThe agent-ready spec and the scorer
• Machine manifestThe hidden manifest protocol
• CLI referenceThe rungrad command: score and new

The specification

The written spec lives in spec/. It stands on its own: any CLI in any language can follow it and be scored against it. The spec version is rungrad-spec/1.

• Output contract: text for people, stable JSON for programs
• Exit-code model: stable codes that classify the outcome
• Dry run: preview a change before it happens
• Determinism: identical runs produce identical output
• Name resolution: names instead of opaque IDs
• Self-describing help: help with examples and related commands
• Self-update: check for a newer version without changing anything
• Auth and config: credential and config hygiene