CLI Reference
The audawispr CLI provides subcommands for each pipeline stage and a
one-shot command that runs them all in sequence.
Global Options
--version— Show version and exit.--verbose— Print phase names to stderr.
doctor
Report local runtime readiness.
audawispr doctor
Checks package version, Python version, and FFmpeg/FFprobe availability.
--json flag
Output machine-readable JSON including platform key, cache directory, FFmpeg cache directory, tool status, and Whisper model cache status.
audawispr doctor --json
install-ffmpeg
Install audawispr-managed FFmpeg and FFprobe binaries via static-ffmpeg to the shared audawispr cache (~/Library/Caches/audawispr on macOS).
audawispr install-ffmpeg
Options:
| Option | Default | Description |
|---|---|---|
--force |
disabled | Re-download even if already installed |
--prefer-system/--no-prefer-system |
prefer | Skip install if system FFmpeg is available |
--json |
disabled | Output machine-readable JSON |
On first run, downloads FFmpeg ~8.x binaries, copies them to the audawispr cache, and records version metadata. Subsequent runs skip the download.
install-models
Pre-download Whisper model(s) from HuggingFace Hub for offline use.
audawispr install-models --model-size small
Options:
| Option | Default | Description |
|---|---|---|
--model-size |
small |
Model size to download |
--all |
disabled | Download all known model sizes (prompts before starting) |
--force |
disabled | Re-download even if already cached |
--list-models |
disabled | List available model sizes and exit |
--json |
disabled | Output machine-readable JSON |
Uses huggingface_hub.snapshot_download() directly for real progress bars.
validate
Validate a transcript manifest schema and timestamps.
audawispr validate <manifest.json>
transcribe
Transcribe audio locally into a transcript manifest.
audawispr transcribe <audio> --output out/transcript.json [options]
Options:
| Option | Default | Description |
|---|---|---|
--language, -l |
fr |
Source language code |
--model-size |
small |
faster-whisper model size or path |
--device |
auto |
Device (auto, cpu, cuda) |
--compute-type |
int8 |
Compute type (int8, float16, float32) |
--vad/--no-vad |
enabled | Voice activity detection filtering |
segment
Segment a transcript manifest into sentence-like learning units.
audawispr segment out/transcript.json --output out/segments.json [options]
Options:
| Option | Default | Description |
|---|---|---|
--pause-split-ms |
700 |
Pause threshold for splitting (ms) |
--min-duration-ms |
600 |
Minimum segment duration (ms) |
--max-duration-ms |
7000 |
Maximum segment duration (ms) |
--merge-short/--no-merge-short |
enabled | Merge segments shorter than minimum |
--inspection-tsv |
auto | Inspection TSV output path |
enrich
Add optional IPA and translation fields to a segmented manifest.
audawispr enrich out/segments.json --ipa --output out/enriched.json [options]
Options:
| Option | Default | Description |
|---|---|---|
--ipa/--no-ipa |
disabled | Generate IPA phonetic transcription (French only) |
--translate |
none |
Translation provider |
clip
Clip audio snippets from a segmented or enriched manifest.
audawispr clip out/enriched.json --output out/clipped.json --output-dir out/media [options]
Options:
| Option | Default | Description |
|---|---|---|
--padding-before-ms |
150 |
Padding before each segment (ms) |
--padding-after-ms |
250 |
Padding after each segment (ms) |
--format |
mp3 |
Output audio format |
--bitrate |
128k |
Output audio bitrate |
--force |
disabled | Re-clip even if snippet exists |
export
Export a clipped manifest to Anki-compatible format.
audawispr export out/clipped.json --output out/anki-csv [options]
Options:
| Option | Default | Description |
|---|---|---|
--format |
anki-csv |
Export format (anki-csv or apkg) |
--deck-name |
auto | Deck name for APKG export |
For APKG export, the output path must end in .apkg:
audawispr export out/clipped.json --output deck.apkg --deck-name "My French Deck"
One-shot
Run the full pipeline in one command. Unknown positional arguments are automatically routed to this command.
audawispr <audio> --output <deck.apkg> [options]
Accepts all options from the individual subcommands. The pipeline runs transcription, segmentation, enrichment, clipping, and export in sequence.
Options:
| Option | Default | Description |
|---|---|---|
--keep-work |
disabled | Preserve the working directory after completion |
The working directory is cleaned up automatically on success. Use --keep-work
to inspect intermediate files.