vocal_helper.cli_argparse module

Vocal Helper — argparse-based command-line interface.

Thin wrapper around the async vocal_helper.Pipeline / vocal_helper.OfflinePipeline orchestrators that exposes the toolkit as subcommands under a single vocal-helper entry point. Written with argparse from the standard library so the CLI works out of the box on any Python install that has the package installed — no extra dependency required.

Subcommands

mic — live microphone input (needs [mic] extra)
file — replay a mono 16 kHz WAV through the pipeline
url — stream from any URL yt-dlp can reach ([stream] extra)
transcribe — one-shot transcription of a WAV / numpy buffer

Every subcommand accepts a common core of --whisper-model / --language / --diar-backend / --llm / --jsonl levers. See vocal-helper <subcommand> --help for the full surface.

Usage Example

>>> #   vocal-helper mic --llm --jsonl
>>> #   vocal-helper file meeting.wav --offline --language en
>>> #   vocal-helper url "https://youtu.be/…" --language fr
>>> #   vocal-helper transcribe clip.wav --language en

Author

Warith Harchaoui, Ph.D. — https://linkedin.com/in/warith-harchaoui/

vocal_helper.cli_argparse.build_parser()[source]

Assemble the top-level vocal-helper argument parser.

Returns:: Fully wired parser with every subcommand attached.
Return type:: argparse.ArgumentParser

vocal_helper.cli_argparse.main(argv=None)[source]

Entry point invoked by vocal-helper (see [project.scripts]).

Parameters:: argv (sequence of str, optional) – Arguments to parse. Defaults to sys.argv[1:] when None.
Returns:: Process exit code (0 on success).
Return type:: int