ferraus doctor

Report what is installed: version, paths, FFmpeg, models, devices, plugins

Synopsis

ferraus doctor [options]

What it does

Report what is installed: version, paths, FFmpeg, models, devices, plugins

Examples

Check the installation

ferraus doctor

Install the managed FFmpeg for the bridge

ferraus doctor --install-ffmpeg -y

The same report as JSON: version, paths, FFmpeg, models, devices, plugins

ferraus doctor --json

Download the optional Audiveris OMR engine for score read

ferraus doctor --install-audiveris -y

Options

FlagTypeDefaultMeaning
--install-ffmpegflag—Download a pinned, checksummed static FFmpeg build into the ferraus cache
--install-audiverisflag—Download the Audiveris OMR engine (Java, AGPL) for 'score read --engine audiveris'

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
8Cancelled
10Network error
70Internal error (bug)

Common mistakes

  • Expecting human-readable text when scripting: add --json for a stable machine result.

For models

  • MCP tool: ferraus_doctor
  • Schema: ferraus schema doctor
  • Pipeline: { op: doctor, args: { ... } } (flag names with _ instead of -)
  • fx stage: no
{"command": "doctor", "defaults": {}}