Saltar para o conteúdo principal

Visão Geral

Os comandos da Base de Conhecimento (KB) permitem gerenciar a documentação wiki do seu projeto diretamente pelo terminal. Todos os comandos da KB são delimitados a um projeto pela flag -p/--project.
A Base de Conhecimento é um recurso no nível do projeto. Cada página pertence a exatamente um projeto. Use Notas Pessoais para conteúdo privado e com escopo de usuário.

Comandos

Listar Páginas

# All pages in a project
apollo kb list -p "Apollo"

# Filter by folder
apollo kb list -p "Apollo" --folder "Architecture"

# Limit results
apollo kb list -p "Apollo" --limit 20
Opções:
FlagDescrição
-p, --project <name>Nome ou ID do projeto (obrigatório)
--folder <name>Filtrar por nome da pasta
--limit <n>Máximo de resultados (padrão: 50)

Visualizar uma Página

# By title (fuzzy match)
apollo kb view "deployment guide"

# By UUID
apollo kb view 550e8400-e29b-41d4-a716-446655440000
Mostra o conteúdo completo da página, pasta, número da versão e metadados.

Pesquisar Páginas

Pesquise páginas da KB por título ou conteúdo dentro de um projeto:
apollo kb search "authentication" -p "Apollo"
apollo kb search "API design" -p "Apollo" --limit 10
Usa correspondência de substring sem diferenciar maiúsculas e minúsculas nos campos de título e conteúdo.

Criar uma Página

# With inline content
apollo kb create -t "Deployment Guide" -p "Apollo" --content "## Steps\n1. Build\n2. Deploy"

# From a file
apollo kb create -t "API Reference" -p "Apollo" --file ./api-docs.md

# In a specific folder
apollo kb create -t "Auth Flow" -p "Apollo" --content "..." --folder "Architecture"
Opções:
FlagDescrição
-t, --title <title>Título da página (obrigatório)
-p, --project <name>Nome ou ID do projeto (obrigatório)
--content <text>Conteúdo da página (markdown)
--file <path>Ler conteúdo de um arquivo
--folder <name>Colocar em uma pasta específica

Atualizar uma Página

# Update content
apollo kb update "Deployment Guide" --content "Updated deployment steps..."

# Update from file
apollo kb update "API Reference" --file ./api-docs-v2.md

# Move to a different folder
apollo kb update "Auth Flow" --folder "Security"

# Rename
apollo kb update "Deployment Guide" -t "Production Deployment Guide"

Excluir uma Página

Exclusão temporária de uma página (pode ser restaurada depois):
apollo kb delete "Old Draft"

Listar Pastas

apollo kb folders -p "Apollo"
Mostra todas as pastas da KB do projeto com relações de hierarquia pai-filho.

Saída JSON

# List as JSON
apollo kb list -p "Apollo" --json

# Search as JSON
apollo kb search "auth" -p "Apollo" --json

# View as JSON (full content)
apollo kb view "Deployment Guide" --json

Exemplos com Piping

# Get all page titles
apollo kb list -p "Apollo" --json | jq '.[].title'

# Export a page to a file
apollo kb view "API Reference" --json | jq -r '.content' > api-reference.md