ferraus plugin state load
Load a saved state into a plugin and show the resulting parameters
Synopsis
ferraus plugin state load <name> [options]
What it does
Checks that a state file loads into the plugin and reports every parameter value afterwards. Useful to inspect a state before rendering with it.
Examples
Show the parameters stored in a state file
ferraus plugin state load "Surge XT" --state pad.state.json
Read the plugin state recorded in a sidecar
ferraus plugin state load Dexed --state song.wav.ferraus.json --json
Check a reverb state file, stopping the host if it hangs for 30 s
ferraus plugin state load dragonfly-reverb --state room.state.json --watchdog 30s
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. |
--state | path | — | State file from 'plugin state save' (or a sidecar with a plugin stage) 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_state_load - Schema:
ferraus schema plugin state load - Pipeline:
{ op: plugin state load, args: { ... } }(flag names with_instead of-) - fx stage: no
{"command": "plugin state load", "defaults": {}}