repoforge は何をしますか?
あらゆるコードベースから技術ドキュメントとAIエージェントスキル(SKILL.md、AGENT.md)を生成します。モデルに依存せず、モノレポにも対応。
概要
Repoforgeは、コードベースを解析し、AIエージェント(Claude Code、Cursor、Codexなど)向けの構造化されたドキュメントを自動生成するツールです。このスキルを利用することで、プロジェクトのセットアップ、主要なコマンド、アーキテクチャ、コーディング規約などをAIエージェントが認識しやすくなります。
主な機能
- コードベース解析: プロジェクトのファイル構造、依存関係、設定ファイルなどを自動的に解析します。
- ドキュメント生成: 解析結果に基づいて、SKILL.md(エージェント向けスキル定義)とAGENT.md(エージェントへの指示)を生成します。
- モデル非依存: 特定のAIモデルに依存しないため、Claude、GPT、Cursorなど様々なエージェントで利用可能です。
- モノレポ対応: モノレポ構成のプロジェクトでも、各パッケージやサービスごとに独立したドキュメントを生成できます。
使い方
# 現在のディレクトリのコードベースからドキュメントを生成
npx repoforge
# 特定のディレクトリを指定
npx repoforge --path /path/to/project
# 詳細オプションを表示
npx repoforge --help
生成されるファイル
SKILL.md: AIエージェントがこのスキルを利用するための定義ファイル。プロジェクトの概要、セットアップ手順、主要なコマンド、コーディング規約などが含まれます。AGENT.md: AIエージェントへの具体的な指示やコンテキストを記述したファイル。プロジェクトのアーキテクチャや設計思想など、より詳細な情報を提供します。
設定
Repoforgeはプロジェクトルートの repoforge.config.json または repoforge.config.js で設定をカスタマイズできます。
| オプション | 型 | デフォルト値 | 説明 |
|---|---|---|---|
outputDir | string | ./ | 生成ファイルの出力先ディレクトリ |
excludePatterns | string[] | ["node_modules", "dist"] | 除外するファイル/ディレクトリのパターン |
includePatterns | string[] | ["**/*.ts", "**/*.js", "**/*.py"] | 解析対象とするファイルのパターン |
環境変数
REPOFORGE_DEBUG: デバッグモードを有効にする(trueに設定)
注意事項
- 生成されたドキュメントは、プロジェクトの実際の状態を完全に反映していない場合があります。必ず確認の上で使用してください。
- 大規模なプロジェクトの場合、解析に時間がかかることがあります。