CLI-Übersicht

Erstellen Sie ein neues Dokumentationsprojekt.

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

Dadurch wird ein neues Projekt erstellt mit:

• Konfigurationsdatei docs.json
• Beispielseiten im MDX-Format
• Empfohlener Ordnerstruktur

Melden Sie sich über Ihren Browser bei Jamdesk an. Dies ist vor dem Bereitstellen erforderlich.

jamdesk login

Öffnet das Jamdesk-Dashboard zur Authentifizierung in Ihrem Browser. Anmeldedaten werden lokal in ~/.jamdeskrc gespeichert.

Gespeicherte Anmeldedaten löschen.

jamdesk logout

Den aktuell authentifizierten Benutzer anzeigen und überprüfen, ob Ihre Sitzung gültig ist.

jamdesk whoami

Validieren Sie Ihre docs.json-Konfiguration, die MDX-Syntax und OpenAPI-Spezifikationen.

jamdesk validate
jamdesk validate --skip-mdx

Prüft:

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

Optionen:

Führen Sie diesen Befehl vor dem Bereitstellen aus, um Fehler frühzeitig zu erkennen.

Scannen Sie Ihre Dokumentation nach fehlerhaften 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. Weitere Informationen finden Sie unter Links und Navigation.

Behebt Warnungen zu fehlerhaften internen Links automatisch, wenn das Ziel eindeutig ist. Behandelt zwei Kategorien:

• Tippfehler in Ankern: ein Fragment wie #instalation, das eindeutig #installation lauten sollte
• Ankerabweichung zwischen Locales: Eine übersetzte Seite hat ihre Überschriften umbenannt, aber Links in diesem Locale verweisen weiterhin 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 eines Probelaufs:

Planned fixes:

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

(dry run — no files written)

Eine Korrektur wird nur geschrieben, wenn der korrigierte Anker auf eine echte Überschrift in der Zielseite verweist. Uneindeutige Fälle bleiben zur manuellen Prüfung offen.

Optionen:

Prüfen Sie Ihre 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 mehr als 150 integrierten technischen Begriffen (API, GraphQL, Kubernetes, React usw.), damit gängiger Fachjargon nicht fälschlicherweise markiert wird. Überspringt Codeblöcke, Inline-Code, Frontmatter, JSX, URLs und Dateipfade. Derzeit nur auf Englisch verfügbar; Unterstützung für Wörterbücher in mehreren Sprachen ist geplant.

Optionen:

Der interaktive Korrekturmodus (--fix) führt durch jedes eindeutige falsch geschriebene Wort:

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

• Korrigieren ersetzt das Wort in allen Dateien durch einen Vorschlag (prosa-sicher, sodass weder Codeblöcke noch JSX-Attribute geändert werden). Es werden bis zu 3 Vorschläge angezeigt; die beste Übereinstimmung wird als empfohlen markiert.
• Ignorieren fügt das Wort zu spellcheck.ignore in Ihrer docs.json hinzu, damit es nicht erneut markiert wird
• Überspringen führt bei diesem Durchlauf keine Aktion aus

Änderungen werden vor der Anwendung in einer Vorschau angezeigt und bestätigt.

Benutzerdefinierte Ignorierliste: Fügen Sie projektspezifische Begriffe zu Ihrer docs.json hinzu:

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

Der Projektname aus docs.json wird automatisch ignoriert.

Validieren Sie eine einzelne OpenAPI-Spezifikationsdatei.

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

Validiert:

• Gültige YAML-/JSON-Syntax
• OpenAPI-3.x-Schema-Konformität
• Endpoint-Definitionen
• $ref-Referenzen werden korrekt aufgelöst

Benennen Sie eine Seite um und aktualisieren Sie automatisch alle Verweise.

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

Dabei wird Folgendes ausgeführt:

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

Verwenden Sie diesen Befehl statt einer manuellen Umbenennung, damit alle Verweise synchron bleiben.

Migrieren Sie Dokumentation von Mintlify zu Jamdesk.

jamdesk migrate

Erkennt Ihre Mintlify-Konfiguration und konvertiert sie in das Jamdesk-Format. Im selben Durchlauf werden veraltete Komponenten umbenannt (z. B. CardGroup → Columns), verwaiste MDX-Snippet-Dateien nach /snippets/ verschoben und elternrelative Imports umgeschrieben, Inline-Komponenten mit React-Hooks nach /snippets/<name>.tsx extrahiert und mit 'use client' versehen sowie mechanische MDX-Syntaxprobleme automatisch korrigiert. Der Vorgang ist idempotent und kann daher sicher erneut ausgeführt werden.

Laden Sie Ihre Dokumentation hoch und starten Sie direkt vom Terminal aus einen Build.

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

Der Fortschritt wird live angezeigt, sobald jede Build-Phase abgeschlossen ist. Auch als jamdesk push verfügbar.

Erstellen und stellen Sie einen Cloudflare Worker bereit, der /docs auf Ihrer eigenen Domain an Ihre Jamdesk-Website weiterleitet.

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

Standardmäßig interaktiv: Der Befehl prüft Wrangler, verifiziert Ihr Cloudflare-Konto, erkennt Ihren Slug automatisch aus docs.json, generiert die Worker-Dateien und stellt sie optional bereit. Mit --yes werden die Dateien generiert und der Vorgang beendet. Stellen Sie den Worker anschließend mit npx wrangler deploy aus dem Ausgabeverzeichnis bereit.

Überprüfen Sie Ihre Umgebung und diagnostizieren Sie Probleme.

jamdesk doctor

Prüft:

• Node.js-Version (erfordert v20+)
• npm-Version
• Ob docs.json vorhanden und gültig ist
• Status des ~/.jamdesk-Cache
• Schreibberechtigungen

Führen Sie diesen Befehl aus, wenn Probleme mit der CLI auftreten.

Löschen Sie das Cache-Verzeichnis ~/.jamdesk.

jamdesk clean

Dadurch werden zwischengespeicherte Abhängigkeiten und Build-Artefakte entfernt. Verwenden Sie den Befehl, um:

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

Abhängigkeiten werden beim nächsten jamdesk dev erneut installiert.

Aktualisieren Sie die CLI auf die neueste Version.

jamdesk update

Sie können auch manuell aktualisieren:

npm update -g jamdesk