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 中。