Panoramica CLI

Crea un nuovo progetto di documentazione.

jamdesk init              # Interactive mode
jamdesk init my-docs      # Create in new directory

Crea un nuovo progetto con:

• File di configurazione docs.json
• Pagine MDX di esempio
• Struttura di cartelle consigliata

Accedi a Jamdesk tramite il browser. È obbligatorio prima del deploy.

jamdesk login

Apre la dashboard di Jamdesk nel browser per l'autenticazione. Le credenziali vengono salvate localmente in ~/.jamdeskrc.

Cancella le credenziali salvate.

jamdesk logout

Mostra l'utente autenticato corrente e verifica che la sessione sia valida.

jamdesk whoami

Valida la configurazione docs.json, la sintassi MDX e le specifiche OpenAPI.

jamdesk validate
jamdesk validate --skip-mdx

Verifica:

• Sintassi JSON valida in docs.json
• Campi obbligatori (name, navigation)
• Valori dei temi validi
• Errori di sintassi MDX (ad esempio caratteri < non sottoposti a escape)
• Validazione delle specifiche OpenAPI (se configurata)
• Conformità allo schema

Opzioni:

Esegui questo comando prima del deploy per rilevare tempestivamente gli errori.

Cerca link interni non funzionanti nella documentazione.

jamdesk broken-links

Output di esempio:

docs/getting-started.mdx:15 - /docs/quikstart
  Did you mean: /docs/quickstart

Found 1 broken link in 45 files.

Rileva i link a pagine mancanti e gli errori di battitura. Consulta Link e navigazione per maggiori dettagli.

Corregge automaticamente gli avvisi relativi a link interni non funzionanti quando la destinazione non è ambigua. Gestisce due categorie:

• Anchor con errori di battitura: un frammento come #instalation che dovrebbe chiaramente essere #installation
• Deriva degli anchor tra lingue: una pagina tradotta ha rinominato i titoli, ma i link in quella lingua puntano ancora al vecchio frammento inglese

# Preview what would change without touching any files
jamdesk fix --dry-run

# Apply fixes (prompts for confirmation)
jamdesk fix

Output di esempio dell'esecuzione a secco:

Planned fixes:

  fr/ai/overview.mdx:9
    /fr/ai/selectors#ai-strategies  →  /fr/ai/selectors#stratégies-ia

(dry run — no files written)

Una correzione viene scritta solo quando l'anchor corretto rimanda a un titolo esistente nella pagina di destinazione. I casi ambigui vengono lasciati alla revisione manuale.

Opzioni:

Verifica la presenza di errori ortografici nella documentazione.

jamdesk spellcheck

Output di esempio:

getting-started.mdx:14 - "recieve"
  └─ Did you mean: receive

Found 3 misspellings across 24 pages.
Tip: Run "jamdesk spellcheck --fix" to interactively fix or ignore words.

Usa un dizionario inglese con oltre 150 termini tecnici integrati (API, GraphQL, Kubernetes, React ecc.) per evitare che il gergo comune venga segnalato. Ignora blocchi di codice, codice inline, frontmatter, JSX, URL e percorsi di file. Attualmente supporta solo l'inglese; è previsto il supporto per dizionari multilingue.

Opzioni:

La modalità di correzione interattiva (--fix) esamina ogni parola errata distinta:

1/10  "recieve" — found in 3 files
      intro.mdx:14, setup.mdx:7, guide.mdx:22

? What do you want to do?
❯ Fix → receive (recommended)
  Fix → relieve
  Ignore in the future (add to docs.json)
  Skip

• Fix sostituisce la parola con un suggerimento in tutti i file (in modo sicuro per la prosa, senza modificare blocchi di codice o attributi JSX). Vengono mostrati fino a 3 suggerimenti; la corrispondenza migliore è contrassegnata come consigliata.
• Ignore aggiunge la parola a spellcheck.ignore in docs.json, così non verrà più segnalata
• Skip non esegue alcuna azione durante questa esecuzione

Le modifiche vengono visualizzate in anteprima e richiedono conferma prima dell'applicazione.

Elenco di esclusione personalizzato: aggiungi i termini specifici del progetto a docs.json:

{
  "spellcheck": {
    "ignore": ["YourProduct", "kubectl", "Terraform"]
  }
}

Il nome del progetto indicato in docs.json viene escluso automaticamente.

Valida un singolo file di specifica OpenAPI.

jamdesk openapi-check openapi.yaml
jamdesk openapi-check api/spec.json

Elementi validati:

• Sintassi YAML/JSON valida
• Conformità allo schema OpenAPI 3.x
• Definizioni degli endpoint
• Risoluzione corretta dei riferimenti $ref

Rinomina una pagina e aggiorna automaticamente tutti i riferimenti.

jamdesk rename docs/old-name.mdx docs/new-name.mdx

Questa operazione:

• Rinomina il file
• Aggiorna la navigazione di docs.json
• Aggiorna i link in tutti gli altri file MDX
• Aggiorna i riferimenti agli snippet

Usa questo comando invece di rinominare manualmente i file per mantenere sincronizzati tutti i riferimenti.

Migra la documentazione da Mintlify a Jamdesk.

jamdesk migrate

Rileva la configurazione Mintlify e la converte nel formato Jamdesk. Nello stesso passaggio rinomina i componenti deprecati (ad esempio CardGroup → Columns), sposta i file MDX di snippet orfani in /snippets/ e riscrive gli import relativi al percorso padre, estrae i componenti inline che usano gli hook React in /snippets/<name>.tsx con 'use client' e corregge automaticamente i problemi meccanici di sintassi MDX. L'operazione è idempotente, quindi puoi eseguirla nuovamente senza rischi.

Carica la documentazione e avvia una build direttamente dal terminale.

jamdesk deploy
jamdesk deploy --detach
jamdesk deploy --full-rebuild

L'avanzamento viene mostrato in tempo reale al completamento di ogni fase della build. Disponibile anche come jamdesk push.

Crea e distribuisce un Worker Cloudflare che inoltra /docs del tuo dominio al tuo sito Jamdesk.

jamdesk deploy-proxy cloudflare
jamdesk deploy-proxy cloudflare --slug myproject --domain example.com --yes

Per impostazione predefinita è interattivo: verifica Wrangler, controlla il tuo account Cloudflare, rileva automaticamente lo slug da docs.json, genera i file del Worker ed eventualmente esegue il deploy. Con --yes genera i file e si arresta: esegui il deploy con npx wrangler deploy dalla directory di output.

Controlla l'ambiente e diagnostica i problemi.

jamdesk doctor

Verifica:

• Versione di Node.js (richiede v20+)
• Versione di npm
• Esistenza e validità di docs.json
• Stato della cache ~/.jamdesk
• Permessi di scrittura

Esegui questo comando se riscontri problemi con la CLI.

Svuota la directory della cache ~/.jamdesk.

jamdesk clean

Rimuove le dipendenze memorizzate nella cache e gli artefatti di build. Usalo per:

• Liberare spazio su disco
• Risolvere problemi relativi a una cache danneggiata
• Forzare una nuova installazione delle dipendenze

Le dipendenze verranno reinstallate alla successiva esecuzione di jamdesk dev.

Aggiorna la CLI alla versione più recente.

jamdesk update

Puoi anche eseguire l'aggiornamento manualmente:

npm update -g jamdesk