CLI Reference
Synopsis
audify [OPTIONS] [PATH]
audify list-tasks
audify validate-prompt PROMPT_FILE
audify [OPTIONS] [PATH]
Main conversion command. When PATH is omitted, prints help. When PATH is a
directory, processes all supported files inside it.
Arguments
Argument |
Description |
|---|---|
|
Path to an EPUB, PDF, or directory |
Conversion options
Option |
Short |
Description |
Default |
|---|---|---|---|
|
|
Task name: |
|
|
|
Path to a custom prompt file (overrides |
|
|
|
TTS provider: |
|
|
|
Voice name or ID for the selected TTS provider |
|
|
|
TTS model name or path |
|
|
|
Language code for synthesized audio |
|
|
|
Translate text to this language before synthesis |
|
|
|
LLM model name. Prefix with |
|
|
Base URL for local Ollama API |
|
|
|
|
Maximum chapters to process (EPUB only) |
|
|
|
Output directory |
|
|
|
Save extracted or generated text to a file |
|
|
|
Skip confirmation prompts |
|
|
Only extract text and generate scripts (no TTS). Use |
||
|
Skip extraction/script generation; synthesise audio from previously saved scripts (requires a prior |
||
|
Show detailed log output |
Info / listing options
Option |
Short |
Description |
Default |
|---|---|---|---|
|
|
Print all supported language codes |
|
|
|
List TTS models available from Kokoro API |
|
|
|
List voices available from the selected TTS provider |
|
|
|
Show all TTS providers and their configuration status |
|
|
|
Generate an M4B sample file with all available voices |
|
|
|
Maximum number of voice samples to create |
|
|
|
Print version and exit |
|
|
Show help and exit |
Examples
# Direct TTS (no LLM)
audify book.epub --task direct
# LLM-enhanced audiobook (default task)
audify book.epub
# Podcast-style audio using OpenAI TTS
audify book.epub --task podcast --tts-provider openai
# Use a cloud LLM with local Kokoro TTS
audify book.epub --llm-model api:openai/gpt-4o
# Use a custom prompt
audify book.epub --prompt-file my-prompt.txt
# Process all EPUBs in a directory
audify ./my-books/ --task audiobook --tts-provider kokoro
# Two-stage workflow: generate scripts first, synthesise later
audify book.epub --process-only
audify book.epub --synthesize-only
# List all voices for Kokoro
audify --list-voices --tts-provider kokoro
# Translate to Spanish
audify book.epub --translate es
audify list-tasks
Print all registered transformation tasks with their description and whether they require an LLM.
audify list-tasks
audify validate-prompt
Validate a custom prompt file before use.
audify validate-prompt my-prompt.txt
Arguments
Argument |
Description |
|---|---|
|
Path to the prompt file to check |