digna CLI Reference 2026.01¶

2026-01-15

Cette page documente l’ensemble des commandes disponibles dans le CLI digna version 2026.01, y compris des exemples d’utilisation et les options.

CLI Basics¶

help¶

L’option --help fournit des informations sur les commandes disponibles et leur utilisation. Il existe deux manières principales d’utiliser cette option :

1. Afficher l’aide générale :

   Utilisez --help immédiatement après le mot-clé dignacli
   

   dignacli --help
   

2. Obtenir l’aide pour une commande spécifique :

   Pour obtenir des informations détaillées sur une commande spécifique, ajoutez --help à la suite de cette commande. Par exemple, pour obtenir de l’aide sur la commande add-user, exécutez :

   dignacli add-user --help
   

   ### output:

   • Description de la commande : Fournit une description détaillée de ce que fait la commande.
   • Syntaxe : Affiche la syntaxe exacte, incluant les arguments requis et optionnels.
   • Options : Liste les options spécifiques à la commande, avec leurs explications.
   • Exemples : Donne des exemples d’exécution efficace de la commande.

check-config¶

La commande check-config est un utilitaire du CLI digna conçu pour tester la configuration de digna. Cette commande vérifie que les composants de digna peuvent trouver les éléments de configuration nécessaires dans le fichier config.toml.

Options¶

• --configpath, -cp : Fichier ou répertoire contenant la configuration. Si omis, ../config.toml sera utilisé.

Command Usage¶

dignacli check-config

Après exécution réussie, la commande affiche une confirmation de l’exhaustivité de la configuration.

Si la configuration semble incomplète, les éléments manquants seront listés.

check-repo-connection¶

La commande check-repo-connection est un utilitaire du CLI digna conçu pour tester la connectivité et l’accès à un dépôt digna spécifié. Cette commande vérifie que le CLI peut interagir avec le dépôt.

Command Usage¶

dignacli check-repo-connection

Après exécution réussie, la commande affiche une confirmation de la connexion, ainsi que des détails sur le dépôt : version du dépôt, hôte, base de données et schéma.

Si la connexion au dépôt échoue, vérifiez le fichier config.toml pour vous assurer que les paramètres de configuration sont corrects.

version¶

Pour vérifier la version installée de dignacli, utilisez l’option --version.

Command Usage¶

dignacli --version

Example Output¶

dignacli version 2026.01

logging options¶

Par défaut, la sortie console des commandes digna est conçue pour être minimaliste. La plupart des commandes offrent la possibilité de fournir des informations supplémentaires en utilisant les options suivantes :

-- verbose (-v)
-- debug (-d)
-- logfile (lf)

« verbose » et « debug » définissent le niveau de détail, tandis que l’option « logfile » permet de rediriger la sortie vers un fichier plutôt que vers la console.

User Management¶

add-user¶

La commande add-user du CLI digna est utilisée pour ajouter un nouvel utilisateur au système digna.

Command Usage¶

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Arguments¶

• USER_NAME : Le nom d’utilisateur pour le nouvel utilisateur (obligatoire).
• USER_FULL_NAME : Le nom complet du nouvel utilisateur (obligatoire).
• USER_PASSWORD : Le mot de passe du nouvel utilisateur (obligatoire).

Options¶

• --is_superuser, -su : Indique que le nouvel utilisateur est administrateur.
• --valid_until, -vu : Définit une date d’expiration pour le compte utilisateur au format YYYY-MM-DD HH:MI:SS. Si non défini, le compte n’a pas de date d’expiration.

Example¶

Pour ajouter un nouvel utilisateur avec le nom d’utilisateur jdoe, le nom complet John Doe et le mot de passe password123 :

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Pour ajouter un nouvel utilisateur et définir une date d’expiration du compte :

dignacli add-user jdoe "John Doe" password123 --valid_until "2024-12-31 23:59:59"

delete-user¶

La commande delete-user du CLI digna est utilisée pour supprimer un utilisateur existant du système digna.

Command Usage¶

dignacli delete-user USER_NAME

Arguments¶

• USER_NAME : Le nom d’utilisateur de l’utilisateur à supprimer (obligatoire). C’est le seul argument requis par la commande.

Example¶

dignacli delete-user jdoe

L’exécution de cette commande supprimera l’utilisateur jdoe du système digna, révoquera son accès et supprimera les données et permissions associées dans le dépôt.

modify-user¶

La commande modify-user du CLI digna permet de mettre à jour les informations d’un utilisateur existant dans le système digna.

Command Usage¶

dignacli modify-user <USER_NAME> <USER_FULL_NAME> [options]

Arguments¶

• USER_NAME : Le nom d’utilisateur de l’utilisateur à modifier (obligatoire).
• USER_FULL_NAME : Le nouveau nom complet de l’utilisateur (obligatoire).

