BLXコードのドキュメント

BLXCode ドキュメントへようこそ。ユーザー ガイドでは、アプリの実行方法と使用方法が説明されています。開発者ガイドでは、構築、拡張、貢献する方法について説明しています。

公開されたコピー: GitHub Wiki (docs/** にタッチする main へのプッシュ時にこのフォルダーから自動同期されます)。 Wiki Web UI ではなく、ここリポジトリでドキュメントを編集します。

ドキュメントマップ

ここから始めてください: はじめに → ワークスペース → Agent Harness

ユーザードキュメント

• はじめに — 前提条件、BLXCode の実行、最初のワークスペース、データが存在する場所、ようこそ画面のワークスペースの作成、エージェントごとのモデル/エフォート フリート。
• 設定 - ドッキングされたセンタータブの設定、API キー、BLXCode エージェント (テキスト/画像/音声)、MCP、ハートビート、メモリ、コード エディター (Vim)、ワークスペース、外観 / テーマ、ヘルプ/バージョン情報、アプリ ログ、通知。
• 外観とテーマ — テーマピッカー、プリセット、永続性、例外、フォント サイズ。
• ワークスペース — 作成、ターミナル グリッド、サイドバー エクスプローラー、ファイル差分 (ステージ/コミット/プッシュ)、Git グラフ (フェッチ/プル)、ハンドオフ、永続性、アプリ ステータス ライン、サイドバー コンテキスト ドラッグ アンド ドロップ (ファイル / フォルダー / 差分 / コミット)、フック インストール ダイアログ、名前付きターミナル。
• リモート (SSH) — 設定 → リモート接続プリセット (パスワード / キー / エージェント、暗号化されたシークレット)、リモート ワークスペースの作成、リモート ターミナル + ファイル/git + セッション再開 (tmux とキープアライブ)。
• ファイル プレビュー — 画像 (SVG を含む)、ビデオ、レンダリングされた Markdown、構文が強調表示されたソース コード、および人魚図の中央タブのプレビュー。 Vim モード @replit/codemirror-vim 経由。リポジトリ ポリシー ドキュメント (LICENSE、CONTRIBUTING、SECURITY、CHANGELOG など) は、.md 拡張子の有無にかかわらず、種類固有のヒーロー バナーを使用して Markdown としてレンダリングされます。
• メモリとタスク - メモリ パネル (ファイル、グラフ、検索)、アーキテクチャ マップ、動的カテゴリ、タスク、エージェント メモリ ツール、メモリ インデクサ (HeartBeat)、メモリ設定ペイン。
• プラン — .agents/plans/<slug>/plan.md、自動管理される PLANS.md インデックス、ワークスペース マルチカンバン、マーメイド ダイアグラム ギャラリー、タスク構文、プラン パネル、エージェント ツール。
• ルールとスキル — 拡張可能なルール/スキル カード、コア スキルとユーザー スキル、インストール ダイアログ。
• Agent Harness — コア スキル (MCP、プロンプト生成を含む)、スリム プロンプト、環境/シェル/git/web、Web API キー。
• サブエージェント — 並列実行、ロール、タイムライン、ツール グループ、制限。
• キーボード ショートカット — tmux プレフィックスと従来のコード、通知トースト、ワークスペースの作成、プッシュツートーク。
• イメージ モード - エージェント パネル、設定、制限、永続性からイメージを生成します。
• エージェント プロバイダー — OpenRouter、Anthropic、OpenAI 互換 + Ollama / LM Studio / Hugging Face / Cloudflare / Together / Portkey / カスタム、MCP サーバー、エージェント ニックネーム、オンボーディング、サイドバー コンテキストの種類。
• 音声 — STT、TTS、マイク、プッシュツートーク (ローカルウィスパー/クラウド)。
• [UI 言語](/ja-JP/docs/user/ language) — ロケール、言語ピッカー、EULA ローカリゼーション。
• Building — Linux、macOS、Windows リリース ビルド。
• トラブルシューティング — 起動、ビルド、ブラウザ、キーリング、端末の問題。

開発者向けドキュメント

• Setup — ローカル環境および検証コマンド。
• アーキテクチャ — フロントエンド/バックエンドの分割、エージェント、メモリ、プラン、ハンドオフ、ダイアグラム、HeartBeat、Memory Indexer、MCP、Kanban、Mermaid、Notifications*、App log、App status line、サイドバー コンテキストのドラッグ アンド ドロップ。
• Agent Harness — コア スキル (MCP、プロンプト生成を含む)、ツール ディスパッチ、Web 設定、テキスト プロバイダー レジストリ、MCP モジュール、拡張ガイド。
• サブエージェント — subagents.run、ランナー、プロトコル、ツール グループ、新しいロール。
• Tauri IPC — コマンド登録、ラッパー、コマンド グループ、HeartBeat / Memory Indexer / MCP / Kanban / Mermaid / Notices / App log コマンド。
• SSH リモート トランスポート - ラップされたssh ターミナル、永続的な実行チャネル、fs/git リモート ルーティング、シークレット、再開、ティアダウン、ラッシュ フォローアップ。
• 音声アーキテクチャ — STT/TTS モジュールとフロー。
• 国際化 — ロケール、EULA コンテンツ、翻訳ワークフロー。
• テーマ — トークン、ThemeService、テーマの追加、lint ルール。
• 寄稿 — コード スタイル、ルール、テスト、プル リクエスト チェックリスト。

プロジェクトの原則

BLXCode は、ローカルファーストのデスクトップ ワークベンチです。ワークスペース、端末、メモリ、プラン、タスク、エージェント コンテキストは、ディスク上のデータの存在場所を隠すことなく、近くに配置されます。動作が変更された場合は、コードの横にあるドキュメントを更新して、ユーザーと寄稿者がアプリのリバース エンジニアリングを行わずに先に進むことができるようにします。

リリースノート

各バージョンのユーザー向けメモは docs/releases/ にあります (例: v0.5.0.md)。プレリリースでは、v0.5.1-pre.ed4dc.md など、正確なタグ ファイル名も使用されます。これらは、更新後にアプリ内の 新機能 ダイアログを強化し、技術的なものではないままにする必要があります。技術的な変更ログは、リポジトリ ルートの CHANGELOG.md に残ります。