openspeechapi 0.1.0__tar.gz → 0.2.1__tar.gz

{openspeechapi-0.1.0 → openspeechapi-0.2.1}/.env.example

@@ -1,4 +1,4 @@
-# OpenSpeech API Keys
+# OpenSpeechAPI API Keys
 # 复制此文件为 .env 并填入你的 Key:  cp .env.example .env
 
 # ── 云端 Provider Keys ──────────────────────────

{openspeechapi-0.1.0 → openspeechapi-0.2.1}/.github/workflows/ci.yml

@@ -22,10 +22,10 @@ jobs:
         run: pip install -e ".[dev]"
 
       - name: Lint with ruff
-        run: ruff check openspeech/ tests/
+        run: ruff check openspeechapi/ tests/
 
       - name: Run unit and integration tests
         run: pytest tests/unit tests/integration -v --tb=short
 
       - name: Check coverage
-        run: pytest tests/unit tests/integration --cov=openspeech --cov-report=term-missing --cov-fail-under=70
+        run: pytest tests/unit tests/integration --cov=openspeechapi --cov-report=term-missing --cov-fail-under=70

{openspeechapi-0.1.0 → openspeechapi-0.2.1}/Dockerfile

@@ -9,7 +9,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
 
 # Copy project files
 COPY pyproject.toml .
-COPY openspeech/ openspeech/
+COPY openspeechapi/ openspeechapi/
 COPY providers.example.yaml providers.yaml
 
 # Install with all provider deps + server
@@ -17,4 +17,4 @@ RUN pip install --no-cache-dir -e ".[all,server]"
 
 EXPOSE 8600
 
-CMD ["openspeech", "serve", "--config", "providers.yaml", "--host", "0.0.0.0", "--port", "8600"]
+CMD ["openspeechapi", "serve", "--config", "providers.yaml", "--host", "0.0.0.0", "--port", "8600"]

{openspeechapi-0.1.0 → openspeechapi-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openspeechapi
-Version: 0.1.0
+Version: 0.2.1
 Summary: Unified speech interface for STT/TTS providers
 Requires-Python: >=3.11
 Requires-Dist: httpx>=0.27

{openspeechapi-0.1.0 → openspeechapi-0.2.1}/README.md

@@ -1,8 +1,8 @@
-# OpenSpeech
+# OpenSpeechAPI
 
 > Unified speech interface for STT/TTS providers — one API, multiple backends.
 
-OpenSpeech 提供统一的语音接口，通过字符串指定 provider 即可切换不同的 STT/TTS 后端（云端 API、本地模型），无需关心底层实现。
+OpenSpeechAPI 提供统一的语音接口，通过字符串指定 provider 即可切换不同的 STT/TTS 后端（云端 API、本地模型），无需关心底层实现。
 
 ## Quick Start
 
@@ -28,13 +28,13 @@ pip install -e ".[dev]"
 
 ```python
 import asyncio
-from openspeech import create_provider
+from openspeechapi import create_provider
 
 async def main():
     tts = create_provider("openai-tts", api_key="sk-...")
     await tts.start()
 
-    audio = await tts.synthesize("Hello, OpenSpeech!")
+    audio = await tts.synthesize("Hello, OpenSpeechAPI!")
 
     import wave
     with wave.open("output.wav", "wb") as wf:
@@ -52,7 +52,7 @@ asyncio.run(main())
 
 ```python
 import asyncio
-from openspeech import create_provider, AudioData, AudioFormat
+from openspeechapi import create_provider, AudioData, AudioFormat
 from pathlib import Path
 
 async def main():
@@ -64,7 +64,7 @@ async def main():
         sample_rate=16000, channels=1, format=AudioFormat.WAV,
     )
     result = await stt.transcribe(audio)
-    print(result.text)        # "Hello, OpenSpeech!"
+    print(result.text)        # "Hello, OpenSpeechAPI!"
     print(result.language)    # "en"
     print(result.confidence)  # 0.98
 
