Skip to content

Skill OKF — Instalar e Usar

Skill pra agentes de código (Claude, Codex, Cursor, Kiro, Windsurf) que ensina a criar, validar e enriquecer bundles OKF.

Instalar

Claude Code / Kiro CLI

# Adicionar ao projeto
npx skills add fabricioctelles/skills/okf-open-knowledge-format

Ou na mão — clone e referencie:

git clone https://github.com/fabricioctelles/skills.git ~/.skills

Depois adicione no .claude/settings.json ou AGENTS.md:

{
  "skills": ["~/.skills/skills/okf-open-knowledge-format/SKILL.md"]
}

Cursor / Windsurf

Jogue nas rules do projeto:

Read and follow: https://raw.githubusercontent.com/fabricioctelles/skills/main/skills/okf-open-knowledge-format/SKILL.md

Referência direta (qualquer agente)

Aponte seu agente para a URL raw:

https://raw.githubusercontent.com/fabricioctelles/skills/main/skills/okf-open-knowledge-format/SKILL.md

O Que a Skill Faz

CapacidadeO que rola
CriarGera bundles OKF conformantes do zero
ValidarCheca as 3 regras de conformidade, reporta erros e warnings
EnriquecerAdiciona schema, citations, cross-links, preenche campos recomendados
GerarCria index.md e log.md automaticamente
ConverterTransforma exports Notion, vaults Obsidian ou CSVs em OKF

Exemplos de Uso

Criar um bundle

"Crie um bundle OKF documentando nossos endpoints de API: /users, /orders, /payments"

O agente gera diretório completo com concept docs, cross-links e index.

Validar docs existentes

"Valide essa pasta contra a spec OKF"

Checa as 3 regras e reporta pass/fail por arquivo.

Converter do Obsidian

"Converta meu vault Obsidian em ./knowledge/ para formato OKF"

Converte wikilinks pra links padrão, garante type em todo frontmatter, gera index/log.


Recursos Incluídos

A skill carrega material de referência sob demanda:

ArquivoO que tem
references/spec-v01.mdSpec OKF v0.1 completa (451 linhas)
references/examples.md3 bundles de exemplo completos
references/conversion.mdGuias de conversão (Notion, Obsidian, CSV)
scripts/validate.shScript bash validador (zero dependências)

O Script validate.sh

Dá pra rodar o validador direto também:

chmod +x scripts/validate.sh
./scripts/validate.sh ./meu-bundle/

Saída:

✅ Bundle is OKF v0.1 conformant
⚠️  2 warning(s)