digna CLI Referenz 2026.04¶

2026-04-08

Diese Seite dokumentiert die vollständige Menge an Befehlen, die in der digna CLI-Version 2026.04 verfügbar sind, einschließlich Anwendungsbeispielen und Optionen.

CLI Grundlagen¶

help¶

Die Option --help liefert Informationen zu verfügbaren Befehlen und deren Verwendung. Es gibt zwei Hauptmöglichkeiten, diese Option zu nutzen:

1. Allgemeine Hilfe anzeigen:

Verwenden Sie --help unmittelbar nach dem Schlüsselwort dignacli

dignacli --help

1. Hilfe zu spezifischen Befehlen anfordern:

Für detaillierte Informationen zu einem bestimmten Befehl hängen Sie --help an diesen Befehl an.
Zum Beispiel, um Hilfe zum Befehl add-user zu erhalten, führen Sie aus:

dignacli add-user --help

### Ausgabe:

• Befehlsbeschreibung: Liefert eine detaillierte Beschreibung dessen, was der Befehl tut.
• Syntax: Zeigt die genaue Syntax, einschließlich erforderlicher und optionaler Argumente.
• Optionen: Listet spezifische Optionen des Befehls zusammen mit ihren Erklärungen auf.
• Beispiele: Gibt Beispiele, wie der Befehl effektiv ausgeführt wird.

check-config¶

Der Befehl check-config ist ein Dienstprogramm innerhalb des digna CLI-Tools, das verwendet wird, um die Konfiguration von digna zu testen. Dieser Befehl stellt sicher, dass die digna-Komponenten die benötigten Konfigurationselemente in der config.toml finden können.

Optionen¶

• --configpath, -cp: Datei oder Verzeichnis, das die Konfiguration enthält. Wenn weggelassen, wird ../config.toml verwendet.

Befehlsverwendung¶

dignacli check-config

Nach erfolgreicher Ausführung gibt der Befehl eine Bestätigung über die Vollständigkeit der Konfiguration aus.

Wenn die Konfiguration unvollständig erscheint, werden die fehlenden Konfigurationselemente aufgelistet.

check-repo-connection¶

Der Befehl check-repo-connection ist ein Dienstprogramm innerhalb des digna CLI-Tools, das dazu dient, die Konnektivität und den Zugriff auf ein angegebenes digna-Repository zu testen. Dieser Befehl stellt sicher, dass die CLI mit dem Repository interagieren kann.

Befehlsverwendung¶

dignacli check-repo-connection

Bei erfolgreicher Ausführung gibt der Befehl eine Bestätigung der Verbindung sowie Details zum Repository aus: Repository-Version, Host, Datenbank und Schema.

Wenn die Repository-Verbindung nicht erfolgreich ist, prüfen Sie die Datei config.toml auf korrekte Konfigurationseinstellungen.

version¶

Um die installierte Version von dignacli zu prüfen, verwenden Sie die Option --version.

Befehlsverwendung¶

dignacli --version

Beispielausgabe¶

dignacli version 2026.04

Logging-Optionen¶

Standardmäßig ist die Konsolenausgabe der digna-Befehle minimalistisch gehalten. Die meisten Befehle bieten die Möglichkeit, zusätzliche Informationen bereitzustellen, mittels der folgenden Optionen:

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

„verbose“ und „debug“ legen den Detaillierungsgrad fest, während der Schalter „logfile“ ermöglicht, die Ausgabe in eine Datei umzuleiten anstatt in das Konsolenfenster.

Benutzerverwaltung¶

add-user¶

Der Befehl add-user in der digna CLI wird verwendet, um einen neuen Benutzer im digna-System anzulegen.

Befehlsverwendung¶

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Argumente¶

• USER_NAME: Der Benutzername für den neuen Benutzer (erforderlich).
• USER_FULL_NAME: Der vollständige Name des neuen Benutzers (erforderlich).
• USER_PASSWORD: Das Passwort für den neuen Benutzer (erforderlich).

Optionen¶

• --is_superuser, -su: Kennzeichnet den neuen Benutzer als Administrator.
• --valid_until, -vu: Legt ein Ablaufdatum für das Benutzerkonto im Format YYYY-MM-DD HH:MI:SS fest. Wenn nicht gesetzt, hat das Konto kein Ablaufdatum.

