aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 3ca8f60..b974d14 100644
--- a/README.md
+++ b/README.md
@@ -53,7 +53,7 @@ cd tts-audiobook-generator
## CLI Options
-Note: unlike the TUI, the CLI does **not** start or stop backend servers. You point it at a server that is already running with `--api-url`. You can manually launch local servers in the TUI too.
+Without `--api-url` the CLI manages the server itself, just like the TUI: it starts the selected backend's managed instance (installed via the TUI), converts, and stops it again. A server already running at the configured endpoint is used as-is and left running when the run ends. `--api-url` points at an external server instead, and never touches server state.
```bash
python audiobook.py --backend audiocpp --model qwen3_tts_1_7b_base_q8_0 --voice narrator
@@ -87,7 +87,7 @@ python audiobook.py --input-file the_odyssey.epub --output-file the_odyssey.mp3
| `--single-file` | | Merge all chapters into a single file. `m4b` is always one file. |
| `--language <lang>` | `English` | Output language for the synthesized speech. May add an accent even if the text is English. |
| `--debug` | | Dump each chunk's raw audio and sent text to `debug/` and log every request. Forces the `DEBUG` setting in `app/converter/config.py` on for this run. |
-| `--api-url <url>` | `http://10.20.30.40:8080` | URL of a remote TTS server. Accepts `host:port` or a full `http(s)://` URL. |
+| `--api-url <url>` | `http://10.20.30.40:8080` | URL of an external TTS server. Accepts `host:port` or a full `http(s)://` URL. Without it the CLI starts and stops the backend's managed server itself. |
| `--model <id>` | `qwen3_tts_1_7b_base_q8_0` | `audiocpp`: Choose the TTS model from `server.json` (required on multi-model servers; auto-selected on single-model servers) |
| `--option KEY=VALUE` | `emotion=neutral` | `audiocpp`: Some models support custom options with this (e.g. `emotion=neutral`) |
@@ -109,7 +109,7 @@ If the TUI auto-install doesn't work for some reason, you may need to set up the
- [qwen-tts instructions](app/docs/backend-qwen.md)
- [faster-qwen-tts instructions](app/docs/backend-faster.md)
-`./audiobook.py` can also connect to external servers running these backends if you want to completely manage your own install. The TUI will automatically look for and connect to the API URLs configured in settings. For CLI use, manually point at `--api-url` for an external server.
+`./audiobook.py` can also connect to external servers running these backends if you want to completely manage your own install. The TUI will automatically look for and connect to the API URLs configured in settings. For CLI use, point at `--api-url` for an external server; without it the CLI starts and stops a locally-installed backend server around the run.
## Development