ferraus docs
Full reference page for a command, offline
Synopsis
ferraus docs <command> [options]
What it does
Prints the same page as the docs site: synopsis, what it does, examples, every option with its type and default, presets, exit codes, common mistakes, and the machine-oriented block. 'ferraus docs errors' prints the error catalog and 'ferraus docs troubleshooting' the troubleshooting guide.
Examples
Read the separate reference offline
ferraus docs separate
Every exit code with its cause and fix
ferraus docs errors
Quote a multi-word command
ferraus docs "midi quantize"
The troubleshooting guide, offline
ferraus docs troubleshooting
Options
| Flag | Type | Default | Meaning |
|---|---|---|---|
<command> | text | — | Command name (e.g. separate, 'midi quantize'), 'errors', or 'troubleshooting' |
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_docs - Schema:
ferraus schema docs - Pipeline:
{ op: docs, args: { ... } }(flag names with_instead of-) - fx stage: no
{"command": "docs", "defaults": {}}