ferraus plugin info
Show a plugin's parameters, presets, ports, latency, and MIDI support
Synopsis
ferraus plugin info <name> [options]
What it does
Loads the plugin in a host process (never opening its GUI) and reports every parameter with its stable id, name, range, default, and unit, the presets it exposes, its audio and note ports, the latency it reports at 48 kHz, and whether it accepts MIDI.
Examples
Parameters and presets of Surge XT
ferraus plugin info "Surge XT"
One plugin from a bundle, as JSON
ferraus plugin info ./MyPlugin.clap#com.acme.reverb --json
Parameter names, ranges, and the reported tail of an installed reverb
ferraus plugin info dragonfly-reverb --json
Options
| Flag | Type | Default | Meaning |
|---|---|---|---|
<name> | text | — | Plugin name, id, or path to a .clap/.vst3 bundle (path#plugin.id picks one plugin in a bundle) Required. |
--watchdog | time | — | Stop the plugin host after this long without progress (default 60s, or FERRAUS_PLUGIN_WATCHDOG_S) |
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 |
| 7 | Plugin crashed, timed out, or was not found |
| 8 | Cancelled |
| 70 | Internal error (bug) |
Common mistakes
- Beat-based times (
4b,1/4) need a tempo: pass--bpmor write4b@120.
For models
- MCP tool:
ferraus_plugin_info - Schema:
ferraus schema plugin info - Pipeline:
{ op: plugin info, args: { ... } }(flag names with_instead of-) - fx stage: no
{"command": "plugin info", "defaults": {}}