Vai al contenuto principale

Panoramica

I comandi della Knowledge Base (KB) ti permettono di gestire la documentazione wiki del tuo progetto direttamente dal terminale. Tutti i comandi KB sono limitati a un progetto tramite la flag -p/--project.
La Knowledge Base è una risorsa a livello di progetto. Ogni pagina appartiene a esattamente un progetto. Usa le Note Personali per contenuti privati con ambito utente.

Comandi

Elencare le Pagine

# 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
Opzioni:
FlagDescrizione
-p, --project <name>Nome o ID del progetto (obbligatorio)
--folder <name>Filtrare per nome cartella
--limit <n>Massimo risultati (predefinito: 50)

Visualizzare una Pagina

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

# By UUID
apollo kb view 550e8400-e29b-41d4-a716-446655440000
Mostra il contenuto completo della pagina, la cartella, il numero di versione e i metadati.

Cercare Pagine

Cerca pagine KB per titolo o contenuto all’interno di un progetto:
apollo kb search "authentication" -p "Apollo"
apollo kb search "API design" -p "Apollo" --limit 10
Usa corrispondenza di sottostringa senza distinzione tra maiuscole e minuscole nei campi titolo e contenuto.

Creare una Pagina

# 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"
Opzioni:
FlagDescrizione
-t, --title <title>Titolo della pagina (obbligatorio)
-p, --project <name>Nome o ID del progetto (obbligatorio)
--content <text>Contenuto della pagina (markdown)
--file <path>Leggere il contenuto da un file
--folder <name>Inserire in una cartella specifica

Aggiornare una Pagina

# 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"

Eliminare una Pagina

Eliminazione temporanea di una pagina (può essere ripristinata in seguito):
apollo kb delete "Old Draft"

Elencare le Cartelle

apollo kb folders -p "Apollo"
Mostra tutte le cartelle KB del progetto con le relazioni genitore-figlio.

Output 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

Esempi con 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