pradeepmouli/skillit

O que skillit faz?

Gere skills para agentes de IA (SKILL.md) a partir de documentação de API TypeScript — Plugin TypeDoc + CLI + Docusaurus/VitePress

Visão Geral

O skillit é uma ferramenta que transforma a documentação de APIs TypeScript (gerada pelo TypeDoc) em arquivos SKILL.md prontos para uso por agentes de IA como Claude Code, Cursor, Codex e outros. Ele pode ser usado como um plugin do TypeDoc ou como uma ferramenta de linha de comando independente.

Instalação

npm install -D @pradeepmouli/skillit

Uso

Como plugin do TypeDoc

Adicione o skillit ao seu arquivo de configuração do TypeDoc:

{
  "plugin": ["@pradeepmouli/skillit"],
  "skillit": {
    "output": "SKILL.md",
    "title": "Minha API TypeScript",
    "description": "Skill para agente de IA"
  }
}

Depois execute o TypeDoc normalmente:

typedoc --options typedoc.json

Como CLI

npx skillit --input docs/api --output SKILL.md

Integração com Docusaurus ou VitePress

Você pode configurar o skillit para gerar a skill diretamente na pasta de documentação do seu site:

npx skillit --input docs/api --output docusaurus/docs/SKILL.md
# ou
npx skillit --input docs/api --output vitepress/docs/SKILL.md

Opções

Opção	Tipo	Descrição
--input	string	Caminho para a documentação TypeDoc gerada
--output	string	Caminho do arquivo SKILL.md de saída
--title	string	Título do skill
--description	string	Descrição do skill

Exemplo de Saída

O SKILL.md gerado conterá seções como:

• Nome: Nome do skill baseado no título
• Descrição: Resumo da API documentada
• Funcionalidades: Lista de classes, métodos e funções disponíveis
• Exemplos: Código de exemplo extraído da documentação

Licença

MIT