付録 C · 公式ドキュメント索引

全文字数約 1,710 字所要時間約 5 分難易度参照用

dsh 公式リポジトリのドキュメントは、すべて GitHub リポジトリの docs/ ディレクトリと各パッケージの README にあります。用途別に分類してあり、トピックを深入りしたいときは直接ジャンプしてください。

コアドキュメント

ドキュメント	内容	読むタイミング
README	プロジェクト概要、設計理念、クイックスタート、四つのランタイムモード	初めて触れて、全体像を素早く把握したいとき
architecture.md	全体アーキテクチャ設計：Cordis プラグインフレームワーク、プラグインネットワーク、Profile、Bundle、階層化された設定ロード順	「Everything is a plugin」がどう実現されているかを理解したいとき
ルート AGENTS.md	リポジトリ構造、各パッケージのディレクトリ構成、開発環境のセットアップ	ソースコードを読んだり、公式リポジトリに PR を投げたいとき
docs/AGENTS.md	ドキュメント開発マニュアル：各種ドキュメントに何を書くべきか／書いてはいけないか、階層化の基準	公式ドキュメントに PR を投げたい、またはドキュメント構成の規約を学びたいとき

公式チームでは各コアサブシステムごとにドキュメントを書いており、合計 40 本以上あります。各ドキュメントはそのサブシステムが何か、どんなデータ構造を流すか、どんな ctx サービスとイベントを提供するかを説明します。すべて docs/subsystems/ ディレクトリにあります。

サブシステム	解説内容
session	セッション管理：作成、復元、Fork、永続化、イベントストリーム
agent-loop	Agent Loop：考える → ツールを呼ぶ → 結果をみる反復メカニズム
tools	ツール登録、Schema、実行パイプライン、承認、サンドボックス
llm	モデルアダプタ、Provider、リクエスト／レスポンス、キャッシュ
skills	Skill 発見、ロード、呼び出しメカニズム
subagent	サブエージェントのスケジューリング、二つのモード（spawn / fork）、結果マージ
workflow	ワークフローオーケストレーション、複数ステップの連鎖
sandbox	ファイルサンドボックス、三段階の権限、承認フロー
trajectory	軌跡の記録、再生、エクスポート
credentials	認証情報管理、書き込み専用ストレージ、マスク処理
mcp	MCP クライアント、サーバー接続、ツールブリッジ
compaction	コンテキスト圧縮、トリガータイミング、要約生成

サブシステムドキュメントはアルファベット順で並んでいるため、メカニズムを深入りしたいときは対応するファイルを直接探してください。

公式のステップバイステップのハンズオンチュートリアルは docs/cookbook/ ディレクトリにあります。

チュートリアル	教える内容
Add a package	dsh に新しい npm 依存を追加する方法
Add a tool	カスタムツールを書いて Agent に登録する方法
Add an LLM adapter	新しいモデルプロバイダーを接続する方法
Extend plugin forms	クライアントプラグイン、UI プラグイン、Bundle の書き方
Custom Profile	全く新しいプロファイル構成を作成する方法

Cookbook は「手順どおりにやれば動く」チュートリアルで、サブシステムドキュメントよりも実作業寄りです。

apps/cli/reference/README.md — dsh コマンドラインの完全な挙動リファレンスで、引数解析、プロファイル起動フロー、各サブコマンドの正確な挙動を含みます。スクリプト作成や切り分けのときに参照してください。

リポジトリは monorepo 構成で、packages/ 配下に 49 のグループがあり、それぞれに README があります。よく使うもの：