Panoramica CLI

Crea un nuovo progetto di documentazione.

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

Questo crea un nuovo progetto con:

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

Accedi a Jamdesk tramite il browser. Necessario prima del deploy.

jamdesk login

Apre la dashboard di Jamdesk nel browser. La CLI salva le credenziali in ~/.jamdeskrc.

Elimina le credenziali salvate.

jamdesk logout

Mostra l'utente connesso e verifica la sessione.

jamdesk whoami

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

jamdesk validate
jamdesk validate --skip-mdx

Controlli:

• Sintassi JSON valida in docs.json
• Campi obbligatori (name, navigation)
• Valori di tema validi
• Errori di sintassi MDX (ad esempio caratteri < non escapati)
• Validazione della specifica OpenAPI (se configurata)
• Conformità allo schema

Opzioni:

Esegui questo comando prima del deploy per individuare subito gli errori.

Analizza la documentazione alla ricerca di link interni interrotti.

jamdesk broken-links

Esempio di output:

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

Found 1 broken link in 45 files.

Rileva link verso pagine mancanti ed errori di battitura. Consulta Link e navigazione per i dettagli.

Correggi automaticamente gli avvisi sui link interni interrotti che hanno un obiettivo univoco. Corregge due tipi di problemi:

• Ancore con errori di battitura: un frammento come #instalation che chiaramente dovrebbe essere #installation
• Deriva delle ancore tra lingue: una pagina tradotta ha rinominato i suoi 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

Esempio di output dell'anteprima:

Planned fixes:

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

(dry run — no files written)

jamdesk fix scrive una correzione solo quando l'ancora corretta corrisponde a un titolo reale nella pagina di destinazione. Lascia i casi ambigui per la revisione manuale.

Opzioni:

Mostra o modifica l'impostazione AI Fixes del progetto, la stessa presente nelle Impostazioni della dashboard.

# Show the current setting
jamdesk ai-fix

# Commit fixes to your build branch after each build
jamdesk ai-fix auto

# Suggest fixes for you to review in the dashboard
jamdesk ai-fix review

# Turn off dashboard scans
jamdesk ai-fix off

Esempio di output:

✓ AI Fixes set to Auto-fix
Jamdesk commits fixes to main after the next build. Pull before you push. Undo runs from the dashboard.

Esegui prima jamdesk login. Il comando usa il projectId in docs.json, oppure il progetto indicato con --project. Richiede CLI 1.1.229 o successiva.

Verifica la presenza di errori ortografici nella documentazione.

jamdesk spellcheck

Esempio di output:

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.). Salta blocchi di codice, codice inline, frontmatter, JSX, URL e percorsi dei file. Per ora solo inglese. I dizionari multilingua sono previsti.

Opzioni:

Modalità di correzione interattiva (--fix) scorre ogni parola unica con errore:

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

• Correggi sostituisce la parola con un suggerimento in ogni file. Non modifica mai blocchi di codice o attributi JSX. Il prompt mostra fino a 3 suggerimenti e contrassegna come consigliata la corrispondenza migliore.
• Ignora aggiunge la parola a spellcheck.ignore nel tuo docs.json. La parola non verrà più segnalata.
• Salta non fa nulla per questa esecuzione

Puoi visualizzare in anteprima e confermare le modifiche prima che vengano applicate.

Lista di parole da ignorare: aggiungi termini specifici del progetto al tuo docs.json:

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

Spellcheck ignora il nome del progetto presente in docs.json.

Valida un singolo file di specifica OpenAPI.

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

Valida:

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

Rinomina una pagina e aggiorna tutti i riferimenti ad essa.

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

Questo comando:

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

Usa questo comando invece di rinominare manualmente. I riferimenti restano sincronizzati.

Esegui la migrazione della documentazione da Mintlify a Jamdesk.

jamdesk migrate

Rileva la configurazione di Mintlify e la converte nel formato Jamdesk. La stessa operazione:

• Rinomina i componenti obsoleti (ad esempio CardGroup → Columns)
• Sposta i file snippet MDX orfani in /snippets/ e riscrive gli import relativi al genitore
• Estrae i componenti inline che usano React hooks in /snippets/<name>.tsx con 'use client'
• Corregge i problemi meccanici di sintassi MDX

Il comando è idempotente. Rieseguirlo è sicuro.

Scarica un progetto la cui documentazione è ospitata da Jamdesk (senza GitHub) come repository git, oppure unisci le nuove modifiche di Jamdesk in una copia già scaricata.

jamdesk pull
jamdesk pull --project your-project
jamdesk pull --dir ./docs-copy

Modifica i file, quindi esegui jamdesk deploy in quella cartella per pubblicarli. Richiede CLI 1.1.227 o successiva e git.

Carica la documentazione e avvia una build dal terminale.

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

La CLI mostra ogni fase della build man mano che viene completata. Disponibile anche come jamdesk push.

Genera e distribuisce un Cloudflare Worker che fa da proxy per /docs sul tuo dominio verso il tuo sito Jamdesk.

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

Il comando è interattivo per impostazione predefinita. Verifica Wrangler, controlla il tuo account Cloudflare, rileva lo slug da docs.json, genera i file del Worker e propone il deploy. --yes genera i file e si ferma. Distribuiscili con npx wrangler deploy dalla directory di output.

Verifica l'ambiente e diagnostica i problemi.

jamdesk doctor

Controlli:

• Versione di Node.js (richiede 22.18+ oppure 24.11+)
• Node.js che compare per primo nel PATH, quello usato da jamdesk dev
• Versione di npm
• Esistenza e validità di docs.json
• Stato della cache di ~/.jamdesk
• Permessi di scrittura

Esegui questo comando quando la CLI non si comporta correttamente.

Svuota la directory di cache ~/.jamdesk.

jamdesk clean

Rimuove dipendenze in cache e artefatti di build. Usalo per:

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

Il prossimo jamdesk dev reinstalla le dipendenze.

Aggiorna la CLI all'ultima versione.

jamdesk update

Puoi anche aggiornare manualmente:

npm update -g jamdesk