@@ -96,7 +96,7 @@ open scripts/engines/macos-stt/MacOSSTTHelper.app
 #    系统设置 > 键盘 > 听写 > 下载所需语言模型（中文/英文等）
 
 # 6. 启动服务和 WebUI
-python -m openspeech.cli --config providers.yaml serve
+python -m openspeechapi.cli --config providers.yaml serve
 
 # 7. 浏览器打开 http://127.0.0.1:8600/ui/
 #    - TTS：选择 macos_tts → 选择发音人（如 Tingting）→ 输入文本 → Run TTS
@@ -111,22 +111,22 @@ python -m openspeech.cli --config providers.yaml serve
 
 ```bash
 # TTS：文本 → 语音
-python -m openspeech.demo tts -t "Hello world" -o output.wav
+python -m openspeechapi.demo tts -t "Hello world" -o output.wav
 
 # STT：语音 → 文本
-python -m openspeech.demo stt -i output.wav -p faster-whisper
+python -m openspeechapi.demo stt -i output.wav -p faster-whisper
 
 # Roundtrip：文本 → TTS → STT → 文本
-python -m openspeech.demo roundtrip -t "Hello world"
+python -m openspeechapi.demo roundtrip -t "Hello world"
 
 # Compare：多引擎对比
-python -m openspeech.demo compare -i output.wav -p openai,faster-whisper
+python -m openspeechapi.demo compare -i output.wav -p openai,faster-whisper
 
 # REPL：交互模式
-python -m openspeech.demo repl
+python -m openspeechapi.demo repl
 
 # WebUI（Phase A）
-python -m openspeech.cli serve --host 0.0.0.0 --port 8600
+python -m openspeechapi.cli serve --host 0.0.0.0 --port 8600
 # 浏览器打开 http://127.0.0.1:8600/ui
 
 # 实时 STT：优先使用 WebSocket PCM 流式（/v1/stt/stream），
@@ -137,23 +137,23 @@ python -m openspeech.cli serve --host 0.0.0.0 --port 8600
 
 ```bash
 # 1) 下载/更新运行镜像
-python -m openspeech.cli engine install --name fish-speech --runtime docker --follow
+python -m openspeechapi.cli engine install --name fish-speech --runtime docker --follow
 
 # 2) 启动本地引擎（含健康检查）
-python -m openspeech.cli engine start --name fish-speech --runtime docker --follow
+python -m openspeechapi.cli engine start --name fish-speech --runtime docker --follow
 
 # 3) 查看运行状态/日志
-python -m openspeech.cli engine status --name fish-speech --runtime docker
-python -m openspeech.cli engine logs --name fish-speech --runtime docker --lines 200
+python -m openspeechapi.cli engine status --name fish-speech --runtime docker
+python -m openspeechapi.cli engine logs --name fish-speech --runtime docker --lines 200
 
 # 4) 停止
-python -m openspeech.cli engine stop --name fish-speech --runtime docker --follow
+python -m openspeechapi.cli engine stop --name fish-speech --runtime docker --follow
 
 # 5) 跨进程查询任务
-python -m openspeech.cli engine task list --name fish-speech --limit 20
-python -m openspeech.cli engine task status --task-id <TASK_ID>
-python -m openspeech.cli engine task follow --task-id <TASK_ID>
-python -m openspeech.cli engine task cancel --task-id <TASK_ID>
+python -m openspeechapi.cli engine task list --name fish-speech --limit 20
+python -m openspeechapi.cli engine task status --task-id <TASK_ID>
+python -m openspeechapi.cli engine task follow --task-id <TASK_ID>
+python -m openspeechapi.cli engine task cancel --task-id <TASK_ID>
 ```
 
 进度反馈会显示 task id、阶段、百分比和当前消息，便于追踪长耗时任务。
@@ -162,14 +162,14 @@ python -m openspeech.cli engine task cancel --task-id <TASK_ID>
 
 ```bash
 # faster-whisper 模型资产（native，无常驻服务）
