CLI Reference
koffee COMMAND [OPTIONS] [ARGS...]
Automatic video translation and subtitling tool.
Table of Contents
Arguments:
FILE_PATH: Path to the video, audio, or subtitle file
Commands:
info: Display system information for debugging.languages: List all supported language codes.tracks: List embedded subtitle tracks in a video file.transcribe: Transcribe audio to subtitles without translation.convert: Convert a subtitle file between formats (SRT, VTT, ASS).embed: Embed subtitles into a video without transcription or translation.
Parameters:
--compute-type, -c: Type to use for computation [default: default]--device, -d: Device to use for computation [default: auto]--whisper-model, -m: The Whisper model instance to use [default: large-v3]--output-dir, -o: Directory for the output file--output-name, -n: Name of the output file--source-language, -s: Source language of the subtitle file (default: auto) [default: auto]--target-language, -t: Language to which the file should be translated [default: en]--subtitle-format, -f: Format to use for the subtitles [default: vtt]--embed: Subtitle embed mode: none (subtitle file only), soft (muxed track), or hard (burned into video frames). Only valid for video file inputs. [default: none]--provider: The backend service to use for the translation [default: whisper]--llm-model: The LLM model to use for translation--chunk-size:--context-size:--sleep-requests:--prompt: Custom system prompt for the LLM translation model--api-key: API key for an LLM service
Options:
--config: Path to a koffee.toml configuration file--vad-filter, --no-vad-filter: Voice activity detection filtering during transcription (enabled by default; pass--no-vad-filterto disable) [default: True]--dry-run: Preview what would be done without running transcription or translation [default: False]--overwrite: Overwrite existing output files instead of raising an error [default: False]--verbose, -v: Print debug log messages [default: False]--help, -h: Display this message and exit.--version, -V: Display application version.
koffee convert
koffee convert FILE-PATH [ARGS]
Convert a subtitle file between formats (SRT, VTT, ASS).
Parameters:
FILE-PATH, --file-path: Path to the subtitle file [required]--format, -f: Target subtitle format (srt, vtt, or ass) [default: vtt]--output-dir, -o: Directory for the output file--output-name, -n: Name of the output file
Options:
OVERWRITE, --overwrite: Overwrite existing output files instead of raising an error [default: False]
koffee embed
koffee embed VIDEO-PATH SUBTITLE-PATH [ARGS]
Embed subtitles into a video without transcription or translation.
Parameters:
VIDEO-PATH, --video-path: Path to the video file [required]SUBTITLE-PATH, --subtitle-path: Path to the subtitle file [required]--output, -o: Path for the output video file--mode, -m: Embed mode: soft (muxed track) or hard (burned into video frames) [default: soft]
Options:
OVERWRITE, --overwrite: Overwrite existing output files instead of raising an error [default: False]
koffee info
koffee info
Display system information for debugging.
koffee languages
koffee languages
List all supported language codes.
koffee tracks
koffee tracks FILE-PATH
List embedded subtitle tracks in a video file.
Parameters:
FILE-PATH, --file-path: [required]
koffee transcribe
koffee transcribe FILE-PATH [ARGS]
Transcribe audio to subtitles without translation.
Parameters:
FILE-PATH, --file-path: Path to the video or audio file [required]--compute-type, -c: Type to use for computation [default: default]--device, -d: Device to use for computation [default: auto]--whisper-model, -m: The Whisper model instance to use [default: large-v3]--output-dir, -o: Directory for the output file--output-name, -n: Name of the output file--subtitle-format, -f: Format to use for the subtitles [default: vtt]
Options:
VAD-FILTER, --vad-filter, --no-vad-filter: Voice activity detection filtering during transcription (enabled by default; pass--no-vad-filterto disable) [default: True]OVERWRITE, --overwrite: Overwrite existing output files instead of raising an error [default: False]