Beispiel¶

Um einen neuen Benutzer mit dem Benutzernamen jdoe, vollständigem Namen John Doe und Passwort password123 hinzuzufügen:

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Um einen neuen Benutzer hinzuzufügen und ein Ablaufdatum für das Konto zu setzen:

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

delete-user¶

Der Befehl delete-user in der digna CLI wird verwendet, um einen bestehenden Benutzer aus dem digna-System zu entfernen.

Befehlsverwendung¶

dignacli delete-user USER_NAME

Argumente¶

• USER_NAME: Der Benutzername des zu löschenden Benutzers (erforderlich). Dies ist das einzige erforderliche Argument des Befehls.

Beispiel¶

dignacli delete-user jdoe

Durch Ausführen dieses Befehls wird der Benutzer jdoe aus dem digna-System entfernt, seine Zugriffsrechte werden entzogen und seine zugehörigen Daten und Berechtigungen im Repository werden gelöscht.

modify-user¶

Der Befehl modify-user in der digna CLI dient dazu, die Angaben eines bestehenden Benutzers im digna-System zu aktualisieren.

Befehlsverwendung¶

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

Argumente¶

• USER_NAME: Der Benutzername des zu ändernden Benutzers (erforderlich).
• USER_FULL_NAME: Der neue vollständige Name des Benutzers (erforderlich).

Optionen¶

• --is_superuser, -su: Setzt den Benutzer als Superuser und gewährt erhöhte Berechtigungen. Dieses Flag benötigt keinen Wert.
• --valid_until, -vu: Legt ein Ablaufdatum für das Benutzerkonto im Format YYYY-MM-DD HH:MI:SS fest. Wenn nicht angegeben, bleibt das Konto unbegrenzt gültig.

Beispiel¶

Um den vollständigen Namen des Benutzers jdoe in „Johnathan Doe“ zu ändern und den Benutzer als Superuser zu setzen:

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

modify-user-pwd¶

Der Befehl modify-user-pwd in der digna CLI wird verwendet, um das Passwort eines bestehenden Benutzers im digna-System zu ändern.

Befehlsverwendung¶

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

Argumente¶

• USER_NAME: Der Benutzername des Benutzers, dessen Passwort geändert werden soll (erforderlich).
• USER_PWD: Das neue Passwort für den Benutzer (erforderlich).

Beispiel¶

Um das Passwort für den Benutzer jdoe auf newpassword123 zu ändern:

dignacli modify-user-pwd jdoe newpassword123

list-users¶

Der Befehl list-users in der digna CLI zeigt eine Liste aller im digna-System registrierten Benutzer an.

Befehlsverwendung¶

dignacli list-users

Beim Ausführen dieses Befehls stellt die digna CLI eine Verbindung zum digna-Repository her und listet alle Benutzer auf, wobei deren ID, Benutzername, vollständiger Name, Superuser-Status und Ablaufzeitstempel angezeigt werden.

Repository-Verwaltung¶

upgrade-repo¶

Der Befehl upgrade-repo in der digna CLI wird verwendet, um das digna-Repository zu aktualisieren oder zu initialisieren. Dieser Befehl ist wichtig, um Updates anzuwenden oder die Repository-Infrastruktur zum ersten Mal einzurichten.

Befehlsverwendung¶

dignacli upgrade-repo [options]

Optionen¶

• --simulation-mode, -s: Wenn aktiviert, führt dieser Modus den Befehl in einer Simulation aus, die die auszuführenden SQL-Anweisungen ausgibt, diese aber nicht tatsächlich ausführt. Dies ist nützlich, um Änderungen vorab zu prüfen, ohne das Repository zu verändern.

Beispiel¶

Um das digna-Repository zu aktualisieren, können Sie den Befehl ohne Optionen ausführen:

dignacli upgrade-repo

dignacli upgrade-repo --simulation-mode

Dieser Befehl ist entscheidend für die Wartung des digna-Systems und stellt sicher, dass das Datenbankschema und andere Repository-Komponenten mit der neuesten Softwareversion übereinstimmen.

encrypt¶

Der Befehl encrypt in der digna CLI wird verwendet, um ein Passwort zu verschlüsseln.