-python -m openspeech.cli engine install --name faster-whisper --runtime native --follow
-python -m openspeech.cli engine start   --name faster-whisper --runtime native --follow
-python -m openspeech.cli engine status  --name faster-whisper --runtime native
+python -m openspeechapi.cli engine install --name faster-whisper --runtime native --follow
+python -m openspeechapi.cli engine start   --name faster-whisper --runtime native --follow
+python -m openspeechapi.cli engine status  --name faster-whisper --runtime native
 
 # whisper 模型资产（native，无常驻服务）
-python -m openspeech.cli engine install --name whisper --runtime native --follow
-python -m openspeech.cli engine start   --name whisper --runtime native --follow
-python -m openspeech.cli engine status  --name whisper --runtime native
+python -m openspeechapi.cli engine install --name whisper --runtime native --follow
+python -m openspeechapi.cli engine start   --name whisper --runtime native --follow
+python -m openspeechapi.cli engine status  --name whisper --runtime native
 ```
 
 说明：安装会优先读取 `~/.aim/config.json + ~/.aim/registry.json` 的 provision 信息来定位模型；若 AIM 未命中，再回退默认本地路径候选。若仍未找到，可按配置走“模拟下载”流程以验证安装进度。
@@ -178,10 +178,10 @@ python -m openspeech.cli engine status  --name whisper --runtime native
 
 ```bash
 # 合成后直接播放
-python -m openspeech.demo tts -t "Hello world" --play
+python -m openspeechapi.demo tts -t "Hello world" --play
 
 # 指定播放参数
-python -m openspeech.demo tts -t "Hello world" --play \
+python -m openspeechapi.demo tts -t "Hello world" --play \
   --play-backend sounddevice --play-device 2 --play-volume 0.8
 ```
 
@@ -213,7 +213,7 @@ python -m openspeech.demo tts -t "Hello world" --play \
 ### 查看所有 provider
 
 ```python
-from openspeech import list_providers
+from openspeechapi import list_providers
 print(list_providers())
 # ['coqui', 'cosyvoice', 'deepgram', 'elevenlabs', 'faster-whisper',
 #  'fish-speech', 'minimax', 'openai-stt', 'openai-tts', 'piper', 'whisper',
