BLX代码文档
BLXCode 文档 — BLXCode 文档。
欢迎来到 BLXCode 文档。用户指南解释如何运行和使用该应用程序；开发人员指南解释了如何构建、扩展和贡献。
已发布的副本： GitHub Wiki（在推送到触摸 docs/** 的 main 时自动从此文件夹同步）。在存储库中编辑文档，而不是在 wiki Web UI 中。
文档地图
| 主题 | 指南 |
|---|---|
| 设置（API 密钥、BLXCode 代理（文本/图像/语音、MCP、心跳、内存、代码编辑器）、工作区、外观/主题、帮助/关于、应用程序日志） | 设置 · 外观和主题 |
| 工作台、终端、侧边栏、Git diff/sync、切换、应用程序状态行、侧边栏上下文拖放 | 工作空间 |
| 通过 SSH 的远程工作空间（连接、终端、文件/git、简历） | 远程 (SSH) |
| 文件预览（图像、视频、Markdown、Mermaid、Vim 模式） | 文件预览 |
| 内存、学习内容、架构图、图表、内存索引器（HeartBeat）、内存设置窗格 | 内存和任务 |
| Markdown 计划、计划链接任务、多看板、美人鱼图库 | 计划 |
| 工作空间规则和技巧 | 规则和技能 |
| 核心技能（包括MCP、提示生成）、shell/git/web 工具 | 代理线束 |
| 协调子代理（侦察/审查/安全） | 子代理 |
| Tmux 与传统快捷方式、创建工作空间、一键通 | 键盘快捷键 |
| 图像生成模式 | 图像模式 |
| 提供商、API 密钥、上下文、挂钩、MCP 服务器、代理昵称、入门 | 代理提供商 |
| 语音 STT/TTS，一键通（本地耳语/云） | 语音 |
| UI 语言和 EULA | 用户界面语言 |
| 从源代码构建 | 建筑物 |
| 常见问题 | 疑难解答 |
用户文档
- 入门 — 先决条件、运行 BLXCode、第一个工作区（数据所在的位置）、欢迎屏幕创建工作区、每个代理模型/工作量队列。
- 设置 — 停靠的中心选项卡设置、API 密钥、BLXCode Agent（文本/图像/语音）、MCP、HeartBeat、内存、代码编辑器 (Vim)、工作区、外观/主题、帮助/关于、应用程序日志、通知。
- 外观和主题 — 主题选择器、预设、持久性、例外、字体大小。
- 工作区 — 创建、终端网格、侧边栏浏览器、文件差异（阶段/提交/推送）、Git 图表（获取/拉取）、切换、持久性、应用程序状态行、侧边栏上下文拖放（文件/文件夹/差异/提交）、挂钩安装对话框、命名终端。
- 远程 (SSH) — 设置 → 远程连接预设（密码/密钥/代理、加密机密）、创建远程工作区、远程终端 + 文件/git + 会话恢复（tmux 与 keepalive）。
- 文件预览 — 图像（包括 SVG）、视频、渲染的 Markdown、语法突出显示的源代码和美人鱼图的中心选项卡预览。 Vim 模式 通过
@replit/codemirror-vim。存储库策略文档（LICENSE、CONTRIBUTING、SECURITY、CHANGELOG...）呈现为带有特定类型英雄横幅的 Markdown — 带或不带.md扩展名。 - 内存和任务 — 内存面板（文件、图表、搜索）、架构图、动态类别、任务、代理内存工具、内存索引器（HeartBeat）、内存设置窗格。
- 计划 —
.agents/plans/<slug>/plan.md、自动维护的PLANS.md索引、工作区多看板、美人鱼图库、任务语法、计划面板、代理工具。 - 规则和技能 — 可扩展的规则/技能卡、核心技能与用户技能、安装对话框。
- Agent Harness — 核心技能（包括 MCP、提示生成）、精简提示、环境/shell/git/web、Web API 密钥。
- 子代理 — 并行运行、角色、时间线、工具组、限制。
- 键盘快捷键 — tmux 前缀与传统和弦、通知 toast、创建工作空间、一键通。
- 图像模式 — 从代理面板、设置、限制、持久性生成图像。
- 代理提供商 — OpenRouter、Anthropic、OpenAI 兼容 + Ollama / LM Studio / Hugging Face / Cloudflare / Together / Portkey / 自定义、MCP 服务器、代理昵称、入门、侧边栏上下文类型。
- 语音 — STT、TTS、麦克风、一键通（本地 Whisper/云）。
- UI 语言 — 区域设置、语言选择器、EULA 本地化。
- Building — Linux、macOS、Windows 发行版。
- 故障排除 — 启动、构建、浏览器、密钥环、终端问题。
开发者文档
- Setup — 本地环境和验证命令。
- 架构 — 前端/后端拆分、代理、内存、计划、切换、图表、HeartBeat、内存索引器、MCP、看板、美人鱼、通知、应用程序日志、应用程序状态行、侧边栏上下文拖放。
- Agent Harness — 核心技能（包括 MCP、提示生成）、工具调度、Web 设置、文本提供程序注册表、MCP 模块、扩展指南。
- 子代理 —
subagents.run、运行程序、协议、工具组、新角色。 - Tauri IPC — 命令注册、包装器、命令组、**HeartBeat / 内存索引器 / MCP / 看板 / Mermaid / 通知 / 应用程序日志 ** 命令。
- SSH 远程传输 — 包裹
ssh终端、持久执行通道、fs/git 远程路由、秘密、恢复、拆卸、russh 后续。 - 语音架构 — STT/TTS 模块和流程。
- 国际化 — 语言环境、EULA 内容、翻译工作流程。
- 主题 — 令牌、
ThemeService、添加主题、lint 规则。 - 贡献 — 代码风格、规则、测试、拉取请求清单。
项目原则
BLXCode 是本地优先的桌面工作台。工作区、终端、内存、计划、任务和代理上下文紧密结合在一起，而无需隐藏数据在磁盘上的存储位置。当行为发生变化时，更新代码旁边的文档，以便用户和贡献者可以继续前进，而无需对应用程序进行逆向工程。
发行说明
每个版本的面向用户的注释位于 docs/releases/ 中（例如 v0.5.0.md）。预发行也使用其确切的标签文件名，例如v0.5.1-pre.ed4dc.md。它们在更新后为应用内新增功能对话框提供支持，并且应该保持非技术性。技术变更日志保留在存储库根目录的 CHANGELOG.md 中。