Aperçu du CLI

Crée un nouveau projet de documentation.

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

Cette commande crée un nouveau projet avec :

• Le fichier de configuration docs.json
• Des pages MDX d'exemple
• Une 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 votre configuration docs.json, la syntaxe MDX et les spécifications OpenAPI.

jamdesk validate
jamdesk validate --skip-mdx

Vérifications effectuées :

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

Options :

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

Analyse votre documentation à la recherche de liens internes brisés.

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. Voir Liens et navigation pour plus de détails.

Vérifie l'orthographe de votre documentation.

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.) pour éviter les faux positifs sur le jargon courant. Ignore les blocs de code, le code en ligne, le frontmatter, les balises JSX, les URL et les chemins de fichiers. Actuellement en anglais uniquement — la prise en charge de dictionnaires multilingues est prévue.

Options :

Mode de correction interactive (--fix) : traite 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 modifier 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 pour 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 tiré de docs.json est automatiquement ignoré.

Valide un fichier de spécification OpenAPI unique.

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

Validations effectuées :

• 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

Cette commande effectue les actions suivantes :

• 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 aux extraits

Utilisez cette commande plutôt qu'un renommage manuel pour maintenir 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. En une seule passe, renomme les composants dépréciés (ex. : CardGroup → Columns), déplace les fichiers MDX d'extraits orphelins dans /snippets/ et réécrit les imports relatifs au parent, extrait les composants en ligne utilisant des hooks React dans /snippets/<name>.tsx avec 'use client', et corrige automatiquement les problèmes mécaniques de syntaxe MDX. Idempotente — réexécutez-la sans risque.

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 temps réel à mesure que chaque phase du build se termine. Également disponible sous la forme jamdesk push.

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

jamdesk doctor

Vérifications :

• Version de Node.js (requiert v20+)
• Version de npm
• Existence et validité du fichier docs.json
• État du cache ~/.jamdesk
• Permissions d'écriture

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

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

jamdesk clean

Cette commande supprime les dépendances en cache et les artefacts de build. Utilisez-la pour :

• Libérer de l'espace disque
• Corriger 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 mettre à jour manuellement :

npm update -g jamdesk