ai-ready は何をしますか?
リポジトリを分析し、AGENTS.md、copilot-instructions、スキル、CI、課題テンプレートなど、AI対応の設定を生成するCopilot CLIプラグインです。
概要
johnpapa/ai-readyは、GitHub CLI(gh)の拡張機能として動作し、リポジトリをスキャンしてAIエージェント(Copilot、Claude Code、Cursorなど)がプロジェクトを即座に理解し始められるように、以下のようなファイルを自動生成します:
AGENTS.md- AIエージェント向けのプロジェクト概要と指示.github/copilot-instructions.md- GitHub Copilot向けのカスタム指示- スキル定義ファイル(
.vscode/skills.jsonなど) - CI設定(
.github/workflows/) - Issue / PRテンプレート
インストール
gh extension install johnpapa/ai-ready
使い方
リポジトリのルートディレクトリで以下のコマンドを実行します:
gh ai-ready
すると、リポジトリの構造、使用言語、依存関係などを自動分析し、AI対応ファイルを生成します。
オプション
| オプション | 説明 |
|---|---|
--dry-run | 実際にファイルを作成せずに、生成される内容をプレビュー |
--force | 既存ファイルを上書き |
--output-dir <path> | 出力先ディレクトリを指定(デフォルト: カレントディレクトリ) |
生成されるファイル
AGENTS.md— AIエージェントがプロジェクトの全体像を把握するためのMarkdownドキュメント.github/copilot-instructions.md— GitHub Copilotへのコード補完時の指示.github/ISSUE_TEMPLATE/— 課題テンプレート.github/PULL_REQUEST_TEMPLATE.md— プルリクエストテンプレート- CIワークフローファイル
詳細
詳しくは公式リポジトリを参照してください。