--- title: "Utiliser la ligne de commande Bench" description: "Guide complet pour maîtriser les commandes Bench et gérer vos instances Dokos efficacement" icon: "i-mdi-console" ---

Utiliser la ligne de commande Bench

Bench est l'outil en ligne de commande officiel pour gérer vos instances Dokos. Il permet d'effectuer des opérations courantes comme la création de sites, la restauration de sauvegardes, ou l'import de données, le tout depuis votre terminal.

Installation et configuration

Pour installer Bench, suivez les instructions détaillées dans la section Installation de Dokos. Une fois installé, vous pouvez utiliser les commandes Bench depuis n'importe quel répertoire.

Commandes de base

Voici les commandes Bench les plus couramment utilisées :

# Créer un nouveau site Dokos
bench new-site [nom-du-site]

# Démarrer le serveur de développement
bench start

# Mettre à jour Dokos et toutes les applications
bench update

Complétion automatique des chemins de fichiers

::: info Disponible depuis la version 5.18.0 de Bench :::

Bench prend désormais en charge la complétion automatique des chemins de fichiers lorsque vous utilisez la touche Tab dans votre terminal. Cette fonctionnalité facilite grandement l'utilisation des commandes qui nécessitent des chemins de fichiers, comme restore, backup, ou data-import.

Fonctionnement

1. Déclenchement : Lorsque vous tapez une commande Bench qui attend un chemin de fichier (par exemple bench restore), appuyez sur la touche Tab après avoir commencé à saisir le chemin.
2. Complétion intelligente : Bench affiche automatiquement les fichiers et dossiers disponibles dans le répertoire courant ou le chemin spécifié.
3. Expansion des chemins :
   • Les chemins commençant par ~ sont automatiquement étendus vers votre répertoire personnel.
   • Les dossiers sont automatiquement suivis d'un / pour faciliter la navigation.

Exemples d'utilisation

Restaurer une sauvegarde

# Commencez à taper la commande
bench restore 

# Appuyez sur Tab pour voir les fichiers disponibles dans le répertoire courant
bench restore [TAB]
# Affiche : backup-20260715_123456.sql.gz  backup-20260716_092345.sql.gz

# Sélectionnez un fichier en continuant à taper et en appuyant sur Tab
bench restore backup-20260716_092345.sql.gz

Importer des données

# Commencez à taper la commande
bench data-import 

# Appuyez sur Tab pour naviguer dans les dossiers
bench data-import ~/d[Tab]
# Si vous avez un dossier ~/documents, cela complétera automatiquement
bench data-import ~/documents/

# Appuyez à nouveau sur Tab pour voir les fichiers disponibles dans ~/documents
bench data-import ~/documents/[TAB]
# Affiche : clients.xlsx  fournisseurs.xlsx  produits.xlsx

Sauvegarder un site

# La complétion fonctionne aussi pour spécifier le chemin de destination
bench backup --backup-path ~/sauvegardes/[TAB]
# Affiche les dossiers disponibles dans ~/sauvegardes

Commandes compatibles

La complétion automatique des chemins de fichiers fonctionne avec les commandes Bench suivantes :

• restore : Pour restaurer une sauvegarde SQL
• backup : Pour créer une sauvegarde (option --backup-path)
• data-import : Pour importer des données depuis un fichier Excel ou CSV
• migrate : Pour spécifier un fichier de migration personnalisé
• execute : Pour exécuter un script Python (option --file)

Configuration requise

• Shell supporté : La complétion fonctionne avec Bash et Zsh.
• Activation : Aucune configuration supplémentaire n'est nécessaire. La complétion est activée automatiquement après l'installation ou la mise à jour de Bench.

Bonnes pratiques

1. Navigation rapide : Utilisez la complétion pour naviguer rapidement dans votre système de fichiers sans avoir à taper manuellement les chemins complets.
2. Éviter les erreurs : La complétion réduit les risques d'erreurs de frappe dans les chemins de fichiers.
3. Découverte des fichiers : Appuyez sur Tab deux fois pour afficher tous les fichiers disponibles dans un répertoire.
4. Chemins relatifs : Vous pouvez utiliser des chemins relatifs (par exemple ../sauvegardes/) en plus des chemins absolus.

Gestion des sites

Créer un nouveau site

bench new-site site-exemple

Supprimer un site

bench drop-site site-exemple

Basculer entre les sites

bench use site-exemple

Gestion des applications

Installer une application

bench get-app erpnext
bench --site site-exemple install-app erpnext

Mettre à jour les applications

bench update

Sauvegardes et restaurations

Créer une sauvegarde

bench backup

Restaurer une sauvegarde

bench --site site-exemple restore /chemin/vers/la/sauvegarde.sql.gz

Import et export de données

Importer des données

bench --site site-exemple data-import /chemin/vers/le/fichier.xlsx

Exporter des données

bench --site site-exemple data-export --doctype "Client" --filters '{"disabled": 0}'

Dépannage

Vérifier la version de Bench

bench --version

Afficher l'aide

bench --help

Redémarrer les services

bench restart

Personnalisation avancée

Pour les utilisateurs avancés, Bench offre des options de personnalisation supplémentaires :

# Configurer les variables d'environnement
bench config set-common-config -c db_host localhost

# Activer le mode développement
bench set-config -g developer_mode 1

::: tip Pour une liste complète des commandes et options disponibles, consultez toujours bench --help ou la documentation officielle de Frappe Bench. :::

      
flowchart TD
    A[Démarrer Bench] --> B{Commande}
    B -->|new-site| C[Créer un site]
    B -->|restore| D[Restaurer une sauvegarde]
    B -->|backup| E[Créer une sauvegarde]
    B -->|data-import| F[Importer des données]
    B -->|update| G[Mettre à jour Dokos]
    D --> H[Utiliser la complétion Tab
pour sélectionner le fichier]
    F --> I[Utiliser la complétion Tab
pour naviguer vers le fichier]