init-claude-md について
コードベースを調査し、簡潔で正確な CLAUDE.md を作成するためのスキルです。技術スタック、コマンド、主要ファイル、プロジェクト固有の注意点を確認します。
主な機能
- 01プロジェクト構成とマニフェストの確認
- 02フレームワークと依存関係の特定
- 03開発コマンドと要件の検証
- 04重要ファイルとエントリーポイントの整理
- 05規約とよくある注意点の記録
活用シーン
- 01未知のリポジトリについて Claude に事前情報を与える
- 02検証済みのローカル開発コマンドを記録する
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ tushaarmehtaa/ tushar-skills --skill init-claude-mdインストール後、Claude Code で/init-claude-mdを入力して読み込まれたか確認します。
詳細
プロジェクトを読み込みます。最初のメッセージから Claude が正確なコンテキストを把握できるよう、CLAUDE.md を作成します。
手順
1. プロジェクトを読み込む
ls -la
cat package.json 2>/dev/null
cat README.md 2>/dev/null | head -60
cat .env.example 2>/dev/null
ls src/ app/ lib/ backend/ frontend/ api/ 2>/dev/null
以下を特定します:言語、フレームワーク、エントリーポイント、プロジェクトの種類(ウェブアプリ、API、CLI、ライブラリ、モバイルアプリ)。
2. スタックを確認する
依存関係マニフェストを読み込みます:
package.json— Node/React/Next.js。メジャーバージョンを記録します。Next.js 15 と 14 の違いは互換性に影響します。Cargo.toml— Rustrequirements.txt/pyproject.toml— Pythongo.mod— Gosrc-tauri/— Tauri(Rust + ウェブフロントエンド)
フレームワーク、ORM/データベースクライアント、認証プロバイダー、主要な外部サービスを一覧にします。
3. コマンドを確認する
npm run dev と決めつけないでください。package.json のスクリプト、Makefile、justfile、または README を確認します:
cat package.json | grep -A 20 '"scripts"'
cat Makefile 2>/dev/null | grep "^[a-z]"
各コマンドについて、想定されるポート、必要な環境変数、venv や特定のランタイムバージョンが必要かどうかを記録します。
4. 主要なファイルを整理する
ディレクトリ構造を確認します。以下を記録します:
- メインのエントリーポイント
- 中核となるビジネスロジック
- 動作を変える設定ファイル(認証設定、DB スキーマ、課金)
- 壊れやすいファイル(マイグレーション、ウェブフック、決済ハンドラー)
- 見つけにくい場所(例:Tauri バックエンドの
src-tauri/src/lib.rs)
5. 注意点を探す
以下を確認します:
// DO NOT MODIFY、// IMPORTANT、// WARNINGなどのコメント- 標準とは異なる規約や、このプロジェクト固有のパターン
- モノレポまたは複数パッケージの構成
- ローカルでの実行に API キーが必要な外部サービス
- 既知の問題、TODO、WIP ブランチ
6. CLAUDE.md を作成する
# Project Name
One sentence on what this is.
## Commands
\`\`\`bash
# dev (runs on port XXXX)
command here
# build
command here
# test
command here
\`\`\`
## Key Files
- `path/to/entry.ts` — what it does
- `path/to/config.ts` — what it controls
## Stack
- Framework + version
- Database + ORM
- Auth provider
- Key external services
## Gotchas
- Non-obvious things that would trip someone up
- What not to touch without reading X first
- Any invariants the code depends on
60 行以内に収めます。当てはまらないセクションは省略します。長く冗長な CLAUDE.md より、短く正確なものが常に優れています。
コメント
Markdown 対応