project-llm-wiki は何をしますか?
リポジトリローカルなMarkdown知識レイヤーとCodexスキルにより、LLMプロジェクトコンテキストを永続的に保持します。
概要
このスキルは、LLMエージェント(Codexなど)がプロジェクトの知識をチャットセッション間で維持できるようにします。プロジェクトルートの .project-llm-wiki/ ディレクトリにMarkdownファイルとして知識を保存し、エージェントが次回以降のセッションでその情報を読み込むことで、コンテキストの再構築を不要にします。
機能
- 永続的な知識ベース: プロジェクト固有の情報(設計判断、API仕様、依存関係など)をMarkdownで保存。
- Codexとの統合: Codex CLIエージェントとシームレスに連携し、自動的に知識を読み書きします。
- 軽量でポータブル: すべてのデータはリポジトリ内にMarkdown形式で格納されるため、バージョン管理が可能で、他の開発者と共有できます。
セットアップ
- プロジェクトルートに
.project-llm-wiki/ディレクトリを作成します。 - 初期知識ファイル(例:
architecture.md,decisions.md)をこのディレクトリに追加します。 - Codexエージェントがこのディレクトリを認識するよう設定します(詳細は各エージェントのドキュメントを参照)。
使用方法
Codexエージェントがプロジェクトコンテキストを必要とする場合、.project-llm-wiki/ 内のファイルを読み込むよう指示します。例えば:
Read the knowledge base from .project-llm-wiki/ and use it to answer the following question.
エージェントは、新しい知識を同ディレクトリ内の適切なMarkdownファイルに書き込むこともできます。
ファイル構造の例
.project-llm-wiki/
├── architecture.md
├── decisions.md
├── api-specs/
│ ├── user-service.md
│ └── payment-service.md
└── glossary.md
注意事項
- このスキルはMarkdownファイルのみを扱います。コード自体は対象外です。
- 機密情報をリポジトリにコミットする前に、適切なアクセス制御とレビューを行ってください。
- 各LLMエージェントの実装によっては、カスタムプロンプトや設定が必要な場合があります。
ライセンス
MIT