ferraus sounds install
Download, verify, and install a sound
Synopsis
ferraus sounds install <id> [options]
What it does
Downloads a registry entry (resuming partial downloads), verifies its SHA-256, refuses any mismatch, unpacks zip and tar archives, and places plugins in the per-user plugin folder and SoundFonts, SFZ libraries, and impulse responses in <data>/ferraus/sounds/, then rescans. The license is printed first. Downloads need --yes (or auto-download enabled in the config); --offline forbids them. Entries without a pinned hash are refused unless FERRAUS_ALLOW_UNVERIFIED=1. With --from, registers a bundle you downloaded yourself (for free-but-proprietary instruments whose vendors require their own installer); ferraus never runs installers or asks for administrator rights.
Examples
Download and install the default General MIDI SoundFont
ferraus sounds install gm-basic -y
Register a plugin downloaded from its vendor
ferraus sounds install vital --from ~/Downloads/VitalInstaller.zip
Install a SoundFont you already have under your own name
ferraus sounds install --from ~/Downloads/MyStrings.sf2 --name my-strings
Options
| Flag | Type | Default | Meaning |
|---|---|---|---|
<id> | text | — | Registry id (optional with --from, where it names the entry the file belongs to) |
--from | path | — | Install a file or folder you downloaded yourself: a .clap/.vst3 bundle, .sf2, .sfz library folder, IR folder, or a zip/tar archive of those |
--name | text | — | Name for a --from install (default: the file name) |
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 |
| 10 | Network error |
| 70 | Internal error (bug) |
Common mistakes
- Expecting human-readable text when scripting: add
--jsonfor a stable machine result.
For models
- MCP tool:
ferraus_sounds_install - Schema:
ferraus schema sounds install - Pipeline:
{ op: sounds install, args: { ... } }(flag names with_instead of-) - fx stage: no
{"command": "sounds install", "defaults": {}}