@@ -234,7 +234,7 @@ create_provider("openai-stt",
 转录选项通过 `STTOptions` 传入：
 
 ```python
-from openspeech import STTOptions
+from openspeechapi import STTOptions
 result = await stt.transcribe(audio, STTOptions(
     language="zh",            # 语言提示
     prompt="技术会议记录",     # 上下文提示
@@ -268,7 +268,7 @@ create_provider("openai-tts",
 合成选项通过 `TTSOptions` 传入：
 
 ```python
-from openspeech import TTSOptions
+from openspeechapi import TTSOptions
 audio = await tts.synthesize("Hello", TTSOptions(
     voice="nova",             # 覆盖默认声音
     speed=1.2,                # 语速倍率
@@ -390,13 +390,13 @@ create_provider("macos-stt",
 ### 启动服务
 
 ```bash
-openspeech serve --config providers.yaml --port 8600
+openspeechapi serve --config providers.yaml --port 8600
 ```
 
 ### Python Client（与 Library 模式接口一致）
 
 ```python
-from openspeech import Client
+from openspeechapi import Client
 
 async with Client("http://localhost:8600") as c:
     # STT
@@ -459,9 +459,9 @@ providers:
 - `in_process`：预留给真正进程内推理（兼容旧配置，建议迁移）
 
 ```python
-from openspeech import ServiceDispatcher, ProviderRegistry
-from openspeech.providers.stt.openai import OpenAISTT
-from openspeech.providers.stt.faster_whisper import FasterWhisperSTT
+from openspeechapi import ServiceDispatcher, ProviderRegistry
+from openspeechapi.providers.stt.openai import OpenAISTT
+from openspeechapi.providers.stt.faster_whisper import FasterWhisperSTT
 
 registry = ProviderRegistry()
 registry.register("openai-stt", OpenAISTT)
@@ -477,7 +477,7 @@ await dispatcher.stop()
 ### FanOut — 多引擎并发
 
 ```python
-from openspeech.dispatch.fanout import FirstCompleted, CollectAll
+from openspeechapi.dispatch.fanout import FirstCompleted, CollectAll
 
 # 取最快返回的结果
 result = await dispatcher.stt.fanout(
@@ -511,8 +511,8 @@ providers:
 ### Observers（可观测性）
 
 ```python
-from openspeech.observe.metrics import MetricsObserver
-from openspeech.observe.debug import DebugLogObserver
+from openspeechapi.observe.metrics import MetricsObserver
+from openspeechapi.observe.debug import DebugLogObserver
 
 dispatcher.add_observer(MetricsObserver())    # TTFB、耗时、吞吐
 dispatcher.add_observer(DebugLogObserver())   # 详细日志
@@ -534,7 +534,7 @@ AudioFormat: PCM_16K | PCM_44K | WAV | AIFF | MP3 | OGG | FLAC | OPUS
 ## 项目结构
 
 ```
-openspeech/
+openspeechapi/
   core/           # L1: Provider 抽象层（models, enums, base, registry）
   providers/      # Provider 适配器（stt/ 5个含macos, tts/ 8个含macos）
   utils/           # 工具模块（audio_converter, audio_playback）
@@ -544,7 +544,7 @@ openspeech/
   client/         # Python 薄客户端
   factory.py      # create_provider() 工厂函数
   config.py       # YAML 配置加载
-  cli.py          # openspeech list / check / serve
+  cli.py          # openspeechapi list / check / serve
   demo.py         # 交互式 demo CLI
 examples/         # 示例脚本（Library 模式 + Client 模式）
 tests/            # 332 tests（unit + integration + E2E）
@@ -575,12 +575,12 @@ docker-compose up -d
 # 查看日志
 docker-compose logs -f
 
-# GPU 支持（编辑 docker-compose.yml 取消注释 openspeech-gpu 服务）
+# GPU 支持（编辑 docker-compose.yml 取消注释 openspeechapi-gpu 服务）
 ```
 
 **直接启动:**
 ```bash
-openspeech serve --config providers.yaml --port 8600
+openspeechapi serve --config providers.yaml --port 8600
 ```
 
 ## 认证

{openspeechapi-0.1.0 → openspeechapi-0.2.1}/docker-compose.yml

@@ -1,7 +1,7 @@
 version: "3.8"
 
 services:
-  openspeech:
+  openspeechapi:
     build: .
     ports:
       - "8600:8600"
@@ -12,7 +12,7 @@ services:
     restart: unless-stopped
 
   # GPU variant (uncomment for local models like faster-whisper, cosyvoice)
-  # openspeech-gpu:
+  # openspeechapi-gpu:
   #   build: .
   #   ports:
   #     - "8600:8600"

{openspeechapi-0.1.0 → openspeechapi-0.2.1}/docs/architecture/local-engine-manager.md

@@ -1,6 +1,6 @@
 # Local Engine Manager (M1)
 
-`openspeech.local_engines` is an engine-runtime layer separated from provider adapters.
+`openspeechapi.local_engines` is an engine-runtime layer separated from provider adapters.
 
 ## Goals
 
@@ -13,7 +13,7 @@
 - Engine: `fish-speech`
 - Runtime backend: `docker` and `native` (both implemented)
 - Actions: `install`, `update`, `start`, `stop`, `status`, `logs`
-- Persisted tasks: saved under `~/.openspeech/engine_tasks/*.json`
+- Persisted tasks: saved under `~/.openspeechapi/engine_tasks/*.json`
 
 ## Progress model
 
@@ -30,14 +30,14 @@ Long-running actions emit structured progress events:
 CLI can stream updates in real time:
 
 ```bash
-openspeech engine install --name fish-speech --runtime docker --follow
+openspeechapi engine install --name fish-speech --runtime docker --follow
 ```
 
 Task history is queryable across processes:
 
 ```bash
-openspeech engine task list --name fish-speech
-openspeech engine task status --task-id <TASK_ID>
+openspeechapi engine task list --name fish-speech
+openspeechapi engine task status --task-id <TASK_ID>
 ```
 
 ## HTTP endpoints (for future WebUI)

{openspeechapi-0.1.0 → openspeechapi-0.2.1}/docs/architecture/logging-spec.md

@@ -49,7 +49,7 @@
 ### 命令行
 
 ```bash
-openspeech --log-level INFO --log-format json --log-dir logs --log-perf basic serve
+openspeechapi --log-level INFO --log-format json --log-dir logs --log-perf basic serve
 ```
 
 | 参数 | 环境变量 | 默认值 | 说明 |
@@ -62,7 +62,7 @@ openspeech --log-level INFO --log-format json --log-dir logs --log-perf basic se
 ### 程序化
 
 ```python
-from openspeech import configure_logging, bind_context, milestone, Event, PerfTimer
+from openspeechapi import configure_logging, bind_context, milestone, Event, PerfTimer
 
 configure_logging(level="INFO", format="json", log_dir="logs", perf="verbose")
 
@@ -73,7 +73,7 @@ with bind_context(request_id="abc123", provider="faster-whisper"):
 
 ### 文件输出
 
-- 位置：`<log_dir>/openspeech.jsonl`（默认 `logs/openspeech.jsonl`）
+- 位置：`<log_dir>/openspeechapi.jsonl`（默认 `logs/openspeechapi.jsonl`）
 - 轮转：单文件 50 MB，保留 14 天（参数可配置）。
 - 写入：每条一行 JSON（`\n` 结尾），异步 enqueue 落盘，不阻塞事件循环。
 
@@ -85,7 +85,7 @@ with bind_context(request_id="abc123", provider="faster-whisper"):
 
 ```python
 from loguru import logger
-from openspeech import (
+from openspeechapi import (
     integrate_with_host,
     openspeech_filter,
     openspeech_level_filter,
@@ -94,40 +94,40 @@ from openspeech import (
 # 1. 宿主先配置自己的 sink（正常做法）
 logger.add("wallex.log", format="{time} | {level} | [{extra[component]}] {message}")
 
-# 2. 一行完成集成：给 OpenSpeech 记录打 tag、设独立级别
-integrate_with_host(tag="openspeech", level="DEBUG", perf="verbose")
+# 2. 一行完成集成：给 OpenSpeechAPI 记录打 tag、设独立级别
+integrate_with_host(tag="openspeechapi", level="DEBUG", perf="verbose")
 
-# 之后 OpenSpeech 的 logger.info(...) 会自动走宿主的 sink，
-# 且带 record.extra["component"] == "openspeech"
+# 之后 OpenSpeechAPI 的 logger.info(...) 会自动走宿主的 sink，
+# 且带 record.extra["component"] == "openspeechapi"
 
-# 可选：给一条 sink 单独限定 openspeech 的级别
+# 可选：给一条 sink 单独限定 openspeechapi 的级别
 logger.add("wallex.log", filter=openspeech_level_filter("WARNING"))
 
-# 可选：把 openspeech 日志分离到独立文件
-logger.add("openspeech.log", filter=openspeech_filter)
+# 可选：把 openspeechapi 日志分离到独立文件
+logger.add("openspeechapi.log", filter=openspeech_filter)
 ```
 
 `integrate_with_host` 参数：
 
 | 参数 | 说明 |
 | --- | --- |
-| `tag` | `record.extra["component"]` 的值；默认 `"openspeech"` |
-| `level` | **仅对 OpenSpeech 记录**生效的最低级别（通过 filter 实现） |
+| `tag` | `record.extra["component"]` 的值；默认 `"openspeechapi"` |
+| `level` | **仅对 OpenSpeechAPI 记录**生效的最低级别（通过 filter 实现） |
 | `perf` | 性能里程碑详细度（`off` / `basic` / `verbose`），独立于宿主日志级别 |
-| `attach_sinks` | 默认 `False` — OpenSpeech 把 sink 完全让给宿主；`True` 保留自带的 console/JSONL sink（罕用） |
+| `attach_sinks` | 默认 `False` — OpenSpeechAPI 把 sink 完全让给宿主；`True` 保留自带的 console/JSONL sink（罕用） |
 
 辅助函数：
 
-- `openspeech_filter(record) -> bool`：判断是否为 OpenSpeech 记录。
+- `openspeech_filter(record) -> bool`：判断是否为 OpenSpeechAPI 记录。
 - `openspeech_level_filter(min_level)`：返回一个 loguru sink filter，对
-  OpenSpeech 记录应用单独的最低级别，其他来源记录不受影响。
+  OpenSpeechAPI 记录应用单独的最低级别，其他来源记录不受影响。
 - `get_integration_tag()` / `is_host_managed()`：查询当前集成状态。
 
 语义保证：
 
 - `integrate_with_host()` **绝不**调用 `logger.remove()`；宿主已有的 sink
   不会被误删。
-- 之后调用 `create_app()` 或任何 openspeech API 不会再注册 OpenSpeech 自己
+- 之后调用 `create_app()` 或任何 openspeechapi API 不会再注册 OpenSpeechAPI 自己
   的 sink（`ensure_configured()` 在 `host_managed=True` 时是 no-op）。
 - `tag` 可在运行时通过再次调用 `integrate_with_host(tag="...")` 更新。
 - **宿主的 sink 格式字符串**请使用 `{extra[component]}` 读取 tag；注意
@@ -137,7 +137,7 @@ logger.add("openspeech.log", filter=openspeech_filter)
 
 ## 4. 事件枚举（`Event`）
 
-下表即 `openspeech.telemetry.perf.Event` 全量值。命名原则：`<layer>.<phase>`；
+下表即 `openspeechapi.telemetry.perf.Event` 全量值。命名原则：`<layer>.<phase>`；
 一旦发布就不允许重命名，只允许新增。
 
 ### 4.1 HTTP 层（中间件）
@@ -199,7 +199,7 @@ logger.add("openspeech.log", filter=openspeech_filter)
 - **优先字段**：使用 `event` + `elapsed_ms` + `request_id` 即可复现完整
   调用时序。
 - **检索模板**：
-  - 单请求全链路：`grep '"request_id":"abc123"' openspeech.jsonl`
+  - 单请求全链路：`grep '"request_id":"abc123"' openspeechapi.jsonl`
   - TTFB 分析：`jq 'select(.event=="ws.first_response") | .elapsed_ms'`
   - Provider 冷启动耗时：`jq 'select(.event=="lifecycle.provider_init") | {provider, elapsed_ms}'`
 - **错误聚类**：`select(.level=="ERROR" and .exception)` 过滤，再按
@@ -210,7 +210,7 @@ logger.add("openspeech.log", filter=openspeech_filter)
 ## 6. 贡献规范
 
 1. 新增 `Event` 条目必须：
-   - 在 `openspeech/telemetry/perf.py` 的 `Event` 枚举中新增；
+   - 在 `openspeechapi/telemetry/perf.py` 的 `Event` 枚举中新增；
    - 在本文件 4.x 节中补充一行描述（级别 + payload 字段）；
    - 在发布之前写入单测或集成测试验证。
 2. 不允许同名事件改变含义；必须保证字段向后兼容。

{openspeechapi-0.1.0 → openspeechapi-0.2.1}/docs/architecture/stt-streaming-spec.md

@@ -1,6 +1,6 @@
 # STT 流式识别开发规范
 
-> 本文档定义了 OpenSpeech 中 STT Provider 实现流式识别 (`transcribe_stream`) 时必须遵循的协议和最佳实践。  
+> 本文档定义了 OpenSpeechAPI 中 STT Provider 实现流式识别 (`transcribe_stream`) 时必须遵循的协议和最佳实践。  
 > 所有声明了 `Capability.STREAMING` 的 STT Provider 均适用。
 
 ## 1. 整体架构

{openspeechapi-0.1.0 → openspeechapi-0.2.1}/docs/architecture/webui-phase-a.md

@@ -1,6 +1,6 @@
 # WebUI Phase A
 
-OpenSpeech now includes a built-in WebUI at `/ui` for:
+OpenSpeechAPI now includes a built-in WebUI at `/ui` for:
 
 - Capability Lab: STT and TTS test operations from browser
 - Engine Manager: install/update/start/stop local engines with live task progress
@@ -9,7 +9,7 @@ OpenSpeech now includes a built-in WebUI at `/ui` for:
 ## How to run
 
 ```bash
-python -m openspeech.cli serve --host 0.0.0.0 --port 8600
+python -m openspeechapi.cli serve --host 0.0.0.0 --port 8600
 # open http://127.0.0.1:8600/ui
 ```
 

openspeechapi-0.2.1/docs/engines/fish-speech-docker.md

@@ -0,0 +1,40 @@
+# Fish-Speech Docker Runtime
+
+## Install image
+
+```bash
+openspeechapi engine install --name fish-speech --runtime docker --follow
+```
+
+## Start service
+
+```bash
+openspeechapi engine start --name fish-speech --runtime docker --follow
+```
+
+By default this starts container `openspeechapi-fish-speech` and exposes port `8080`.
+
+## Check status
+
+```bash
+openspeechapi engine status --name fish-speech --runtime docker
+```
+
+## Show logs
+
+```bash
+openspeechapi engine logs --name fish-speech --runtime docker --lines 200
+```
+
+## Stop service
+
+```bash
+openspeechapi engine stop --name fish-speech --runtime docker --follow
+```
+
+## Optional overrides
+
+- `--image` to choose a custom image
+- `--container-name` to avoid conflicts
+- `--host-port` to change exposed host port
+- `--health-url` if your image uses a non-default health endpoint

{openspeechapi-0.1.0 → openspeechapi-0.2.1}/docs/engines/stt-native-models.md

@@ -13,24 +13,24 @@ This project now supports native STT local engines:
 ## Commands
 
 ```bash
-openspeech engine install --name faster-whisper --runtime native --follow
-openspeech engine start   --name faster-whisper --runtime native --follow
-openspeech engine status  --name faster-whisper --runtime native
+openspeechapi engine install --name faster-whisper --runtime native --follow
+openspeechapi engine start   --name faster-whisper --runtime native --follow
+openspeechapi engine status  --name faster-whisper --runtime native
 
-openspeech engine install --name whisper --runtime native --follow
-openspeech engine start   --name whisper --runtime native --follow
-openspeech engine status  --name whisper --runtime native
+openspeechapi engine install --name whisper --runtime native --follow
+openspeechapi engine start   --name whisper --runtime native --follow
+openspeechapi engine status  --name whisper --runtime native
 
-openspeech engine install --name whisperlivekit --runtime native --follow
-openspeech engine start   --name whisperlivekit --runtime native --follow
-openspeech engine status  --name whisperlivekit --runtime native
+openspeechapi engine install --name whisperlivekit --runtime native --follow
+openspeechapi engine start   --name whisperlivekit --runtime native --follow
+openspeechapi engine status  --name whisperlivekit --runtime native
 
-openspeech engine install --name sherpa-onnx --runtime native --follow
-openspeech engine start   --name sherpa-onnx --runtime native --follow
-openspeech engine status  --name sherpa-onnx --runtime native
+openspeechapi engine install --name sherpa-onnx --runtime native --follow
+openspeechapi engine start   --name sherpa-onnx --runtime native --follow
+openspeechapi engine status  --name sherpa-onnx --runtime native
 
 # install with a real model repo download (instead of simulation)
-openspeech engine install \
+openspeechapi engine install \
   --name sherpa-onnx \
   --runtime native \
   --model-repo k2-fsa/sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20 \