Présentation de la CLI

Créez un nouveau projet de documentation.

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

Cela crée un nouveau projet avec :

• Un fichier de configuration docs.json
• Des pages MDX exemples
• 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.

Effacez les identifiants stockés.

jamdesk logout

Affichez l'utilisateur authentifié actuel et vérifiez que votre session est valide.

jamdesk whoami

Validez votre configuration 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 (ex. : caractères < non échappés)
• Validation des spécifications OpenAPI (si configuré)
• Conformité au schéma

Options :

Exécutez ceci avant de déployer pour détecter les erreurs tôt.

Analysez 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érifiez l'orthographe dans 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.) 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 en anglais uniquement — la prise en charge de dictionnaires multilingues est prévue.

Options :

Mode de correction interactive (--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 (sûr pour la prose — ne modifie pas 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 au projet dans votre docs.json :

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

Le nom de votre projet dans docs.json est automatiquement ignoré.

Validez 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

Renommez une page et mettez 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 aux extraits

Utilisez cette commande plutôt que le renommage manuel pour maintenir toutes les références synchronisées.

Migrez la documentation de Mintlify vers Jamdesk.

jamdesk migrate

L'assistant interactif détecte votre configuration Mintlify et la convertit au format Jamdesk, y compris la structure de navigation et la syntaxe des composants.

Téléversez votre documentation et déclenchez 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 de build se termine. Également disponible sous jamdesk push.

Vérifiez votre environnement et diagnostiquez les problèmes.

jamdesk doctor

Vérifie :

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

Exécutez ceci si vous rencontrez des problèmes avec la CLI.

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

jamdesk clean

Cela supprime les dépendances 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 au prochain jamdesk dev.

Mettez à jour la CLI vers la dernière version.

jamdesk update

Vous pouvez également mettre à jour manuellement :

npm update -g jamdesk