Bench
Référence des commandes bench
Liste des commandes de docli et du framework Dodock, avec leur rôle.
Référence des commandes bench
Cette page liste les commandes disponibles. Pour les usages courants, voir Utiliser la ligne de commande bench.
La liste à jour de votre installation s'affiche avec bench --help, dans le dossier du bench. Les options d'une commande s'affichent avec bench <commande> --help.
Commandes de docli
Ces commandes agissent sur le bench : dossiers, applications, configuration du serveur.
| Commande | Description |
|---|---|
| app-cache | Affiche ou supprime le cache des applications du bench |
| backup-all-sites | Lancement d'une sauvegarde de tous les sites dans un bench |
| config | Modification de la configuration du bench |
| disable-production | Désactivation de l'environnement de production (ou mode de production) pour ce bench |
| download-translations | Téléchargement des dernières traductions |
| drop | Sauvegarde et suppression d'un dossier bench |
| exclude-app | Exclusion une application des mises à jour |
| find | Recherche récursive pour trouver un dossier bench |
| get-app | Permet de cloner et installer une application depuis un répertoire git distant ou local |
| get | Alias pour get-app |
| include-app | Inclus l'application dans la liste des applications à mettre à jour |
| init | Initialise un nouveau dossier bench |
| install | Installation des dépendances système |
| migrate-env | Migration de l'environnement virtuel python vers une nouvelle version |
| new-app | Création d'une nouvelle application sur Dodock |
| pip | Utilisation de la version de pip de l'environnement virtuel. Utilisez bench pip --help pour en savoir plus. |
| release | Publication d'une nouvelle version d'une application - Interne à l'équipe Dokos |
| remote-reset-url | Réinitialise les adresses distantes des applications Dodock et Dokos |
| remote-set-url | Alias pour git remote set-url upstream {URL}. Trouve l'application à mettre à jour grâce à l'URL |
| remote-urls | Affiche les URL des répertoires distants des applications installées |
| remove-app | Supprime une application du bench |
| remove | Alias pour remove-app |
| renew-lets-encrypt | Renouvelle les certificats Let's Encrypt et crée une entrée CRON |
| restart | Redémarre les processus Supervisor ou Systemd |
| retry-upgrade | Relance une mise à jour tombée en erreur |
| rm | Alias pour remove-app |
| set-mariadb-host | Configuration d'un hôte MariaDB pour ce bench |
| set-nginx-port | Configuration d'un port associé à Nginx pour un site |
| set-redis-cache-host | Configuration d'un hôte Redis Cache pour ce bench |
| set-redis-queue-host | Configuration d'un hôte Redis Queue pour ce bench |
| set-redis-socketio-host | Configuration d'un hôte Redis SocketIO pour ce bench |
| set-ssl-certificate | Configuration d'un chemin vers un certificat SSL pour un site |
| set-ssl-key | Configuration d'un chemin vers la clé privée d'un certificat SSL pour un site |
| set-url-root | Configuration d'une URL de base pour un site |
| setup | Groupe de commandes pour configurer son bench. Utilisez bench setup --help pour en savoir plus. |
| src | Impression du chemin vers le code source installé de docli |
| start | Démarrage du mode développeur de Dodock |
| switch-to-branch | Basculement des applications indiquées vers la branche voulue |
| switch-to-develop | Basculement des applications indiquées vers la branche develop |
| update | Lancement d'une opération de mise à jour |
| validate-dependencies | Vérifie que les dépendances déclarées par les applications sont satisfaites |
Commandes du framework Dodock
Ces commandes agissent sur un site. Elles prennent l'option --site <site>, sauf si un site par défaut est défini avec bench use.
| Commande | Description |
|---|---|
| add-system-manager | Ajoute un nouveau responsable système |
| add-to-email-queue | Ajoute un email dans un fichier local au journal des emails |
| add-to-hosts | Ajoute le site dans le fichier /etc/hosts |
| add-user | Ajoute un utilisateur |
| backup | Lance une sauvegarde locale |
| browse | Ouvre le site dans le navigateur |
| build-search-index | Construit les index de recherche |
| build | Compile et minifie les fichiers JS et CSS |
| bulk-rename | Renomme des documents via un fichier csv |
| cleanup-translations | Nettoye les fichiers de traduction |
| clear-cache | Vide le cache du site |
| clear-log-table | Vide la table de log |
| clear-website-cache | Vide le cache du site web |
| console | Lance une console iPython |
| create-rq-users | Crée des utilisateurs RQ |
| data-import | Importe des données depuis des fichiers CSV |
| db-console | Ouvre une console de base de données |
| destroy-all-sessions | Déconnecte tous les utilisateurs |
| disable-scheduler | Désactive le planificateur |
| disable-user | Désactive un utilisateur |
| doctor | Affiche un diagnostic des tâches de fond |
| drop-site | Supprime le site et sa base de données |
| enable-scheduler | Active le planificateur |
| execute | Exécute une fonction |
| export-csv | Exporte des données en CSV |
| export-doc | Exporte les données d'un document en CSV |
| export-fixtures | Exporte les données spécifiées dans le fichier hooks > fixtures dans un dossier fixtures |
| export-json | Exporte des données en JSON |
| export-python-types | Génère les annotations de types Python d'un type de document |
| get-untranslated | Exporte les chaînes de caractères non traduites |
| import-doc | Importe un document enregistré dans un fichier JSON |
| install-app | Installe une application sur un site |
| jupyter | Ouvre un Notebook Jupyter |
| list-apps | Liste les applications installées sur un site |
| list-sites | Liste les sites du bench |
| make-app | Crée la structure d'une nouvelle application |
| mariadb | Ouvre une console mariadb |
| migrate | Exécute les patchs et synchronise le schéma de la base de données du site |
| new-language | Crée un nouveau fichier de traduction pour une langue donnée |
| new-site | Crée un nouveau site |
| ngrok | Crée un nouveau tunnel ngrok |
| partial-restore | Lance une restoration partielle |
| postgres | Lance une console postgres |
| publish-realtime | Publie des événements en temps réel sur le site |
| purge-jobs | Supprime les tâches de fond programmées en file d'attente |
| ready-for-migration | Vérifie si le site est prêt pour la migration |
| rebuild-global-search | Lance la construction des index de recherche globale |
| reinstall | Réinstalle un site |
| reload-doctype | Synchronise le schéma d'un type de document |
| reload-doc | Synchronise le schéma d'un type de document |
| remove-from-installed-apps | Supprime une application de la liste des applications installées |
| request | Lance une requête en temps qu'Administrateur |
| reset-perms | Réinitialise les autorisations standard pour tous les types de documents |
| restore | Restaure la base de données avec une sauvegarde |
| run-parallel-tests | Lance les tests en parallèle |
| run-patch | Lance un patch de migration |
| run-tests | Lance les tests Python |
| scheduler | Permet de changer l'état du planificateur |
| schedule | Lance le planificateur |
| serve | Lance un serveur de développement |
| set-admin-password | Défini un mot de passe administrateur |
| set-config | Mets à jour le fichier site_config.json |
| set-last-active-for-user | Modifie la date de dernière activité d'un utilisateur |
| set-maintenance-mode | Mets le site en mode maintenance |
| set-password | Modifie le mot de passe d'un utilisateur |
| show-config | Imprime les variables d'environnement du site |
| show-pending-jobs | Affiche les tâches de fond en attente |
| start-recording | Lance l'enregistrement des requêtes en base des données |
| stop-recording | Arrête l'enregistrement des requêtes en base des données |
| transform-database | Permet de modifier les paramètres internes des tables en modifiant le format de ligne et le moteur |
| trigger-scheduler-event | Déclenche une tâche de fond programmé |
| trim-database | Nettoye la base de données |
| trim-tables | Nettoye les tables indiquées |
| uninstall-app | Désinstalle l'application du site |
| update-translations | Met à jour le fichier de traduction à partir d'un fichier CSV |
| use | Défini le site par défaut |
| version | Affiche les versions de toutes les applications installées |
| watch | Recompile automatiquement les fichiers JS et CSS en cas de modification |
| worker | Lance un nouveau worker |