ferraus sounds scan

Index a folder of sounds

Synopsis

ferraus sounds scan <dir> [options]

What it does

Indexes a folder once (plugins are probed in a host subprocess) and caches the result in <cache>/sounds/index/. With --watch, keeps running and re-indexes whenever files in the folder change (polling every --interval).

Examples

Index a sample folder

ferraus sounds scan ~/Samples

Re-index whenever the folder changes

ferraus sounds scan ~/Samples --watch --interval 5s

Index an external drive of SFZ libraries and report what was found

ferraus sounds scan /Volumes/Libraries/SFZ --json

Options

FlagTypeDefaultMeaning
<dir>path—Folder to index Required.
--watchflag—Keep watching and re-index on changes until interrupted
--intervaltime2sPolling interval for --watch
--watch-cyclesinteger—Stop --watch after this many polls (for scripts and tests)

Global options

Every command also accepts the global options (-o, --json, --dry-run, --overwrite, --progress, ...). See Global options.

Exit codes

CodeMeaning
0Success
1Processing failed
2Usage or parameter error
3Input missing or unreadable
7Plugin crashed, timed out, or was not found
8Cancelled
10Network error
70Internal error (bug)

Common mistakes

  • Beat-based times (4b, 1/4) need a tempo: pass --bpm or write 4b@120.

For models

  • MCP tool: ferraus_sounds_scan
  • Schema: ferraus schema sounds scan
  • Pipeline: { op: sounds scan, args: { ... } } (flag names with _ instead of -)
  • fx stage: no
{"command": "sounds scan", "defaults": {"interval": "2s"}}