CLI-Übersicht

Erstelle ein neues Dokumentationsprojekt.

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

Dies erstellt ein neues Projekt mit:

• Konfigurationsdatei docs.json
• Beispiel-MDX-Seiten
• Empfohlener Ordnerstruktur

Melde dich über deinen Browser bei Jamdesk an. Erforderlich vor dem Bereitstellen.

jamdesk login

Öffnet das Jamdesk-Dashboard in deinem Browser. Die CLI speichert Zugangsdaten in ~/.jamdeskrc.

Gespeicherte Zugangsdaten löschen.

jamdesk logout

Zeige den angemeldeten Benutzer an und überprüfe die Sitzung.

jamdesk whoami

Validiere deine docs.json-Konfiguration, MDX-Syntax und OpenAPI-Spezifikationen.

jamdesk validate
jamdesk validate --skip-mdx

Prüft auf:

• Gültige JSON-Syntax in docs.json
• Pflichtfelder (name, navigation)
• Gültige Theme-Werte
• MDX-Syntaxfehler (z. B. nicht maskierte <-Zeichen)
• OpenAPI-Spezifikationsvalidierung (falls konfiguriert)
• Schema-Konformität

Optionen:

Führe dies vor dem Bereitstellen aus, um Fehler frühzeitig zu erkennen.

Durchsuche deine Dokumentation nach defekten internen Links.

jamdesk broken-links

Beispielausgabe:

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

Found 1 broken link in 45 files.

Erkennt Links zu fehlenden Seiten und Tippfehler. Details findest du unter Links & Navigation.

Behebt automatisch Warnungen zu defekten internen Links, die ein eindeutiges Ziel haben. Es werden zwei Arten behoben:

• Fehlerhafte Anker: ein Fragment wie #instalation, das eindeutig #installation sein soll
• Anker-Abweichung zwischen Sprachen: Eine übersetzte Seite hat ihre Überschriften umbenannt, Links in dieser Sprachversion zeigen aber noch auf das alte englische Fragment

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

# Apply fixes (prompts for confirmation)
jamdesk fix

Beispielausgabe des Dry-Runs:

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 schreibt eine Korrektur nur, wenn der korrigierte Anker auf eine tatsächlich vorhandene Überschrift auf der Zielseite verweist. Mehrdeutige Fälle werden zur manuellen Prüfung belassen.

Optionen:

Zeige die Einstellung AI Fixes des Projekts an oder ändere sie. Dies ist dieselbe Einstellung wie in den Dashboard-Einstellungen.

# 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

Beispielausgabe:

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

Führe zuerst jamdesk login aus. Der Befehl verwendet die projectId in docs.json oder das Projekt, das du mit --project angibst. Benötigt CLI 1.1.229 oder neuer.

Prüfe deine Dokumentation auf Rechtschreibfehler.

jamdesk spellcheck

Beispielausgabe:

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.

Verwendet ein englisches Wörterbuch mit über 150 integrierten Fachbegriffen (API, GraphQL, Kubernetes, React usw.). Überspringt Codeblöcke, Inline-Code, Frontmatter, JSX, URLs und Dateipfade. Derzeit nur Englisch. Mehrsprachige Wörterbücher sind geplant.

Optionen:

Interaktiver Korrekturmodus (--fix) geht jedes eindeutige falsch geschriebene Wort durch:

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 ersetzt das Wort in jeder Datei durch einen Vorschlag. Codeblöcke oder JSX-Attribute werden niemals verändert. Die Abfrage zeigt bis zu 3 Vorschläge und markiert den besten Treffer als empfohlen.
• Ignore fügt das Wort zu spellcheck.ignore in deiner docs.json hinzu. Das Wort wird nicht mehr markiert.
• Skip tut in diesem Durchlauf nichts

Du siehst Änderungen in der Vorschau und bestätigst sie, bevor sie angewendet werden.

Eigene Ignorierliste: Füge projektspezifische Begriffe zu deiner docs.json hinzu:

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

Spellcheck ignoriert den Projektnamen aus docs.json.

Validiere eine einzelne OpenAPI-Spezifikationsdatei.

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

Validiert:

• Gültige YAML-/JSON-Syntax
• OpenAPI-3.x-Schemakonformität
• Endpunktdefinitionen
• Korrekte Auflösung von $ref-Referenzen

Benenne eine Seite um und aktualisiere alle Verweise darauf.

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

Dies wird:

• Die Datei umbenennen
• Die docs.json-Navigation aktualisieren
• Links in allen anderen MDX-Dateien aktualisieren
• Snippet-Verweise aktualisieren

Verwende dies statt manuellem Umbenennen. So bleiben Verweise synchron.

Migriere Dokumentation von Mintlify zu Jamdesk.

jamdesk migrate

Erkennt deine Mintlify-Konfiguration und konvertiert sie in das Jamdesk-Format. Derselbe Durchlauf:

• Benennt veraltete Komponenten um (z. B. CardGroup → Columns)
• Verschiebt verwaiste Snippet-MDX-Dateien nach /snippets/ und schreibt Importe mit relativen Elternpfaden um
• Extrahiert Inline-Komponenten, die React-Hooks verwenden, nach /snippets/<name>.tsx mit 'use client'
• Behebt mechanische MDX-Syntaxprobleme

Der Befehl ist idempotent. Ein erneutes Ausführen ist sicher.

Lade ein Projekt herunter, dessen Dokumentation Jamdesk hostet (ohne GitHub), als Git-Repository oder führe neue Jamdesk-Änderungen in eine bereits gezogene Kopie zusammen.

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

Bearbeite die Dateien und führe dann jamdesk deploy in diesem Ordner aus, um sie zu veröffentlichen. Benötigt CLI 1.1.227 oder neuer und Git.

Lade deine Dokumentation hoch und starte einen Build über das Terminal.

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

Die CLI zeigt jede Build-Phase an, sobald sie abgeschlossen ist. Auch verfügbar als jamdesk push.

Erstelle und deploye einen Cloudflare Worker, der /docs auf deiner eigenen Domain an deine Jamdesk-Website weiterleitet.

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

Der Befehl ist standardmäßig interaktiv. Er prüft Wrangler, verifiziert dein Cloudflare-Konto, erkennt deinen Slug aus docs.json, generiert die Worker-Dateien und bietet an, sie direkt zu deployen. --yes generiert die Dateien und stoppt dann. Deploye sie mit npx wrangler deploy aus dem Ausgabeverzeichnis.

Prüfe deine Umgebung und diagnostiziere Probleme.

jamdesk doctor

Prüft:

• Node.js-Version (erfordert 22.18+ oder 24.11+)
• Das Node.js, das in deinem PATH zuerst steht und von jamdesk dev verwendet wird
• npm-Version
• docs.json existiert und ist gültig
• Status des ~/.jamdesk-Caches
• Schreibberechtigungen

Führe dies aus, wenn die CLI sich falsch verhält.

Leere das Cache-Verzeichnis ~/.jamdesk.

jamdesk clean

Dies entfernt zwischengespeicherte Abhängigkeiten und Build-Artefakte. Verwende es, um:

• Speicherplatz freizugeben
• Einen beschädigten Cache zu beheben
• Eine frische Installation der Abhängigkeiten zu erzwingen

Der nächste jamdesk dev-Aufruf installiert die Abhängigkeiten neu.

Aktualisiere die CLI auf die neueste Version.

jamdesk update

Du kannst auch manuell aktualisieren:

npm update -g jamdesk