内容
# Speekify
Speekify 将文本转换为本地 WAV 文件，您可以聆听 — 来自内联 CLI 文本、标准输入、本地 `.txt`/`.md`/`.pdf` 文件、YouTube 转录或 URL 的可读内容。音频使用 Supertonic v3 在本地生成。
## 功能
| 功能 | 您获得的内容 |
|---|---|
| **多种输入源** | 内联文本、管道标准输入、本地 `.txt`/`.md`/`.pdf` 文件、可读 URL 和 YouTube 转录 — 自动检测。 |
| **本地 TTS** | 使用 Supertonic v3 在您的机器上合成 WAV 文件 — 没有音频离开您的计算机。 |
| **多语言** | `en`、`fr`、`de`、`es`、`it`、`pt`、`ja`、`ko` 等，以及 `na` 用于语言无关的合成。 |
| **自动翻译** | 当在法语（默认）合成时，检测英语输入并将其翻译为法语。 |
| **语音控制** | 10 种内置语音（`M1`–`M5`、`F1`–`F5`）、自定义 Voice Builder JSON 样式，以及速度和合成步骤调整。 |
| **MCP 服务器** | 将 Speekify 暴露为工具，以便 AI 助手可以在自动化过程中生成音频。 |
## 安装
`speekify setup`（安装后运行一次）下载并预热 Supertonic 模型，默认情况下还会下载英语→法语翻译模型。如果您跳过它，模型将在首次使用时自动下载。
### macOS — 无需 Python 或 uv
发布版本后，通过 Homebrew 安装独立二进制文件：
```bash
brew tap otterlyspacelabs/speekify https://github.com/OtterlySpaceLabs/speekify
brew install speekify
speekify setup
```
或直接下载存档：
```bash
curl -L -o speekify.tar.gz https://github.com/OtterlySpaceLabs/speekify/releases/latest/download/speekify-macos-arm64.tar.gz
tar -xzf speekify.tar.gz
mv speekify /usr/local/bin/speekify
speekify setup
```
### 使用 pip / pipx / uv
在 PyPI 上发布后：
```bash
pip install speekify # 或：pipx install speekify （推荐用于 CLI）
speekify setup
uv tool install speekify # uv 用户
speekify setup
```
无需安装即可运行：
```bash
uvx speekify "Hello world"
pipx run speekify "Hello world"
```
### 从源代码使用 uv
```bash
uv sync
uv run speekify setup
```
## 快速入门
Speekify 是一个 CLI。给它内联文本、URL、本地文件路径或管道标准输入：
```bash
speekify "Hello world" # 内联文本
speekify https://example.com/article # 可读 URL
speekify ~/Documents/article.pdf # 本地 PDF
speekify --lang fr "https://www.youtube.com/watch?v=eSP7PLTXNy8" # YouTube
printf 'Hello from stdin' | speekify # 标准输入
speekify --voice F2 --output-dir ~/Desktop "Hello world" # 选择语音 + 目录
```
当 URL 包含 `?` 或 `&` （常见于 YouTube）时，请用引号包裹 URL，否则 shell 可能会拒绝该命令。从源代码检查中，在任何命令前添加 `uv run`（例如 `uv run speekify "Hello world"`）。
**→ 完整的命令列表、每个选项和配置文件：[docs/usage.md](docs/usage.md).**
## MCP 自动化服务器
Speekify 附带一个本地模型上下文协议（MCP）服务器，以便 AI 助手可以将其作为工具调用。它公开了 `speekify_generate_wav`（文本/URL/文件 → WAV，带有结构化详细信息）、`speekify_generation_defaults`（支持的语音、语言和范围）和 `news_recap_to_audio` 提示模板。
```bash
speekify mcp # 用于桌面 AI 客户端的标准输入/输出传输
speekify mcp --transport streamable-http # 用于本地实验的 HTTP 端点
```
每个客户端设置（Claude Code、GitHub Copilot、Codex、OpenAI 远程 MCP）：[docs/mcp-clients.md](docs/mcp-clients.md).
## 文档
| 文档 | 内容 |
|---|---|
| [docs/usage.md](docs/usage.md) | 完整的 CLI 参考 — 每个命令、选项、配置文件和输出命名。 |
| [docs/sources.md](docs/sources.md) | 支持的输入源、提取规则和限制、翻译、文本处理和日志。 |
| [docs/mcp-clients.md](docs/mcp-clients.md) | 用于 Claude Code、GitHub Copilot、Codex 和远程 MCP 的 MCP 服务器设置。 |
| [docs/release-procedure.md](docs/release-procedure.md) | 维护者发布检查清单。 |
## 使用和内容
Speekify 仅获取您明确指向的内容，供您个人使用。您有责任尊重您提取的任何来源（包括 YouTube 转录）的服务条款和版权。维护者不提供第三方内容的任何权利。
## 许可证
MIT — 请参阅 [LICENSE](LICENSE)。版权 © 2026 Otterly Space SARL。
