Capabilities

configorama capabilities prints a stable, machine-readable description of the CLI surface. Agents and CI jobs read the contract from the tool instead of scraping help text or documentation.


configorama capabilities


{
  "name": "configorama",
  "version": "0.11.2",
  "schemaVersion": 1,
  "commands": [
    { "name": "inspect", "usage": "configorama inspect <file> [--view requirements|audit|graph]", "summary": "..." }
  ],
  "aliases": [
    { "name": "audit", "mapsTo": "inspect --view audit", "summary": "..." }
  ],
  "views": ["requirements", "audit", "graph"],
  "formats": {
    "resolve": ["json", "yaml", "js", "esm"],
    "graph": ["json", "mermaid", "dot"]
  },
  "errorCodes": [
    { "code": "missing_env", "description": "..." }
  ],
  "exitCodes": [
    { "code": 0, "meaning": "Success." },
    { "code": 1, "meaning": "Error. The category is in the JSON `error.code` field." }
  ],
  "flags": [
    { "flag": "--view <view>", "summary": "..." }
  ]
}

Field	Purpose
`name`, `version`, `schemaVersion`	Identify the tool and the contract version.
`commands`	The documented commands with usage strings and summaries.
`aliases`	Hidden back-compat verbs (`requirements`, `audit`, `graph`) that map to an `inspect --view`. They still run if typed.
`views`	Valid `inspect --view` values.
`formats`	Output formats per mode (`resolve`, `graph`).
`errorCodes`	The full error-code registry.
`exitCodes`	`0` success, `1` error (category in the JSON `error.code` field).
`flags`	Global flags with summaries.


# Discover the error categories an agent should branch on
configorama capabilities | jq -r '.errorCodes[].code'

See the CLI reference for the commands and error codes for the failure contract.