ferraus describe
Compact catalog of every command for agents
Synopsis
ferraus describe [options]
What it does
Compact catalog of every command for agents
Examples
The whole surface in under 4,000 tokens
ferraus describe --agent
The catalog as a Markdown table, e.g. for AGENTS.md
ferraus describe --format markdown
The catalog as JSON for programmatic tool discovery
ferraus describe --format json
Options
| Flag | Type | Default | Meaning |
|---|---|---|---|
--agent | flag | — | One line per command sized to fit in a model's context |
--format | text | markdown | json | text | Output format |
Global options
Every command also accepts the global options (-o, --json, --dry-run, --overwrite, --progress, ...). See Global options.
Exit codes
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | Processing failed |
| 2 | Usage or parameter error |
| 3 | Input missing or unreadable |
| 8 | Cancelled |
| 70 | Internal error (bug) |
Common mistakes
- Expecting human-readable text when scripting: add
--jsonfor a stable machine result.
For models
- MCP tool:
ferraus_describe - Schema:
ferraus schema describe - Pipeline:
{ op: describe, args: { ... } }(flag names with_instead of-) - fx stage: no
{"command": "describe", "defaults": {"format": "text"}}