Déploiement CLI

La commande deploy emballe votre documentation, la télécharge sur Jamdesk et déclenche un build depuis le terminal. Utilisez-la pour déployer rapidement, tester des modifications ou pour les projets non connectés à un dépôt GitHub.

Quick Start

jamdesk login        # First time only
jamdesk deploy       # From your project directory

Options

Flag	Description
`--detach`	Met en file d'attente le build et quitte immédiatement (affiche un lien vers le dashboard)
`--full-rebuild`	Force un rebuild complet, en contournant le cache de build
`--project <id>`	Déploie vers un projet spécifique par son ID (ignore la sélection interactive)

jamdesk push est un alias pour jamdesk deploy.

Fonctionnement

Authentification

Vérifie que votre session est valide. Si votre token a expiré, vous serez invité à exécuter jamdesk login.

Chargement de la configuration

Lit et valide docs.json dans le répertoire courant.

Résolution du projet

Lit projectId depuis docs.json. S'il est absent (premier déploiement), la CLI vous invite à sélectionner parmi vos projets. Votre choix est enregistré dans docs.json pour que le prochain déploiement ignore cette étape.

Utilisez --project <id> pour remplacer cette valeur.

Empaquetage des fichiers

Crée une archive compressée de votre documentation, en respectant .gitignore. Si des fichiers semblent contenir des secrets, la CLI affiche un avertissement (mais ne bloque pas l'import).

Import

Envoie l'archive à Jamdesk via une URL présignée. La taille maximale d'import est de 100 Mo.

Build

Met en file d'attente un build et interroge son statut, en affichant chaque phase au fur et à mesure. Appuyez sur Ctrl+C pour arrêter l'interrogation ; le build continue en arrière-plan.

Terminé

Affiche l'URL en production lorsque le build est terminé.

Phases de build

Lors de l'interrogation, vous verrez chaque phase se terminer dans l'ordre suivant :

Phase	Description
Extracting files	Décompression de l'archive importée
Validating configuration	Vérification du schéma et du contenu de `docs.json`
Preparing content	Traitement des fichiers MDX et des ressources
Building documentation	Compilation des pages et génération des artefacts statiques
Uploading to CDN	Envoi du résultat buildé vers le réseau edge
Refreshing cache	Purge du contenu obsolète du CDN

Exclusions de fichiers

Les éléments suivants sont toujours exclus des imports, quels que soient les paramètres de votre .gitignore :

.git, node_modules, .next, .env, .env.*, *.pem, *.key, credentials.json, .gcloud, .DS_Store, Thumbs.db

Tout ce qui figure dans votre .gitignore est également exclu.

Avertissements pour les fichiers secrets

La CLI avertit (sans bloquer) lorsqu'elle détecte des fichiers qui semblent contenir des secrets :

Les fichiers .env et .env.*
Les fichiers *.pem et *.key
credentials.json
service_account*.json
Les fichiers commençant par secret

Ajoutez-les à .gitignore pour supprimer l'avertissement et les exclure des imports.

Référence des erreurs

Erreur	Code	Cause	Correction
Non connecté	`AUTH_REQUIRED`	Aucun identifiant stocké	`jamdesk login`
Session expirée	`AUTH_EXPIRED`	Échec du renouvellement du token	`jamdesk login`
Accès refusé	`FORBIDDEN`	Non membre de ce projet	Vérifiez l'appartenance au projet dans le dashboard
Projet introuvable	`NOT_FOUND`	ID de projet invalide	Vérifiez l'ID ou supprimez `projectId` de docs.json
Build en cours	`BUILD_IN_PROGRESS`	Un autre build est en cours d'exécution	Attendez ou vérifiez le dashboard
Import trop volumineux	`TOO_LARGE`	Le serveur a rejeté l'import (limite de 100 Mo)	Excluez les fichiers volumineux via `.gitignore`
Projet trop volumineux	`PROJECT_TOO_LARGE`	L'archive dépasse 100 Mo lors de l'empaquetage	Excluez les fichiers volumineux via `.gitignore`
Aucun projet	`NO_PROJECTS`	Aucun projet dans votre compte	Créez d'abord un projet dans le dashboard
Aucun fichier	`EMPTY_PROJECT`	Tous les fichiers sont exclus	Vérifiez `.gitignore`
Configuration invalide	`CONFIG_NOT_FOUND`	`docs.json` manquant ou invalide	Exécutez depuis la racine du projet, vérifiez la configuration
Échec de l'import	`UPLOAD_FAILED`	Problème réseau lors de l'import	Vérifiez votre connexion internet, réessayez
Échec du build	`BUILD_FAILED`	Erreur du service de build	Consultez les logs de build dans le dashboard

Dépannage

Un seul build s'exécute à la fois par projet. Attendez que le build en cours se termine ; vérifiez le statut dans le dashboard sous Deployments.

Assurez-vous d'exécuter la commande depuis le répertoire contenant docs.json. Exécutez jamdesk validate pour vérifier les erreurs de configuration.

La limite de 100 Mo s'applique à l'archive compressée de tous les fichiers non exclus. Vérifiez ce qui est inclus. Les images volumineuses, les vidéos ou les fichiers de données sont des causes fréquentes ; ajoutez-les à .gitignore pour les exclure.

Appuyez sur Ctrl+C pour quitter ; le build continue de s'exécuter en arrière-plan. Vérifiez le dashboard pour connaître le statut. Si cela se produit régulièrement, votre réseau abandonne peut-être les requêtes d'interrogation.

Vous avez besoin d'au moins un projet dans votre compte Jamdesk. Créez-en un sur dashboard.jamdesk.com.

Pour plus de dépannage CLI, consultez le guide CLI du Centre d'aide.

Et ensuite ?

Workflow de déploiement

Déploiement automatique GitHub et statut de déploiement

Authentification

Flux de connexion, sessions et dépannage