CLI help snapshot¶

Aurum is private speech I/O on your machine:
• STT — audio → text (whisper.cpp local by default; optional OpenRouter)
• cleanup — post-transcript flow styles
• TTS — text → mono WAV (local ONNX; no cloud)
• batch — resumable multi-file transcription

Quick start:
 aurum meeting.m4a
 aurum meeting.m4a --cleanup clean
 aurum tts "Hello from aurum" --output-file /tmp/a.wav
 aurum cleanup --style bullets < notes.txt
 aurum batch ./lectures -O ./out
 aurum models
 aurum models recommend --profile balance
 aurum tts voices
 aurum support-bundle
 aurum --help

Usage: aurum [OPTIONS] [AUDIO_FILE]
       aurum <COMMAND>

Commands:
  models          List local whisper models and cache status [alias: list-models]
  transcribe      Transcribe an audio file (default when AUDIO_FILE is given positionally) [alias: t]
  cleanup         Clean existing text (stdin or file) without re-transcribing [alias: flow]
  tts             Synthesize speech from text (local ONNX TTS → mono WAV)
  batch           Bounded resumable multi-file transcription (JOE-1726)
  cache           Inspect and verify local model/voice-pack cache (JOE-1592)
  doctor          Read-only system, config, cache, and capability diagnostics (JOE-1628)
  support-bundle  Privacy-safe support bundle for issue reports (JOE-1728)
  completions     Generate shell completions (bash/zsh/fish/powershell/elvish)
  man             Print a man page to stdout (JOE-1720)
  help            Print this message or the help of the given subcommand(s)

Arguments:
  [AUDIO_FILE]
          Audio file to transcribe

Options:
      --provider <local|openrouter>
          Transcription provider

          [possible values: local, openrouter]

      --model <NAME>
          Local model name (tiny-q5_1, base, …) or OpenRouter model id. Overrides --profile when both are set

      --profile <PROFILE>
          Intent profile: speed | balance | quality (JOE-1723). Ignored if --model is set

      --language <CODE>
          Language code (e.g. en, fr) or "auto"

  -o, --output <txt|srt|json>
          Output format

          [possible values: txt, srt, json]

      --output-file <PATH>
          Write output to this path instead of stdout

      --timestamps
          Include timestamps where available (implied by srt)

      --allow-unreliable-timestamps
          Allow SRT/timestamp output from OpenRouter despite unreliable timings

      --openrouter-stt-mode <auto|chat|transcriptions>
          OpenRouter STT path: auto | chat | transcriptions (JOE-1586)

      --cleanup <raw|clean|bullets|professional|summary>
          Post-transcript cleanup style (default: raw = off)

      --cleanup-provider <rules|openrouter>
          Cleanup backend: on-device rules (default) or OpenRouter LLM

      --cleanup-model <MODEL>
          Model id when using --cleanup-provider openrouter

      --cleanup-segments <auto|keep|clear|per-segment>
          Segment policy after cleanup: auto | keep | clear | per-segment

  -v, --verbose
          Verbose diagnostics

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

List local whisper models and cache status

Usage: aurum models [COMMAND]

Commands:
  recommend  Explain an intent profile and the model it resolves to (JOE-1723)
  help       Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

Bounded resumable multi-file transcription (JOE-1726)

Usage: aurum batch [OPTIONS] --output-dir <DIR> <INPUT>

Arguments:
  <INPUT>  Audio file or directory of audio files

Options:
  -O, --output-dir <DIR>
          Directory for transcripts and the batch manifest
      --recursive
          Recurse into subdirectories when INPUT is a directory
      --resume
          Resume from an existing `aurum-batch-manifest.json` in --output-dir
      --retry-failed
          Retry items marked failed when resuming
      --dry-run
          Dry-run: write/update the manifest only (no transcription)
      --provider <local|openrouter>
          Transcription provider [possible values: local, openrouter]
      --model <NAME>
          Explicit model id (overrides --profile)
      --profile <PROFILE>
          Intent profile: speed | balance | quality (ignored when --model is set)
      --language <CODE>
          Language code or auto
  -o, --output <txt|srt|json>
          Output format for each item [possible values: txt, srt, json]
      --timestamps
          Include timestamps (implied by srt)
      --allow-unreliable-timestamps

      --openrouter-stt-mode <auto|chat|transcriptions>

      --cleanup <raw|clean|bullets|professional|summary>

      --cleanup-provider <rules|openrouter>

      --cleanup-model <MODEL>

      --cleanup-segments <auto|keep|clear|per-segment>

      --json
          Emit final summary as JSON on stdout
  -v, --verbose

  -h, --help
          Print help