Options¶

• --is_superuser, -su : Définit l’utilisateur comme superutilisateur, lui accordant des privilèges élevés. Ce flag ne nécessite pas de valeur.
• --valid_until, -vu : Définit une date d’expiration pour le compte utilisateur au format YYYY-MM-DD HH:MI:SS. Si non fourni, le compte reste valide indéfiniment.

Example¶

Pour modifier le nom complet de l’utilisateur jdoe en « Johnathan Doe » et définir l’utilisateur comme superutilisateur :

dignacli modify-user jdoe "Johnathan Doe" --is_superuser

modify-user-pwd¶

La commande modify-user-pwd du CLI digna est utilisée pour changer le mot de passe d’un utilisateur existant dans le système digna.

Command Usage¶

dignacli modify-user-pwd <USER_NAME> <USER_PWD>

Arguments¶

• USER_NAME : Le nom d’utilisateur dont le mot de passe doit être modifié (obligatoire).
• USER_PWD : Le nouveau mot de passe de l’utilisateur (obligatoire).

Example¶

Pour changer le mot de passe de l’utilisateur jdoe en newpassword123 :

dignacli modify-user-pwd jdoe newpassword123

list-users¶

La commande list-users du CLI digna affiche la liste de tous les utilisateurs enregistrés dans le système digna.

Command Usage¶

dignacli list-users

L’exécution de cette commande dans le CLI digna se connectera au dépôt digna et listera tous les utilisateurs, affichant leur ID, nom d’utilisateur, nom complet, statut de superutilisateur et dates d’expiration.

Repository Management¶

upgrade-repo¶

La commande upgrade-repo du CLI digna est utilisée pour mettre à niveau ou initialiser le dépôt digna. Cette commande est essentielle pour appliquer des mises à jour ou configurer l’infrastructure du dépôt pour la première fois.

Command Usage¶

dignacli upgrade-repo [options]

Options¶

• --simulation-mode, -s : Lorsqu’activée, cette option exécute la commande en mode simulation, ce qui affiche les instructions SQL qui seraient exécutées sans les appliquer réellement. Utile pour prévisualiser les changements sans modifier le dépôt.

Example¶

Pour mettre à niveau le dépôt digna, vous pouvez exécuter la commande sans options :

dignacli upgrade-repo

dignacli upgrade-repo --simulation-mode

Cette commande est cruciale pour maintenir le système digna, en s’assurant que le schéma de la base de données et les autres composants du dépôt sont à jour avec la dernière version du logiciel.

encrypt¶

La commande encrypt du CLI digna est utilisée pour chiffrer un mot de passe.

Command Usage¶

dignacli encrypt <PASSWORD>

Arguments¶

• PASSWORD : Le mot de passe à chiffrer (obligatoire).

Example¶

Pour chiffrer un mot de passe, vous devez fournir le mot de passe en argument.
Par exemple, pour chiffrer le mot de passe mypassword123, vous utiliseriez :

dignacli encrypt mypassword123

generate-key¶

La commande generate-key est utilisée pour générer une clé Fernet, essentielle pour sécuriser les mots de passe stockés dans le dépôt digna.

Command Usage¶

dignacli generate-key

Data Management¶

clean-up¶

La commande clean-up du CLI digna est utilisée pour supprimer les profils, prédictions et données du système de feux tricolores pour une ou plusieurs sources de données dans un projet spécifié. Cette commande est essentielle pour la gestion du cycle de vie des données, aidant à maintenir un environnement de données organisé et efficace en supprimant les données obsolètes ou non nécessaires.

Command Usage¶

dignacli clean-up <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]

Arguments¶

• PROJECT_NAME : Le nom du projet depuis lequel les données doivent être supprimées (obligatoire). L’utilisation du mot-clé all-projects dans cet argument indique à digna d’itérer sur tous les projets existants et d’appliquer cette commande.
• FROM_DATE : La date et l’heure de début pour la suppression des données. Les formats acceptés incluent %Y-%m-%d, %Y-%m-%dT%H:%M:%S, ou %Y-%m-%d %H:%M:%S (obligatoire).
• TO_DATE : La date et l’heure de fin pour la suppression des données, suivant les mêmes formats que FROM_DATE (obligatoire).

Options¶

• --table-name, -tn : Limite l’opération de nettoyage à une table spécifique dans le projet.
• --table-filter, -tf : Filtre pour limiter le nettoyage aux tables contenant la sous-chaîne spécifiée dans leur nom.
• --timing, -tm : Affiche la durée du processus de nettoyage après son achèvement.
• --help : Affiche les informations d’aide pour la commande clean-up et quitte.

