@termix-it/cryptoclaw 1.0.0

package/docs/zh-CN/tts.md

@@ -0,0 +1,375 @@
+---
+read_when:
+  - 为回复启用文本转语音
+  - 配置 TTS 提供商或限制
+  - 使用 /tts 命令
+summary: 出站回复的文本转语音（TTS）
+title: 文本转语音
+x-i18n:
+  generated_at: "2026-02-03T10:13:55Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 070ff0cc8592f64c6c9e4ddaddc7e8fba82f0692ceded6fe833ec9ba5b61e6fb
+  source_path: tts.md
+  workflow: 15
+---
+
+# 文本转语音（TTS）
+
+OpenClaw 可以使用 ElevenLabs、OpenAI 或 Edge TTS 将出站回复转换为音频。它可以在任何 OpenClaw 能发送音频的地方工作；Telegram 会显示圆形语音消息气泡。
+
+## 支持的服务
+
+- **ElevenLabs**（主要或备用提供商）
+- **OpenAI**（主要或备用提供商；也用于摘要）
+- **Edge TTS**（主要或备用提供商；使用 `node-edge-tts`，无 API 密钥时为默认）
+
+### Edge TTS 注意事项
+
+Edge TTS 通过 `node-edge-tts` 库使用 Microsoft Edge 的在线神经网络 TTS 服务。它是托管服务（非本地），使用 Microsoft 的端点，不需要 API 密钥。`node-edge-tts` 公开了语音配置选项和输出格式，但并非所有选项都被 Edge 服务支持。citeturn2search0
+
+由于 Edge TTS 是一个没有公布 SLA 或配额的公共 Web 服务，请将其视为尽力而为。如果你需要有保证的限制和支持，请使用 OpenAI 或 ElevenLabs。Microsoft 的语音 REST API 记录了每个请求 10 分钟的音频限制；Edge TTS 没有公布限制，所以假设类似或更低的限制。citeturn0search3
+
+## 可选密钥
+
+如果你想使用 OpenAI 或 ElevenLabs：
+
+- `ELEVENLABS_API_KEY`（或 `XI_API_KEY`）
+- `OPENAI_API_KEY`
+
+Edge TTS **不**需要 API 密钥。如果没有找到 API 密钥，OpenClaw 默认使用 Edge TTS（除非通过 `messages.tts.edge.enabled=false` 禁用）。
+
+如果配置了多个提供商，首先使用选定的提供商，其他作为备用选项。自动摘要使用配置的 `summaryModel`（或 `agents.defaults.model.primary`），所以如果你启用摘要，该提供商也必须经过认证。
+
+## 服务链接
+
+- [OpenAI 文本转语音指南](https://platform.openai.com/docs/guides/text-to-speech)
+- [OpenAI 音频 API 参考](https://platform.openai.com/docs/api-reference/audio)
+- [ElevenLabs 文本转语音](https://elevenlabs.io/docs/api-reference/text-to-speech)
+- [ElevenLabs 认证](https://elevenlabs.io/docs/api-reference/authentication)
+- [node-edge-tts](https://github.com/SchneeHertz/node-edge-tts)
+- [Microsoft 语音输出格式](https://learn.microsoft.com/azure/ai-services/speech-service/rest-text-to-speech#audio-outputs)
+
+## 默认启用吗？
+
+不是。自动 TTS 默认**关闭**。在配置中使用 `messages.tts.auto` 或在每个会话中使用 `/tts always`（别名：`/tts on`）启用它。
+
+一旦 TTS 开启，Edge TTS **是**默认启用的，并在没有 OpenAI 或 ElevenLabs API 密钥时自动使用。
+
+## 配置
+
+TTS 配置位于 `openclaw.json` 中的 `messages.tts` 下。完整 schema 在 [Gateway 网关配置](/gateway/configuration)中。
+
+### 最小配置（启用 + 提供商）
+
+```json5
+{
+  messages: {
+    tts: {
+      auto: "always",
+      provider: "elevenlabs",
+    },
+  },
+}
+```
+
+### OpenAI 主要，ElevenLabs 备用
+
+```json5
+{
+  messages: {
+    tts: {
+      auto: "always",
+      provider: "openai",
+      summaryModel: "openai/gpt-4.1-mini",
+      modelOverrides: {
+        enabled: true,
+      },
+      openai: {
+        apiKey: "openai_api_key",
+        model: "gpt-4o-mini-tts",
+        voice: "alloy",
+      },
+      elevenlabs: {
+        apiKey: "elevenlabs_api_key",
+        baseUrl: "https://api.elevenlabs.io",
+        voiceId: "voice_id",
+        modelId: "eleven_multilingual_v2",
+        seed: 42,
+        applyTextNormalization: "auto",
+        languageCode: "en",
+        voiceSettings: {
+          stability: 0.5,
+          similarityBoost: 0.75,
+          style: 0.0,
+          useSpeakerBoost: true,
+          speed: 1.0,
+        },
+      },
+    },
+  },
+}
+```
+
+### Edge TTS 主要（无 API 密钥）
+
+```json5
+{
+  messages: {
+    tts: {
+      auto: "always",
+      provider: "edge",
+      edge: {
+        enabled: true,
+        voice: "en-US-MichelleNeural",
+        lang: "en-US",
+        outputFormat: "audio-24khz-48kbitrate-mono-mp3",
+        rate: "+10%",
+        pitch: "-5%",
+      },
+    },
+  },
+}
+```
+
+### 禁用 Edge TTS
+
+```json5
+{
+  messages: {
+    tts: {
+      edge: {
+        enabled: false,
+      },
+    },
+  },
+}
+```
+
+### 自定义限制 + 偏好路径
+
+```json5
+{
+  messages: {
+    tts: {
+      auto: "always",
+      maxTextLength: 4000,
+      timeoutMs: 30000,
+      prefsPath: "~/.openclaw/settings/tts.json",
+    },
+  },
+}
+```
+
+### 仅在收到语音消息后用音频回复
+
+```json5
+{
+  messages: {
+    tts: {
+      auto: "inbound",
+    },
+  },
+}
+```
+
+### 禁用长回复的自动摘要
+
+```json5
+{
+  messages: {
+    tts: {
+      auto: "always",
+    },
+  },
+}
+```
+
+然后运行：
+
+```
+/tts summary off
+```
+
+### 字段说明
+
+- `auto`：自动 TTS 模式（`off`、`always`、`inbound`、`tagged`）。
+  - `inbound` 仅在收到语音消息后发送音频。
+  - `tagged` 仅在回复包含 `[[tts]]` 标签时发送音频。
+- `enabled`：旧版开关（doctor 将其迁移到 `auto`）。
+- `mode`：`"final"`（默认）或 `"all"`（包括工具/分块回复）。
+- `provider`：`"elevenlabs"`、`"openai"` 或 `"edge"`（自动备用）。
+- 如果 `provider` **未设置**，OpenClaw 优先选择 `openai`（如果有密钥），然后是 `elevenlabs`（如果有密钥），否则是 `edge`。
+- `summaryModel`：用于自动摘要的可选廉价模型；默认为 `agents.defaults.model.primary`。
+  - 接受 `provider/model` 或配置的模型别名。
+- `modelOverrides`：允许模型发出 TTS 指令（默认开启）。
+- `maxTextLength`：TTS 输入的硬性上限（字符）。超出时 `/tts audio` 会失败。
+- `timeoutMs`：请求超时（毫秒）。
+- `prefsPath`：覆盖本地偏好 JSON 路径（提供商/限制/摘要）。
+- `apiKey` 值回退到环境变量（`ELEVENLABS_API_KEY`/`XI_API_KEY`、`OPENAI_API_KEY`）。
+- `elevenlabs.baseUrl`：覆盖 ElevenLabs API 基础 URL。
+- `elevenlabs.voiceSettings`：
+  - `stability`、`similarityBoost`、`style`：`0..1`
+  - `useSpeakerBoost`：`true|false`
+  - `speed`：`0.5..2.0`（1.0 = 正常）
+- `elevenlabs.applyTextNormalization`：`auto|on|off`
+- `elevenlabs.languageCode`：2 字母 ISO 639-1（例如 `en`、`de`）
+- `elevenlabs.seed`：整数 `0..4294967295`（尽力确定性）
+- `edge.enabled`：允许 Edge TTS 使用（默认 `true`；无 API 密钥）。
+- `edge.voice`：Edge 神经网络语音名称（例如 `en-US-MichelleNeural`）。
+- `edge.lang`：语言代码（例如 `en-US`）。
+- `edge.outputFormat`：Edge 输出格式（例如 `audio-24khz-48kbitrate-mono-mp3`）。
+  - 有效值参见 Microsoft 语音输出格式；并非所有格式都被 Edge 支持。
+- `edge.rate` / `edge.pitch` / `edge.volume`：百分比字符串（例如 `+10%`、`-5%`）。
+- `edge.saveSubtitles`：在音频文件旁边写入 JSON 字幕。
+- `edge.proxy`：Edge TTS 请求的代理 URL。
+- `edge.timeoutMs`：请求超时覆盖（毫秒）。
+
+## 模型驱动覆盖（默认开启）
+
+默认情况下，模型**可以**为单个回复发出 TTS 指令。当 `messages.tts.auto` 为 `tagged` 时，需要这些指令来触发音频。
+
+启用后，模型可以发出 `[[tts:...]]` 指令来覆盖单个回复的语音，加上可选的 `[[tts:text]]...[[/tts:text]]` 块来提供表达性标签（笑声、唱歌提示等），这些仅应出现在音频中。
+
+示例回复负载：
+
+```
+Here you go.
+
+[[tts:provider=elevenlabs voiceId=pMsXgVXv3BLzUgSXRplE model=eleven_v3 speed=1.1]]
+[[tts:text]](laughs) Read the song once more.[[/tts:text]]
+```
+
+可用指令键（启用时）：
+
+- `provider`（`openai` | `elevenlabs` | `edge`）
+- `voice`（OpenAI 语音）或 `voiceId`（ElevenLabs）
+- `model`（OpenAI TTS 模型或 ElevenLabs 模型 ID）
+- `stability`、`similarityBoost`、`style`、`speed`、`useSpeakerBoost`
+- `applyTextNormalization`（`auto|on|off`）
+- `languageCode`（ISO 639-1）
+- `seed`
+
+禁用所有模型覆盖：
+
+```json5
+{
+  messages: {
+    tts: {
+      modelOverrides: {
+        enabled: false,
+      },
+    },
+  },
+}
+```
+
+可选白名单（禁用特定覆盖同时保持标签启用）：
+
+```json5
+{
+  messages: {
+    tts: {
+      modelOverrides: {
+        enabled: true,
+        allowProvider: false,
+        allowSeed: false,
+      },
+    },
+  },
+}
+```
+
+## 单用户偏好
+
+斜杠命令将本地覆盖写入 `prefsPath`（默认：`~/.openclaw/settings/tts.json`，可通过 `OPENCLAW_TTS_PREFS` 或 `messages.tts.prefsPath` 覆盖）。
+
+存储的字段：
+
+- `enabled`
+- `provider`
+- `maxLength`（摘要阈值；默认 1500 字符）
+- `summarize`（默认 `true`）
+
+这些为该主机覆盖 `messages.tts.*`。
+
+## 输出格式（固定）
+
+- **Telegram**：Opus 语音消息（ElevenLabs 的 `opus_48000_64`，OpenAI 的 `opus`）。
+  - 48kHz / 64kbps 是语音消息的良好权衡，圆形气泡所必需。
+- **其他渠道**：MP3（ElevenLabs 的 `mp3_44100_128`，OpenAI 的 `mp3`）。
+  - 44.1kHz / 128kbps 是语音清晰度的默认平衡。
+- **Edge TTS**：使用 `edge.outputFormat`（默认 `audio-24khz-48kbitrate-mono-mp3`）。
+  - `node-edge-tts` 接受 `outputFormat`，但并非所有格式都可从 Edge 服务获得。citeturn2search0
+  - 输出格式值遵循 Microsoft 语音输出格式（包括 Ogg/WebM Opus）。citeturn1search0
+  - Telegram `sendVoice` 接受 OGG/MP3/M4A；如果你需要有保证的 Opus 语音消息，请使用 OpenAI/ElevenLabs。citeturn1search1
+  - 如果配置的 Edge 输出格式失败，OpenClaw 会使用 MP3 重试。
+
+OpenAI/ElevenLabs 格式是固定的；Telegram 期望 Opus 以获得语音消息用户体验。
+
+## 自动 TTS 行为
+
+启用后，OpenClaw：
+
+- 如果回复已包含媒体或 `MEDIA:` 指令，则跳过 TTS。
+- 跳过非常短的回复（< 10 字符）。
+- 启用时使用 `agents.defaults.model.primary`（或 `summaryModel`）对长回复进行摘要。
+- 将生成的音频附加到回复中。
+
+如果回复超过 `maxLength` 且摘要关闭（或没有摘要模型的 API 密钥），则跳过音频并发送正常的文本回复。
+
+## 流程图
+
+```
+回复 -> TTS 启用？
+  否  -> 发送文本
+  是  -> 有媒体 / MEDIA: / 太短？
+          是 -> 发送文本
+          否 -> 长度 > 限制？
+                   否  -> TTS -> 附加音频
+                   是  -> 摘要启用？
+                            否  -> 发送文本
+                            是  -> 摘要（summaryModel 或 agents.defaults.model.primary）
+                                      -> TTS -> 附加音频
+```
+
+## 斜杠命令用法
+
+只有一个命令：`/tts`。参见[斜杠命令](/tools/slash-commands)了解启用详情。
+
+Discord 注意：`/tts` 是 Discord 的内置命令，所以 OpenClaw 在那里注册 `/voice` 作为原生命令。文本 `/tts ...` 仍然有效。
+
+```
+/tts off
+/tts always
+/tts inbound
+/tts tagged
+/tts status
+/tts provider openai
+/tts limit 2000
+/tts summary off
+/tts audio Hello from OpenClaw
+```
+
+注意事项：
+
+- 命令需要授权发送者（白名单/所有者规则仍然适用）。
+- 必须启用 `commands.text` 或原生命令注册。
+- `off|always|inbound|tagged` 是单会话开关（`/tts on` 是 `/tts always` 的别名）。
+- `limit` 和 `summary` 存储在本地偏好中，不在主配置中。
+- `/tts audio` 生成一次性音频回复（不会开启 TTS）。
+
+## 智能体工具
+
+`tts` 工具将文本转换为语音并返回 `MEDIA:` 路径。当结果与 Telegram 兼容时，工具包含 `[[audio_as_voice]]`，以便 Telegram 发送语音气泡。
+
+## Gateway 网关 RPC
+
+Gateway 网关方法：
+
+- `tts.status`
+- `tts.enable`
+- `tts.disable`
+- `tts.convert`
+- `tts.setProvider`
+- `tts.providers`

package/docs/zh-CN/tui.md

@@ -0,0 +1,166 @@
+---
+read_when:
+  - 你想要 TUI 的新手友好演练
+  - 你需要 TUI 功能、命令和快捷键的完整列表
+summary: 终端 UI（TUI）：从任何机器连接到 Gateway 网关
+title: TUI
+x-i18n:
+  generated_at: "2026-02-03T10:13:10Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 4bf5b0037bbb3a166289f2f0a9399489637d4cf26335ae3577af9ea83eee747e
+  source_path: tui.md
+  workflow: 15
+---
+
+# TUI（终端 UI）
+
+## 快速开始
+
+1. 启动 Gateway 网关。
+
+```bash
+openclaw gateway
+```
+
+2. 打开 TUI。
+
+```bash
+openclaw tui
+```
+
+3. 输入消息并按 Enter。
+
+远程 Gateway 网关：
+
+```bash
+openclaw tui --url ws://<host>:<port> --token <gateway-token>
+```
+
+如果你的 Gateway 网关使用密码认证，请使用 `--password`。
+
+## 你看到的内容
+
+- 标题栏：连接 URL、当前智能体、当前会话。
+- 聊天日志：用户消息、助手回复、系统通知、工具卡片。
+- 状态行：连接/运行状态（连接中、运行中、流式传输中、空闲、错误）。
+- 页脚：连接状态 + 智能体 + 会话 + 模型 + think/verbose/reasoning + token 计数 + 投递状态。
+- 输入：带自动完成的文本编辑器。
+
+## 心智模型：智能体 + 会话
+
+- 智能体是唯一的标识符（例如 `main`、`research`）。Gateway 网关公开列表。
+- 会话属于当前智能体。
+- 会话键存储为 `agent:<agentId>:<sessionKey>`。
+  - 如果你输入 `/session main`，TUI 会将其扩展为 `agent:<currentAgent>:main`。
+  - 如果你输入 `/session agent:other:main`，你会显式切换到该智能体会话。
+- 会话范围：
+  - `per-sender`（默认）：每个智能体有多个会话。
+  - `global`：TUI 始终使用 `global` 会话（选择器可能为空）。
+- 当前智能体 + 会话始终在页脚中可见。
+
+## 发送 + 投递
+
+- 消息发送到 Gateway 网关；默认情况下不投递到提供商。
+- 开启投递：
+  - `/deliver on`
+  - 或设置面板
+  - 或使用 `openclaw tui --deliver` 启动
+
+## 选择器 + 覆盖层
+
+- 模型选择器：列出可用模型并设置会话覆盖。
+- 智能体选择器：选择不同的智能体。
+- 会话选择器：仅显示当前智能体的会话。
+- 设置：切换投递、工具输出展开和思考可见性。
+
+## 键盘快捷键
+
+- Enter：发送消息
+- Esc：中止活动运行
+- Ctrl+C：清除输入（按两次退出）
+- Ctrl+D：退出
+- Ctrl+L：模型选择器
+- Ctrl+G：智能体选择器
+- Ctrl+P：会话选择器
+- Ctrl+O：切换工具输出展开
+- Ctrl+T：切换思考可见性（重新加载历史）
+
+## 斜杠命令
+
+核心：
+
+- `/help`
+- `/status`
+- `/agent <id>`（或 `/agents`）
+- `/session <key>`（或 `/sessions`）
+- `/model <provider/model>`（或 `/models`）
+
+会话控制：
+
+- `/think <off|minimal|low|medium|high>`
+- `/verbose <on|full|off>`
+- `/reasoning <on|off|stream>`
+- `/usage <off|tokens|full>`
+- `/elevated <on|off|ask|full>`（别名：`/elev`）
+- `/activation <mention|always>`
+- `/deliver <on|off>`
+
+会话生命周期：
+
+- `/new` 或 `/reset`（重置会话）
+- `/abort`（中止活动运行）
+- `/settings`
+- `/exit`
+
+其他 Gateway 网关斜杠命令（例如 `/context`）会转发到 Gateway 网关并显示为系统输出。参见[斜杠命令](/tools/slash-commands)。
+
+## 本地 shell 命令
+
+- 以 `!` 为前缀的行会在 TUI 主机上运行本地 shell 命令。
+- TUI 每个会话会提示一次以允许本地执行；拒绝会在该会话中禁用 `!`。
+- 命令在 TUI 工作目录中以全新的非交互式 shell 运行（无持久化 `cd`/环境变量）。
+- 单独的 `!` 会作为普通消息发送；前导空格不会触发本地执行。
+
+## 工具输出
+
+- 工具调用显示为带有参数 + 结果的卡片。
+- Ctrl+O 在折叠/展开视图之间切换。
+- 工具运行时，部分更新会流式传输到同一张卡片。
+
+## 历史 + 流式传输
+
+- 连接时，TUI 加载最新历史（默认 200 条消息）。
+- 流式响应原地更新直到完成。
+- TUI 还监听智能体工具事件以获得更丰富的工具卡片。
+
+## 连接详情
+
+- TUI 以 `mode: "tui"` 向 Gateway 网关注册。
+- 重新连接会显示系统消息；事件间隙会在日志中显示。
+
+## 选项
+
+- `--url <url>`：Gateway 网关 WebSocket URL（默认为配置或 `ws://127.0.0.1:<port>`）
+- `--token <token>`：Gateway 网关令牌（如果需要）
+- `--password <password>`：Gateway 网关密码（如果需要）
+- `--session <key>`：会话键（默认：`main`，或范围为全局时为 `global`）
+- `--deliver`：将助手回复投递到提供商（默认关闭）
+- `--thinking <level>`：覆盖发送的思考级别
+- `--timeout-ms <ms>`：智能体超时（毫秒）（默认为 `agents.defaults.timeoutSeconds`）
+
+## 故障排除
+
+发送消息后没有输出：
+
+- 在 TUI 中运行 `/status` 以确认 Gateway 网关已连接且处于空闲/忙碌状态。
+- 检查 Gateway 网关日志：`openclaw logs --follow`。
+- 确认智能体可以运行：`openclaw status` 和 `openclaw models status`。
+- 如果你期望消息出现在聊天渠道中，请启用投递（`/deliver on` 或 `--deliver`）。
+- `--history-limit <n>`：要加载的历史条目数（默认 200）
+
+## 故障排除
+
+- `disconnected`：确保 Gateway 网关正在运行且你的 `--url/--token/--password` 正确。
+- 选择器中没有智能体：检查 `openclaw agents list` 和你的路由配置。
+- 会话选择器为空：你可能处于全局范围或还没有会话。

package/docs/zh-CN/vps.md

@@ -0,0 +1,47 @@
+---
+read_when:
+  - 你想在云端运行 Gateway 网关
+  - 你需要 VPS/托管指南的快速索引
+summary: OpenClaw 的 VPS 托管中心（Oracle/Fly/Hetzner/GCP/exe.dev）
+title: VPS 托管
+x-i18n:
+  generated_at: "2026-02-03T10:12:57Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 7749b479b333aa5541e7ad8b0ff84e9f8f6bd10d7188285121975cb893acc037
+  source_path: vps.md
+  workflow: 15
+---
+
+# VPS 托管
+
+本中心链接到支持的 VPS/托管指南，并在高层次上解释云部署的工作原理。
+
+## 选择提供商
+
+- **Railway**（一键 + 浏览器设置）：[Railway](/railway)
+- **Northflank**（一键 + 浏览器设置）：[Northflank](/northflank)
+- **Oracle Cloud（永久免费）**：[Oracle](/platforms/oracle) — $0/月（永久免费，ARM；容量/注册可能不太稳定）
+- **Fly.io**：[Fly.io](/install/fly)
+- **Hetzner（Docker）**：[Hetzner](/install/hetzner)
+- **GCP（Compute Engine）**：[GCP](/install/gcp)
+- **exe.dev**（VM + HTTPS 代理）：[exe.dev](/install/exe-dev)
+- **AWS（EC2/Lightsail/免费套餐）**：也运行良好。视频指南：
+  https://x.com/techfrenAJ/status/2014934471095812547
+
+## 云设置的工作原理
+
+- **Gateway 网关运行在 VPS 上**并拥有状态 + 工作区。
+- 你通过**控制 UI** 或 **Tailscale/SSH** 从笔记本电脑/手机连接。
+- 将 VPS 视为数据源并**备份**状态 + 工作区。
+- 安全默认：将 Gateway 网关保持在 loopback 上，通过 SSH 隧道或 Tailscale Serve 访问。
+  如果你绑定到 `lan`/`tailnet`，需要 `gateway.auth.token` 或 `gateway.auth.password`。
+
+远程访问：[Gateway 网关远程访问](/gateway/remote)
+平台中心：[平台](/platforms)
+
+## 在 VPS 上使用节点
+
+你可以将 Gateway 网关保持在云端，并在本地设备（Mac/iOS/Android/无头）上配对**节点**。节点提供本地屏幕/摄像头/canvas 和 `system.run` 功能，而 Gateway 网关保持在云端。
+
+文档：[节点](/nodes)，[节点 CLI](/cli/nodes)