Vue d'ensemble du CLI

Crée un nouveau projet de documentation.

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

Cela crée un nouveau projet avec :

• Fichier de configuration docs.json
• Exemples de pages MDX
• Structure de dossiers recommandée

Connectez-vous à Jamdesk via votre navigateur. Requis avant de déployer.

jamdesk login

Ouvre le dashboard Jamdesk dans votre navigateur pour l'authentification. Les identifiants sont stockés localement dans ~/.jamdeskrc.

Efface les identifiants stockés.

jamdesk logout

Affiche l'utilisateur actuellement authentifié et vérifie que votre session est valide.

jamdesk whoami

Valide la configuration de votre docs.json, la syntaxe MDX et les spécifications OpenAPI.

jamdesk validate
jamdesk validate --skip-mdx

Vérifie :

• Syntaxe JSON valide dans docs.json
• Champs requis (name, navigation)
• Valeurs de thème valides
• Erreurs de syntaxe MDX (par ex. caractères < non échappés)
• Validation des spécifications OpenAPI (si configuré)
• Conformité au schéma

Options :

Exécutez cette commande avant de déployer pour détecter les erreurs rapidement.

Analyse votre documentation à la recherche de liens internes rompus.

jamdesk broken-links

Exemple de sortie :

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

Found 1 broken link in 45 files.

Détecte les liens vers des pages manquantes et les fautes de frappe. Consultez Liens et navigation pour plus de détails.

Corrige automatiquement les avertissements de liens internes rompus dont la cible est sans ambiguïté. Gère deux catégories :

• Ancres mal orthographiées : un fragment comme #instalation qui devrait clairement être #installation
• Dérive d'ancre entre locales : une page traduite a renommé ses titres, mais les liens de cette locale pointent toujours vers l'ancien fragment anglais

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

# Apply fixes (prompts for confirmation)
jamdesk fix

Exemple de sortie en mode dry-run :

Planned fixes:

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

(dry run — no files written)

Une correction n'est écrite que lorsque l'ancre corrigée correspond à un titre réel dans la page cible. Les cas ambigus sont laissés pour une révision manuelle.

Options :

Vérifie votre documentation à la recherche de fautes d'orthographe.

jamdesk spellcheck

Exemple de sortie :

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.

Utilise un dictionnaire anglais avec plus de 150 termes techniques intégrés (API, GraphQL, Kubernetes, React, etc.) afin que le jargon courant ne soit pas signalé. Ignore les blocs de code, le code en ligne, le frontmatter, le JSX, les URL et les chemins de fichiers. Actuellement disponible en anglais uniquement ; la prise en charge multilingue du dictionnaire est prévue.

Options :

Le mode de correction interactif (--fix) parcourt chaque mot mal orthographié unique :

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 remplace le mot par une suggestion dans tous les fichiers (sans risque pour le code, il ne modifie ni les blocs de code ni les attributs JSX). Jusqu'à 3 suggestions sont affichées, la meilleure correspondance étant marquée comme recommandée.
• Ignore ajoute le mot à spellcheck.ignore dans votre docs.json afin qu'il ne soit plus signalé
• Skip ne fait rien pour cette exécution

Les modifications sont prévisualisées et confirmées avant d'être appliquées.

Liste d'exclusion personnalisée : ajoutez des termes spécifiques à votre projet dans votre docs.json :

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

Le nom de votre projet issu de docs.json est automatiquement exclu.

Valide un seul fichier de spécification OpenAPI.

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

Valide :

• Syntaxe YAML/JSON valide
• Conformité au schéma OpenAPI 3.x
• Définitions des endpoints
• Les références $ref se résolvent correctement

Renomme une page et met automatiquement à jour toutes les références.

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

Cela va :

• Renommer le fichier
• Mettre à jour la navigation dans docs.json
• Mettre à jour les liens dans tous les autres fichiers MDX
• Mettre à jour les références de snippet

Utilisez cette commande plutôt qu'un renommage manuel pour garder toutes les références synchronisées.

Migre la documentation de Mintlify vers Jamdesk.

jamdesk migrate

Détecte votre configuration Mintlify et la convertit au format Jamdesk. Dans la même passe, elle renomme les composants dépréciés (par ex. CardGroup → Columns), déplace les fichiers MDX de snippet orphelins vers /snippets/ et réécrit les imports relatifs au parent, extrait les composants inline qui utilisent des hooks React vers /snippets/<name>.tsx avec 'use client', et corrige automatiquement les problèmes de syntaxe MDX mécaniques. Idempotente, vous pouvez donc la relancer en toute sécurité.

Téléverse votre documentation et déclenche un build directement depuis le terminal.

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

La progression s'affiche en direct à mesure que chaque phase du build se termine. Également disponible sous la forme jamdesk push.

Génère et déploie un Cloudflare Worker qui redirige /docs sur votre propre domaine vers votre site Jamdesk.

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

Interactif par défaut : vérifie Wrangler, valide votre compte Cloudflare, détecte automatiquement votre slug à partir de docs.json, génère les fichiers du Worker et effectue le déploiement si vous le souhaitez. Avec --yes, il génère les fichiers puis s'arrête — déployez avec npx wrangler deploy depuis le répertoire de sortie.

Vérifie votre environnement et diagnostique les problèmes.

jamdesk doctor

Vérifications :

• Version de Node.js (nécessite v20+)
• Version de npm
• docs.json existe et est valide
• État du cache ~/.jamdesk
• Autorisations d'écriture

Exécutez cette commande si vous rencontrez des problèmes avec le CLI.

Efface le répertoire de cache ~/.jamdesk.

jamdesk clean

Cela supprime les dépendances mises en cache et les artefacts de build. Utilisez-le pour :

• Libérer de l'espace disque
• Résoudre les problèmes de cache corrompu
• Forcer une nouvelle installation des dépendances

Les dépendances seront réinstallées lors du prochain jamdesk dev.

Met à jour le CLI vers la dernière version.

jamdesk update

Vous pouvez également effectuer la mise à jour manuellement :

npm update -g jamdesk