Example¶

Pour supprimer des données du projet ProjectA entre le 1er janvier 2023 et le 30 juin 2023 :

dignacli clean-up ProjectA 2023-01-01 2023-06-30

Pour supprimer des données uniquement d’une table spécifique nommée Table1 :

dignacli clean-up ProjectA 2023-01-01 2023-06-30 --table-name Table1

Cette commande aide à gérer le stockage des données et à s’assurer que le dépôt ne contient que des informations pertinentes.

remove-orphans¶

La commande remove-orphans du CLI digna est utilisée pour l’entretien du dépôt digna.
Lorsqu’un utilisateur supprime des projets ou des sources de données, les profils et prédictions peuvent rester dans le dépôt. Avec cette commande, ces lignes orphelines seront supprimées du dépôt.

Command Usage¶

dignacli list-projects

list-projects¶

La commande list-projects du CLI digna est utilisée pour afficher la liste de tous les projets disponibles dans le système digna.

Command Usage¶

dignacli list-projects

Cette commande est particulièrement utile pour les administrateurs et les utilisateurs qui gèrent plusieurs projets, offrant un aperçu rapide des projets disponibles dans le dépôt digna.

list-ds¶

La commande list-ds du CLI digna est utilisée pour afficher la liste de toutes les sources de données disponibles dans un projet spécifié. Cette commande est utile pour connaître les actifs de données disponibles pour l’analyse et la gestion dans le système digna.

Command Usage¶

dignacli list-ds <PROJECT_NAME>

Arguments¶

• PROJECT_NAME : Le nom du projet pour lequel les sources de données sont listées (obligatoire).

Example¶

Pour lister toutes les sources de données du projet nommé ProjectA :

dignacli list-ds ProjectA

Cette commande fournit aux utilisateurs un aperçu des sources de données disponibles dans un projet, les aidant à naviguer et à gérer le paysage des données plus efficacement.

inspect¶

La commande inspect du CLI digna est utilisée pour créer des profils, des prédictions et des données du système de feux tricolores pour une ou plusieurs sources de données dans un projet spécifié. Cette commande aide à analyser et surveiller les données sur une période définie. Après l’achèvement de l’inspection, la valeur du système de feux tricolores calculé est retournée :
- 0 : OK
- 1 : INFO
- 2 : WARNING

Command Usage¶

dignacli inspect <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]

Arguments¶

• PROJECT_NAME : Le nom du projet pour lequel les données doivent être inspectées (obligatoire). L’utilisation du mot-clé all-projects dans cet argument indique à digna d’itérer sur tous les projets existants et d’appliquer cette commande.
• FROM_DATE : La date et l’heure de début pour l’inspection des données. Les formats acceptés incluent %Y-%m-%d, %Y-%m-%dT%H:%M:%S, ou %Y-%m-%d %H:%M:%S (obligatoire).
• TO_DATE : La date et l’heure de fin pour l’inspection des données, suivant les mêmes formats que FROM_DATE (obligatoire).

Options¶

• --table-name, -tn : Limite l’inspection à une table spécifique dans le projet.
• --table-filter, -tf : Filtre pour n’inspecter que les tables contenant la sous-chaîne spécifiée dans leur nom.
• --enable_notification, -en : Active l’envoi de notifications en cas d’alertes.
• --bypass-backend, -bb : Contourne le backend et exécute l’inspection directement depuis le CLI (à usage de test uniquement !).

Example¶

Pour inspecter les données du projet ProjectA du 1er janvier 2024 au 31 janvier 2024 :

dignacli inspect ProjectA 2024-01-01 2024-01-31

Pour n’inspecter qu’une table spécifique et forcer le recalcul des prédictions :

dignacli inspect ProjectA 2024-01-01 2024-01-31 --table-name Table1 --force-prediction

inspect-async¶

La commande inspect-async du CLI digna est utilisée pour créer des profils, des prédictions et des données du système de feux tricolores pour une ou plusieurs sources de données dans un projet spécifié. Cette commande aide à analyser et surveiller les données sur une période définie. Contrairement à la commande inspect, elle n’attend pas la fin de l’inspection. Elle renvoie plutôt l’ID de requête pour la demande d’inspection soumise. Pour interroger l’état d’avancement du processus d’inspection, utilisez la commande inspect-status.

Command Usage¶

dignacli inspect-async <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]

Arguments¶

• PROJECT_NAME : Le nom du projet pour lequel les données doivent être inspectées (obligatoire). L’utilisation du mot-clé all-projects dans cet argument indique à digna d’itérer sur tous les projets existants et d’appliquer cette commande.
• FROM_DATE : La date et l’heure de début pour l’inspection des données. Les formats acceptés incluent %Y-%m-%d, %Y-%m-%dT%H:%M:%S, ou %Y-%m-%d %H:%M:%S (obligatoire).
• TO_DATE : La date et l’heure de fin pour l’inspection des données, suivant les mêmes formats que FROM_DATE (obligatoire).

