pradeepmouli/to-skills

to-skills は何をしますか？

TypeScript APIドキュメントからAIエージェントスキル（SKILL.md）を生成する — TypeDocプラグイン + CLI + Docusaurus/VitePress

概要

pradeepmouli/to-skills は、TypeScriptプロジェクトのTypeDocドキュメントからAIエージェント（Claude Code、Cursor、Codexなど）で利用可能なスキルファイル（SKILL.md）を自動生成するためのツールです。

主な機能

• TypeDocプラグイン: TypeDocの出力から自動的に SKILL.md を生成します
• CLIツール: コマンドラインから独立してスキルファイルを生成できます
• ドキュメンテーションフレームワーク統合: DocusaurusやVitePressとシームレスに連携します
• カスタマイズ可能なテンプレート: 生成されるスキルファイルの内容を制御できます

インストール

npm install @pradeepmouli/to-skills
# または
yarn add @pradeepmouli/to-skills

使用方法

TypeDocプラグインとして

typedoc.json に以下の設定を追加します：

{
  "plugin": ["@pradeepmouli/to-skills"],
  "toSkills": {
    "output": "./SKILL.md",
    "include": ["src/**/*.ts"],
    "exclude": ["**/*.test.ts"]
  }
}

CLIとして

npx to-skills --input ./docs --output ./SKILL.md

Docusaurus / VitePressとの統合

プラグイン設定で出力先をドキュメントディレクトリに指定するだけで、自動的にスキルファイルが生成されます。

設定オプション

オプション	型	説明
output	string	生成される SKILL.md の出力パス
include	string[]	対象とするファイルのグロブパターン
exclude	string[]	除外するファイルのグロブパターン
template	string	カスタムテンプレートファイルへのパス

開発者向け情報

このツールは、TypeScriptの型情報とドキュメントコメントを解析し、AIエージェントが理解しやすい形式でスキルを定義します。生成される SKILL.md は、対応するAPIの使用方法、例、および重要な注意事項を含みます。

ライセンス

MIT