Was macht skillit?
Generiere KI-Agenten-Fähigkeiten (SKILL.md) aus TypeScript-API-Dokumentationen – TypeDoc Plugin + CLI + Docusaurus/VitePress
Überblick
pradeepmouli/skillit automatisiert die Erstellung von SKILL.md-Dateien für KI-Agenten (z. B. Claude Code, Cursor, Codex).
Es analysiert TypeScript-Quellcode und JSDoc-Kommentare und generiert eine strukturierte Beschreibung, die dem Agenten mitteilt, wie er mit deiner API interagieren soll.
Funktionen
- TypeDoc Plugin: Integriert sich direkt in den TypeDoc-Dokumentationsgenerator.
- CLI: Befehlszeilenwerkzeug zur schnellen Generierung aus vorhandenen Typdefinitionen.
- Framework-Integration: Funktioniert mit Docusaurus und VitePress.
- Automatische Erkennung: Liest Typen, Schnittstellen, Funktionen und deren Parameter aus TypeScript.
- Standardisiertes Format: Erzeugt SKILL.md gemäß den Anforderungen moderner KI-Agenten.
Installation
npm install -g pradeepmouli/skillit
# oder lokal im Projekt
npm install --save-dev pradeepmouli/skillit
Verwendung
Als TypeDoc Plugin
In deiner typedoc.json oder typedoc.config.js:
{
"plugin": ["pradeepmouli/skillit"],
"out": "./docs"
}
Führe dann einfach typedoc aus – das Plugin generiert automatisch die SKILL.md.
Über die CLI
skillit --input ./src --output ./docs
Optionen:
--input: Pfad zu den TypeScript-Dateien (kann auch ein glob-Muster sein).--output: Zielverzeichnis für die generierte Datei.--name: (Optional) Benutzerdefinierter Skill-Name.
Integration in Docusaurus / VitePress
Füge das Plugin zu deiner Build-Pipeline hinzu, z. B. in package.json:
{
"scripts": {
"docs": "skillit && docusaurus build"
}
}
Konfiguration
Du kannst eine .skillitrc-Datei im Projektstammverzeichnis anlegen:
{
"input": ["src/**/*.ts"],
"output": "./docs/skills",
"name": "MeineAPI",
"exclude": ["**/*.test.ts"]
}
Ausgabe
Das Tool erzeugt eine SKILL.md-Datei mit:
- Hauptbeschreibung: Extrahiert aus dem ersten JSDoc-Kommentar deiner Hauptdatei.
- API-Referenz: Aufgelistet mit Beispielen und Parametertabellen.
- Nutzungsrichtlinien: Generierte Hinweise, wie der Agent die API aufrufen soll.
Unterstützte Plattformen
- Claude Code
- Cursor
- Codex
- Weitere KI-Agenten, die SKILL.md interpretieren können.
Lizenz
MIT