Befehlsverwendung¶

dignacli encrypt <PASSWORD>

Argumente¶

• PASSWORD: Das zu verschlüsselnde Passwort (erforderlich).

Beispiel¶

Um ein Passwort zu verschlüsseln, müssen Sie das Passwort als Argument übergeben.
Beispielsweise, um das Passwort mypassword123 zu verschlüsseln, verwenden Sie:

dignacli encrypt mypassword123

generate-key¶

Der Befehl generate-key wird verwendet, um einen Fernet-Schlüssel zu erstellen, der zur Sicherung von Passwörtern im digna-Repository erforderlich ist.

Befehlsverwendung¶

dignacli generate-key

Datenverwaltung¶

clean-up¶

Der Befehl clean-up in der digna CLI wird verwendet, um Profile, Vorhersagen und Ampelsystemdaten für eine oder mehrere Datenquellen innerhalb eines angegebenen Projekts zu entfernen. Dieser Befehl ist wichtig für das Datenlebenszyklus-Management und hilft, eine organisierte und effiziente Datenumgebung zu erhalten, indem veraltete oder unnötige Daten gelöscht werden.

Befehlsverwendung¶

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

Argumente¶

• PROJECT_NAME: Der Name des Projekts, aus dem Daten entfernt werden sollen (erforderlich). Wird das Schlüsselwort all-projects für dieses Argument verwendet, weist das digna an, alle vorhandenen Projekte zu durchlaufen und diesen Befehl anzuwenden.
• FROM_DATE: Das Startdatum und die Startzeit für die Datenlöschung. Zulässige Formate sind %Y-%m-%d, %Y-%m-%dT%H:%M:%S oder %Y-%m-%d %H:%M:%S (erforderlich).
• TO_DATE: Das Enddatum und die Endzeit für die Datenlöschung, nach denselben Formaten wie FROM_DATE (erforderlich).

Optionen¶

• --table-name, -tn: Beschränkt die Clean-up-Operation auf eine bestimmte Tabelle innerhalb des Projekts.
• --table-filter, -tf: Filtert, um die Bereinigung auf Tabellen zu begrenzen, die die angegebene Teilzeichenfolge im Namen enthalten.
• --timing, -tm: Zeigt nach Abschluss die Dauer des Clean-up-Prozesses an.
• --help: Zeigt Hilfsinformationen für den clean-up-Befehl an und beendet die Ausführung.

Beispiel¶

Um Daten aus dem Projekt ProjectA zwischen dem 1. Januar 2023 und dem 30. Juni 2023 zu entfernen:

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

Um Daten nur aus einer bestimmten Tabelle namens Table1 zu entfernen:

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

Dieser Befehl hilft bei der Verwaltung des Datenvolumens und stellt sicher, dass das Repository nur relevante Informationen enthält.

remove-orphans¶

Der Befehl remove-orphans in der digna CLI dient der Aufräumarbeit im digna-Repository.
Wenn ein Benutzer Projekte oder Datenquellen löscht, verbleiben Profile und Vorhersagen oftmals im Repository. Mit diesem Befehl werden solche verwaisten Datensätze aus dem Repository entfernt.

Befehlsverwendung¶

dignacli list-projects

list-projects¶

Der Befehl list-projects in der digna CLI dient dazu, eine Liste aller verfügbaren Projekte im digna-System anzuzeigen.

Befehlsverwendung¶

dignacli list-projects

Dieser Befehl ist besonders nützlich für Administratoren und Benutzer, die mehrere Projekte verwalten, und bietet eine schnelle Übersicht über die im digna-Repository vorhandenen Projekte.

list-ds¶

Der Befehl list-ds in der digna CLI zeigt eine Liste aller verfügbaren Datenquellen innerhalb eines angegebenen Projekts an. Dieser Befehl ist nützlich, um die verfügbaren Datenressourcen für Analyse und Verwaltung im digna-System zu überblicken.

Befehlsverwendung¶

dignacli list-ds <PROJECT_NAME>

Argumente¶

• PROJECT_NAME: Der Name des Projekts, für das die Datenquellen aufgelistet werden (erforderlich).

Beispiel¶

Um alle Datenquellen im Projekt mit dem Namen ProjectA aufzulisten:

dignacli list-ds ProjectA

Dieser Befehl verschafft den Benutzern einen Überblick über die in einem Projekt verfügbaren Datenquellen und unterstützt sie so bei der Navigation und Verwaltung der Datenlandschaft.

inspect¶

Der Befehl inspect in der digna CLI wird verwendet, um Profile, Vorhersagen und Ampelsystemdaten für eine oder mehrere Datenquellen innerhalb eines angegebenen Projekts zu erzeugen. Dieser Befehl hilft bei der Analyse und Überwachung von Daten über einen definierten Zeitraum. Nach Abschluss der Inspektion wird der Wert des berechneten Ampelsystems zurückgegeben:
- 0: OK
- 1: INFO
- 2: WARNING

Befehlsverwendung¶

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

Argumente¶

• PROJECT_NAME: Der Name des Projekts, für das Daten inspiziert werden sollen (erforderlich). Wird das Schlüsselwort all-projects für dieses Argument verwendet, weist das digna an, alle vorhandenen Projekte zu durchlaufen und diesen Befehl anzuwenden.
• FROM_DATE: Das Startdatum und die Startzeit für die Dateninspektion. Zulässige Formate sind %Y-%m-%d, %Y-%m-%dT%H:%M:%S oder %Y-%m-%d %H:%M:%S (erforderlich).
• TO_DATE: Das Enddatum und die Endzeit für die Dateninspektion, nach denselben Formaten wie FROM_DATE (erforderlich).

Optionen¶

• --table-name, -tn: Beschränkt die Inspektion auf eine bestimmte Tabelle innerhalb des Projekts.
• --table-filter, -tf: Filtert, sodass nur Tabellen inspiziert werden, die die angegebene Teilzeichenfolge im Namen enthalten.
• --enable_notification, -en: Aktiviert das Versenden von Benachrichtigungen im Fall von Alerts.
• --bypass-backend, -bb: Backend umgehen und Inspektion direkt aus der CLI ausführen (nur zu Testzwecken!).

Beispiel¶

Um Daten für das Projekt ProjectA vom 1. Januar 2024 bis zum 31. Januar 2024 zu inspizieren:

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

Um nur eine bestimmte Tabelle zu inspizieren und die Vorhersagen neu zu berechnen:

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

inspect-async¶

Der Befehl inspect-async in der digna CLI wird verwendet, um Profile, Vorhersagen und Ampelsystemdaten für eine oder mehrere Datenquellen innerhalb eines angegebenen Projekts zu erzeugen. Dieser Befehl hilft bei der Analyse und Überwachung von Daten über einen definierten Zeitraum. Im Gegensatz zum synchronen inspect-Befehl wartet dieser nicht auf den Abschluss der Inspektion. Stattdessen gibt er die Request-ID für die übermittelte Inspektionsanfrage zurück. Um den Fortschritt des Inspektionsprozesses abzufragen, verwenden Sie den Befehl inspect-status.

Befehlsverwendung¶

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

Argumente¶

• PROJECT_NAME: Der Name des Projekts, für das Daten inspiziert werden sollen (erforderlich). Wird das Schlüsselwort all-projects für dieses Argument verwendet, weist das digna an, alle vorhandenen Projekte zu durchlaufen und diesen Befehl anzuwenden.
• FROM_DATE: Das Startdatum und die Startzeit für die Dateninspektion. Zulässige Formate sind %Y-%m-%d, %Y-%m-%dT%H:%M:%S oder %Y-%m-%d %H:%M:%S (erforderlich).
• TO_DATE: Das Enddatum und die Endzeit für die Dateninspektion, nach denselben Formaten wie FROM_DATE (erforderlich).

Optionen¶

• --table-name, -tn: Beschränkt die Inspektion auf eine bestimmte Tabelle innerhalb des Projekts.
• --table-filter, -tf: Filtert, sodass nur Tabellen inspiziert werden, die die angegebene Teilzeichenfolge im Namen enthalten.
• --enable_notification, -en: Aktiviert das Versenden von Benachrichtigungen im Fall von Alerts.

Beispiel¶

Um Daten für das Projekt ProjectA vom 1. Januar 2024 bis zum 31. Januar 2024 asynchron zu inspizieren:

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

