aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhistoria <historiavg@proton.me>2026-08-27 23:39:33 -0400
committerhistoria <historiavg@proton.me>2026-08-27 23:39:33 -0400
commit967b60342af11ada1cd6a27c935dd336523fb1cd (patch)
tree39e8350f337ab8dbf2733d0dec2b8886d1a1088e /README.md
parenteb465fb2a972b6b07c4b427f940b186745ce6d90 (diff)
downloadtts-audiobook-generator-967b60342af11ada1cd6a27c935dd336523fb1cd.tar.gz
remove: unnecessary tui text
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4d07639..4b61c06 100644
--- a/README.md
+++ b/README.md
@@ -57,6 +57,24 @@ python audiobook.py
Everything the TUI does can also be scripted with flags: `python audiobook.py --backend audiocpp --model higgs --voice narrator`. To convert a single book file instead of the whole input directory, pass `--input-file` (and optionally `--output-file`): `python audiobook.py --input-file books/dune.epub --output-file out/dune.mp3`. The directory flags (`--input`/`--output`) and the single-book flags (`--input-file`/`--output-file`) are mutually exclusive pairs — mixing one stops with an error explaining both.
+Note: unlike the TUI, the CLI does **not** start or stop backend servers — point it at a server that is already running. You can manually launch servers in the TUI too.
+
+```bash
+python audiobook.py --backend audiocpp --model qwen3_tts_1_7b_base_q8_0 --voice narrator
+
+python audiobook.py --backend audiocpp --model qwen3_tts_1_7b_customvoice_q8_0 --voice Vivian
+
+python audiobook.py --backend audiocpp --model Qwen3-TTS-12Hz-1.7B-VoiceDesign-GGUF \
+ --instructions "A warm adult female narrator with a British accent"
+
+python audiobook.py --backend faster --voice narrator
+
+python audiobook.py --backend audiocpp --api-url http://10.20.30.40:8080 --voice narrator
+
+python audiobook.py --input-file the_odyssey.epub --output-file the_odyssey.mp3 \
+ --format mp3 --single-file
+```
+
## Options
| Flag | Example | Description |