Options¶

• --table-name, -tn : Limite l’inspection à une table spécifique dans le projet.
• --table-filter, -tf : Filtre pour n’inspecter que les tables contenant la sous-chaîne spécifiée dans leur nom.
• --enable_notification, -en : Active l’envoi de notifications en cas d’alertes.

Example¶

Pour inspecter les données du projet ProjectA du 1er janvier 2024 au 31 janvier 2024 :

dignacli inspect-async ProjectA 2024-01-01 2024-01-31

inspect-status¶

La commande inspect-status du CLI digna est utilisée pour vérifier l’avancement d’une inspection asynchrone à partir de l’ID de requête.

Command Usage¶

dignacli inspect-status <REQUEST ID>

Arguments¶

• REQUEST_ID : L’ID de requête retourné par la commande inspect-async.

Example¶

Pour vérifier l’avancement d’une inspection avec l’ID de requête 12345 :

dignacli inspect-status 12345

inspect-cancel¶

La commande inspect-cancel du CLI digna est utilisée pour annuler des inspections en fonction de l’ID de requête ou pour annuler toutes les requêtes en cours.

Command Usage¶

dignacli inspect-cancel <REQUEST ID>
dignacli inspect-cancel --killall

Arguments¶

• REQUEST_ID : L’ID de requête retourné par la commande inspect-async.

Example¶

Pour annuler l’inspection avec l’ID de requête 12345 :

dignacli inspect-cancel 12345

Pour annuler toutes les requêtes actuellement en cours ou en attente :

dignacli inspect-cancel --killall

export-ds¶

La commande export-ds du CLI digna est utilisée pour créer une exportation des sources de données depuis le dépôt digna. Par défaut, toutes les sources de données d’un projet donné seront exportées.

Command Usage¶

dignacli export-ds <PROJECT_NAME> [options]

Arguments¶

• PROJECT_NAME : Le nom du projet depuis lequel les sources de données seront exportées.

Options¶

• --table_name, -tn : Exporter une source de données particulière d’un projet.
• --exportfile, -ef : Spécifier le nom de fichier pour l’export.

Example¶

Pour exporter toutes les sources de données du projet nommé ProjectA :

dignacli export-ds ProjectA

Cette commande exporte toutes les sources de données de ProjectA sous forme de document JSON pouvant être importé dans un autre projet ou dépôt digna.

import-ds¶

La commande import-ds du CLI digna est utilisée pour importer des sources de données dans un projet cible et générer un rapport d’importation.

Command Usage¶

dignacli import-ds <PROJECT_NAME> <EXPORT_FILE> [options]

Arguments¶

• PROJECT_NAME : Le nom du projet dans lequel les sources de données seront importées.
• EXPORT_FILE : Le nom du fichier d’export des sources de données à importer.

Options¶

• --output-file, -o : Fichier pour sauvegarder le rapport d’import (si non spécifié, affiche dans le terminal sous forme tabulaire).
• --output-format, -f : Format pour sauvegarder le rapport d’import (json, csv).

Example¶

Pour importer toutes les sources de données depuis le fichier d’export my_export.json dans ProjectB :

dignacli import-ds ProjectB my_export.json

Après l’importation, cette commande affichera également un rapport des objets importés et ignorés. Seules les nouvelles sources de données seront importées dans ProjectB. Pour savoir quels objets seraient importés et lesquels seraient ignorés, vous pouvez utiliser la commande plan-import-ds.

plan-import-ds¶

La commande plan-import-ds du CLI digna est utilisée pour analyser un export de sources de données destiné à un projet cible et générer un rapport prévisionnel d’importation.

Command Usage¶

dignacli plan-import-ds <PROJECT_NAME> <EXPORT_FILE> [options]

Arguments¶

• PROJECT_NAME : Le nom du projet dans lequel les sources de données seraient importées.
• EXPORT_FILE : Le nom du fichier d’export des sources de données à analyser avant l’import.

Options¶

• --output-file, -o : Fichier pour sauvegarder le rapport d’import (si non spécifié, affiche dans le terminal sous forme tabulaire).
• --output-format, -f : Format pour sauvegarder le rapport d’import (json, csv).

Example¶

Pour vérifier quelles sources de données seraient importées et lesquelles seraient ignorées à partir du fichier d’export my_export.json lors d’un import dans ProjectB :

dignacli plan-import-ds ProjectB my_export.json

Cette commande affichera uniquement un plan d’importation des objets à importer et à ignorer.