inspect-status¶

Der Befehl inspect-status in der digna CLI wird verwendet, um den Fortschritt einer asynchronen Inspektion anhand der Request-ID zu prüfen.

Befehlsverwendung¶

dignacli inspect-status <REQUEST ID>

Argumente¶

• REQUEST_ID: Die von inspect-async zurückgegebene Request-ID.

Beispiel¶

Um den Fortschritt einer Inspektion mit der Request-ID 12345 zu prüfen:

dignacli inspect-status 12345

inspect-cancel¶

Der Befehl inspect-cancel in der digna CLI wird verwendet, um Inspektionen anhand der Request-ID abzubrechen oder alle aktuellen Anfragen zu beenden.

Befehlsverwendung¶

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

Argumente¶

• REQUEST_ID: Die von inspect-async zurückgegebene Request-ID.

Beispiel¶

Um die Inspektion mit der Request-ID 12345 abzubrechen:

dignacli inspect-cancel 12345

Um alle derzeit laufenden oder ausstehenden Anfragen abzubrechen:

dignacli inspect-cancel --killall

export-ds¶

Der Befehl export-ds in der digna CLI wird verwendet, um einen Export von Datenquellen aus dem digna-Repository zu erstellen. Standardmäßig werden alle Datenquellen eines gegebenen Projekts exportiert.

Befehlsverwendung¶

dignacli export-ds <PROJECT_NAME> [options]

Argumente¶

• PROJECT_NAME: Der Name des Projekts, aus dem die Datenquellen exportiert werden.

Optionen¶

• --table_name, -tn: Exportiert eine bestimmte Datenquelle aus einem Projekt.
• --exportfile, -ef: Gibt den Dateinamen für den Export an.

Beispiel¶

Um alle Datenquellen aus dem Projekt mit dem Namen ProjectA zu exportieren:

dignacli export-ds ProjectA

Dieser Befehl exportiert alle Datenquellen aus ProjectA als JSON-Dokument, das in ein anderes Projekt oder ein anderes digna-Repository importiert werden kann.

import-ds¶

Der Befehl import-ds in der digna CLI wird verwendet, um Datenquellen in ein Zielprojekt zu importieren und einen Importbericht zu erstellen.

Befehlsverwendung¶

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

Argumente¶

• PROJECT_NAME: Der Name des Projekts, in das die Datenquellen importiert werden sollen.
• EXPORT_FILE: Der Dateiname des zu importierenden Datenquellen-Exports.

Optionen¶

• --output-file, -o: Datei zum Speichern des Importberichts (wenn nicht angegeben, wird der Bericht tabellarisch im Terminal ausgegeben).
• --output-format, -f: Format zum Speichern des Importberichts (json, csv).

Beispiel¶

Um alle Datenquellen aus der Exportdatei my_export.json in ProjectB zu importieren:

dignacli import-ds ProjectB my_export.json

Nach dem Import zeigt dieser Befehl außerdem einen Bericht über importierte und übersprungene Objekte an. Nur neue Datenquellen werden in ProjectB importiert. Um herauszufinden, welche Objekte importiert und welche übersprungen würden, können Sie den Befehl plan-import-ds verwenden.

plan-import-ds¶

Der Befehl plan-import-ds in der digna CLI wird verwendet, um einen Importplan für Datenquellen in ein Zielprojekt zu erstellen und einen Importbericht vorzubereiten.

Befehlsverwendung¶

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

Argumente¶

• PROJECT_NAME: Der Name des Projekts, in das die Datenquellen importiert werden würden.
• EXPORT_FILE: Der Dateiname des Datenquellen-Exports, der vor dem Import analysiert werden soll.

Optionen¶

• --output-file, -o: Datei zum Speichern des Importberichts (wenn nicht angegeben, wird der Bericht tabellarisch im Terminal ausgegeben).
• --output-format, -f: Format zum Speichern des Importberichts (json, csv).

Beispiel¶

Um zu prüfen, welche Datenquellen aus der Exportdatei my_export.json beim Import in ProjectB importiert und welche übersprungen würden:

dignacli plan-import-ds ProjectB my_export.json

Dieser Befehl zeigt lediglich einen Importplan der zu importierenden und zu überspringenden Objekte an.