skillit は何をしますか？
TypeScript APIドキュメントからAIエージェントスキル（SKILL.md）を生成 — TypeDocプラグイン + CLI + Docusaurus/VitePress対応
概要
このツールは、TypeScriptプロジェクトの型情報やAPIドキュメントを解析し、AIエージェント（Claude Code、Cursor、Codexなど）が読み込んで利用できるSKILL.mdファイルを自動生成します。TypeDocプラグインおよびCLIとして動作し、DocusaurusやVitePressといった静的サイトジェネレーターとの統合も可能です。
インストール
npm install -D pradeepmouli/skillit
# または
yarn add -D pradeepmouli/skillit
使用方法
TypeDocプラグインとして
typedoc.jsonに以下の設定を追加します：
{
"plugin": ["pradeepmouli/skillit"],
"skillit": {
"output": "SKILL.md",
"includePrivate": false,
"includeProtected": false
}
}
CLIとして
npx skillit --entry ./src/index.ts --output SKILL.md
オプション
| オプション | デフォルト値 | 説明 |
|---|---|---|
--entry | src/index.ts | 解析するエントリーポイントファイル |
--output | SKILL.md | 出力ファイル名 |
--includePrivate | false | privateメンバーを含めるか |
--includeProtected | false | protectedメンバーを含めるか |
Docusaurus/VitePressとの統合
生成されたSKILL.mdは、DocusaurusやVitePressのドキュメントディレクトリに配置することで、サイト上でも確認できます。また、ビルド時に自動生成するスクリプトをpackage.jsonに追加することを推奨します：
{
"scripts": {
"docs:skill": "skillit --entry ./src/index.ts --output ./docs/SKILL.md",
"docs:build": "npm run docs:skill && docusaurus build"
}
}
出力例
生成されるSKILL.mdは以下のような構造になります：
- プロジェクト名と説明
- 主要なAPI関数/クラスの一覧
- 各APIのシグネチャ、型情報、使用例
- AIエージェント向けの補足情報（制約、依存関係など）
注意事項
- このツールは
typedocv0.25以上が必要です。 - 出力されるSKILL.mdはAIエージェントが理解しやすいようMarkdown形式で整形されます。
- プライベートメンバーはデフォルトで除外されますが、
--includePrivateで含めることができます。
ライセンス
MIT