Read-only system, config, cache, and capability diagnostics (JOE-1628)

Usage: aurum doctor [OPTIONS]

Options:
      --json  Emit JSON report
  -h, --help  Print help

Inspect and verify local model/voice-pack cache (JOE-1592)

Usage: aurum cache [OPTIONS] <COMMAND>

Commands:
  status  Cheap size/existence inventory (no full hashing)
  verify  Full digest verification for STT pins; quarantines bad artifacts (no network)
  repair  Re-download a model through the verified path (requires network unless --local-only)
  help    Print this message or the help of the given subcommand(s)

Options:
      --json  Emit JSON instead of a table
  -h, --help  Print help

Synthesize speech from text (local ONNX TTS → mono WAV)

Usage: aurum tts [OPTIONS] [TEXT]
       aurum tts <COMMAND>

Commands:
  models    List local TTS models and cache status
  voices    List local TTS voices and cache status
  adapters  List supported TTS adapters (not bare ONNX loaders)
  inspect   Read-only inspect of a model pack or manifest (no network)
  verify    Full digest + adapter + conformance preflight for a pack
  add       Propose adding a local pack (dry-run by default; never auto-trusts HF)
  help      Print this message or the help of the given subcommand(s)

Arguments:
  [TEXT]  Text to speak. Use `-` to read UTF-8 from stdin

Options:
      --input-file <PATH>     Read UTF-8 text from this file instead of positional TEXT
      --provider <local>      TTS provider (only `local` in MVP) [possible values: local]
      --model <NAME>          TTS model id (default from config / kitten-nano-int8)
      --voice <NAME>          Voice id (default from config / Luna)
      --language <CODE>       Language code (default: en)
  -o, --output <wav>          Output container (only `wav` in MVP) [possible values: wav]
  -O, --output-file <PATH>    Write WAV to this path (required for synthesis)
      --force                 Overwrite an existing non-empty output file
      --speaking-rate <RATE>  Speaking rate multiplier (clamped 0.5..=2.0)
      --cleanup <raw|clean>   Optional rules-only cleanup style before synth (`clean` min)
      --timeout <MS>          Wall-clock timeout in milliseconds
      --emit-json             Print honesty JSON metadata on stdout (audio only in file)
      --local-only            Fail if the voice pack is not already cached (no download)
      --pack-dir <DIR>        Local model-pack directory (manifest + artifacts). Not a bare .onnx path
      --allow-unverified      Allow trust=local_unverified for `--pack-dir` (unsupported for production)
  -v, --verbose               Verbose diagnostics
  -h, --help                  Print help

Clean existing text (stdin or file) without re-transcribing

Usage: aurum cleanup [OPTIONS] [TEXT_FILE]

Arguments:
  [TEXT_FILE]  Optional text file (default: read stdin)

Options:
  -s, --style <raw|clean|bullets|professional|summary>
          Cleanup style (default: clean for this subcommand, or config)
      --cleanup <STYLE>
          Alias for --style (matches transcribe flag naming)
      --provider <rules|openrouter>
          Cleanup backend: rules (default) or openrouter
      --cleanup-provider <rules|openrouter>
          Alias for --provider
      --model <MODEL>
          Model when provider is openrouter
      --cleanup-model <MODEL>

  -o, --output <txt|json>
          Output format for structured result [possible values: txt, json]
      --output-file <PATH>

  -v, --verbose

  -h, --help
          Print help

Generate shell completions (bash/zsh/fish/powershell/elvish)

Usage: aurum completions <SHELL>

Arguments:
  <SHELL>  Shell: bash | zsh | fish | powershell | elvish

Options:
  -h, --help  Print help

Print a man page to stdout (JOE-1720)

Usage: aurum man

Options:
  -h, --help  Print help

Privacy-safe support bundle for issue reports (JOE-1728)

Usage: aurum support-bundle [OPTIONS]

Options:
  -O, --output-file <PATH>  Output path (default: aurum-support-<unix>.json in cwd)
      --notes <TEXT>        Optional public notes to embed (do not paste secrets or transcripts)
      --stdout              Print JSON to stdout instead of writing a file
  -h, --help                Print help