digna CLI Reference 2026.01¶
2026-01-15
Ta strona dokumentuje pełny zestaw poleceń dostępnych w CLI digna w wydaniu 2026.01, włącznie z przykładami użycia i opcjami.
CLI Basics¶
help¶
Opcja --help dostarcza informacji o dostępnych poleceniach i ich użyciu. Istnieją dwa główne sposoby użycia tej opcji:
-
Wyświetlenie ogólnej pomocy:
Użyj --help bezpośrednio po słowie kluczowym dignacli
dignacli --help -
Uzyskanie pomocy dla konkretnych poleceń:
Aby uzyskać szczegółowe informacje o konkretnym poleceniu, dołącz
--helpdo tego polecenia. Na przykład, aby otrzymać pomoc dotyczącą poleceniaadd-user, uruchom:dignacli add-user --help### wyjście:
- Opis polecenia: Szczegółowy opis działania polecenia.
- Składnia: Pokazuje dokładną składnię, w tym argumenty wymagane i opcjonalne.
- Opcje: Lista opcji specyficznych dla polecenia oraz ich wyjaśnienia.
- Przykłady: Przykłady efektywnego wykonania polecenia.
check-config¶
Polecenie check-config to narzędzie w ramach CLI digna służące do testowania konfiguracji digna. To polecenie sprawdza, czy komponenty digna potrafią znaleźć potrzebne elementy konfiguracyjne w pliku config.toml.
Opcje¶
--configpath,-cp: Plik lub katalog zawierający konfigurację. Jeśli zostanie pominięte, zostanie użyty ../config.toml.
Użycie polecenia¶
dignacli check-config
Po pomyślnym wykonaniu polecenie zwraca potwierdzenie kompletności konfiguracji.
Jeśli konfiguracja wydaje się niekompletna, zostaną wypisane brakujące elementy konfiguracyjne.
check-repo-connection¶
Polecenie check-repo-connection to narzędzie w ramach CLI digna służące do testowania łączności i dostępu do określonego repozytorium digna. Polecenie zapewnia, że CLI może komunikować się z repozytorium.
Użycie polecenia¶
dignacli check-repo-connection
Po pomyślnym wykonaniu polecenie zwraca potwierdzenie połączenia wraz ze szczegółami repozytorium: wersja repozytorium, host, baza danych oraz schemat.
Jeśli połączenie z repozytorium nie powiedzie się, sprawdź plik config.toml pod kątem prawidłowych ustawień konfiguracyjnych.
version¶
Aby sprawdzić zainstalowaną wersję dignacli, użyj opcji --version.
Użycie polecenia¶
dignacli --version
Przykładowe wyjście¶
dignacli version 2026.01
opcje logowania¶
Domyślnie wyjście konsoli poleceń digna jest zaprojektowane jako minimalistyczne. Większość poleceń oferuje możliwość uzyskania dodatkowych informacji, przy użyciu następujących opcji:
-- verbose (-v)
-- debug (-d)
-- logfile (lf)
„verbose” i „debug” określają poziom szczegółowości, natomiast przełącznik „logfile” pozwala przekierować wyjście do pliku zamiast na konsolę.
Zarządzanie użytkownikami¶
add-user¶
Polecenie add-user w CLI digna służy do dodawania nowego użytkownika do systemu digna.
Użycie polecenia¶
dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD
Argumenty¶
- USER_NAME: Nazwa użytkownika dla nowego użytkownika (wymagane).
- USER_FULL_NAME: Pełna nazwa nowego użytkownika (wymagane).
- USER_PASSWORD: Hasło dla nowego użytkownika (wymagane).
Opcje¶
--is_superuser,-su: Flaga oznaczająca, że nowy użytkownik ma uprawnienia administratora.--valid_until,-vu: Ustawia datę wygaśnięcia konta użytkownika w formacieYYYY-MM-DD HH:MI:SS. Jeśli nie zostanie ustawione, konto nie ma daty wygaśnięcia.
Przykład¶
Aby dodać nowego użytkownika o nazwie jdoe, imieniu i nazwisku John Doe oraz haśle password123:
dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD
Aby dodać nowego użytkownika i ustawić datę wygaśnięcia konta:
dignacli add-user jdoe "John Doe" password123 --valid_until "2024-12-31 23:59:59"
delete-user¶
Polecenie delete-user w CLI digna służy do usuwania istniejącego użytkownika z systemu digna.
Użycie polecenia¶
dignacli delete-user USER_NAME
Argumenty¶
- USER_NAME: Nazwa użytkownika, który ma zostać usunięty (wymagane). To jedyny wymagany argument dla tego polecenia.
Przykład¶
dignacli delete-user jdoe
Wykonanie tego polecenia usunie użytkownika jdoe z systemu digna, odbierając mu dostęp i usuwając powiązane dane oraz uprawnienia z repozytorium.
modify-user¶
Polecenie modify-user w CLI digna służy do zaktualizowania danych istniejącego użytkownika w systemie digna.
Użycie polecenia¶
dignacli modify-user <USER_NAME> <USER_FULL_NAME> [options]
Argumenty¶
- USER_NAME: Nazwa użytkownika, który ma zostać zmodyfikowany (wymagane).
- USER_FULL_NAME: Nowa pełna nazwa użytkownika (wymagane).
Opcje¶
--is_superuser,-su: Ustawia użytkownika jako superużytkownika, przyznając podwyższone uprawnienia. Ta flaga nie wymaga wartości.--valid_until,-vu: Ustawia datę wygaśnięcia konta użytkownika w formacie YYYY-MM-DD HH:MI:SS. Jeśli nie zostanie podana, konto pozostaje ważne bez ograniczeń czasowych.
Przykład¶
Aby zmodyfikować pełną nazwę użytkownika jdoe na „Johnathan Doe” i ustawić użytkownika jako superużytkownika:
dignacli modify-user jdoe "Johnathan Doe" --is_superuser
modify-user-pwd¶
Polecenie modify-user-pwd w CLI digna służy do zmiany hasła istniejącego użytkownika w systemie digna.
Użycie polecenia¶
dignacli modify-user-pwd <USER_NAME> <USER_PWD>
Argumenty¶
- USER_NAME: Nazwa użytkownika, którego hasło ma zostać zmienione (wymagane).
- USER_PWD: Nowe hasło dla użytkownika (wymagane).
Przykład¶
Aby zmienić hasło użytkownika jdoe na newpassword123:
dignacli modify-user-pwd jdoe newpassword123
list-users¶
Polecenie list-users w CLI digna wyświetla listę wszystkich użytkowników zarejestrowanych w systemie digna.
Użycie polecenia¶
dignacli list-users
Wykonanie tego polecenia w CLI digna połączy się z repozytorium digna i wyświetli wszystkich użytkowników, pokazując ich ID, nazwę użytkownika, pełne imię i nazwisko, status superużytkownika oraz znaczniki czasowe wygaśnięcia.
Zarządzanie repozytorium¶
upgrade-repo¶
Polecenie upgrade-repo w CLI digna służy do aktualizacji lub inicjalizacji repozytorium digna. To polecenie jest niezbędne do stosowania aktualizacji lub konfiguracji infrastruktury repozytorium po raz pierwszy.
Użycie polecenia¶
dignacli upgrade-repo [options]
Opcje¶
--simulation-mode,-s: Po włączeniu, opcja uruchamia polecenie w trybie symulacji, który drukuje instrukcje SQL, które zostałyby wykonane, ale ich nie wykonuje. Jest to przydatne do podglądu zmian bez dokonywania modyfikacji w repozytorium.
Przykład¶
Aby zaktualizować repozytorium digna, możesz uruchomić polecenie bez opcji:
dignacli upgrade-repo
dignacli upgrade-repo --simulation-mode
To polecenie jest kluczowe dla utrzymania systemu digna, zapewniając, że schemat bazy danych i inne komponenty repozytorium są zgodne z najnowszą wersją oprogramowania.
encrypt¶
Polecenie encrypt w CLI digna służy do zaszyfrowania hasła.
Użycie polecenia¶
dignacli encrypt <PASSWORD>
Argumenty¶
- PASSWORD: Hasło, które ma zostać zaszyfrowane (wymagane).
Przykład¶
Aby zaszyfrować hasło, należy podać hasło jako argument.
Na przykład, aby zaszyfrować hasło mypassword123, użyj:
dignacli encrypt mypassword123
generate-key¶
Polecenie generate-key służy do wygenerowania klucza Fernet, który jest niezbędny do zabezpieczania haseł przechowywanych w repozytorium digna.
Użycie polecenia¶
dignacli generate-key
Zarządzanie danymi¶
clean-up¶
Polecenie clean-up w CLI digna służy do usuwania profili, predykcji i danych systemu sygnalizacji świetlnej dla jednego lub wielu źródeł danych w określonym projekcie. To polecenie jest istotne dla zarządzania cyklem życia danych, pomagając utrzymać porządek i wydajność poprzez usuwanie przestarzałych lub niepotrzebnych danych.
Użycie polecenia¶
dignacli clean-up <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]
Argumenty¶
- PROJECT_NAME: Nazwa projektu, z którego mają być usunięte dane (wymagane). Użycie słowa kluczowego all-projects w tym argumencie instruuje digna, aby iterował po wszystkich istniejących projektach i zastosował to polecenie.
- FROM_DATE: Data i czas rozpoczęcia usuwania danych. Akceptowalne formaty obejmują %Y-%m-%d, %Y-%m-%dT%H:%M:%S lub %Y-%m-%d %H:%M:%S (wymagane).
- TO_DATE: Data i czas zakończenia usuwania danych, zgodnie z tymi samymi formatami co FROM_DATE (wymagane).
Opcje¶
--table-name,-tn: Ogranicza operację clean-up do konkretnej tabeli w projekcie.--table-filter,-tf: Filtruje i ogranicza clean-up do tabel zawierających określony podciąg w nazwie.--timing,-tm: Wyświetla czas trwania procesu clean-up po jego zakończeniu.--help: Wyświetla informacje pomocy dla polecenia clean-up i kończy działanie.
Przykład¶
Aby usunąć dane z projektu ProjectA między 1 stycznia 2023 a 30 czerwca 2023:
dignacli clean-up ProjectA 2023-01-01 2023-06-30
Aby usunąć dane tylko z konkretnej tabeli o nazwie Table1:
dignacli clean-up ProjectA 2023-01-01 2023-06-30 --table-name Table1
To polecenie pomaga w zarządzaniu miejscem na dysku i zapewnia, że repozytorium zawiera tylko istotne informacje.
remove-orphans¶
Polecenie remove-orphans w CLI digna służy do porządkowania repozytorium digna.
Gdy użytkownik usuwa projekty lub źródła danych, profile i predykcje pozostają w repozytorium. To polecenie usuwa takie porzucone wiersze z repozytorium.
Użycie polecenia¶
dignacli list-projects
list-projects¶
Polecenie list-projects w CLI digna służy do wyświetlenia listy wszystkich dostępnych projektów w systemie digna.
Użycie polecenia¶
dignacli list-projects
To polecenie jest szczególnie przydatne dla administratorów i użytkowników zarządzających wieloma projektami, zapewniając szybki przegląd dostępnych projektów w repozytorium digna.
list-ds¶
Polecenie list-ds w CLI digna służy do wyświetlenia listy wszystkich dostępnych źródeł danych w określonym projekcie. Polecenie to pomaga zrozumieć zasoby danych dostępne do analizy i zarządzania w systemie digna.
Użycie polecenia¶
dignacli list-ds <PROJECT_NAME>
Argumenty¶
- PROJECT_NAME: Nazwa projektu, dla którego wyświetlane są źródła danych (wymagane).
Przykład¶
Aby wyświetlić wszystkie źródła danych w projekcie o nazwie ProjectA:
dignacli list-ds ProjectA
To polecenie daje użytkownikom przegląd źródeł danych dostępnych w projekcie, pomagając w nawigacji i zarządzaniu krajobrazem danych.
inspect¶
Polecenie inspect w CLI digna służy do tworzenia profili, predykcji i danych systemu sygnalizacji świetlnej dla jednego lub wielu źródeł danych w określonym projekcie. Polecenie pomaga w analizie i monitorowaniu danych w zdefiniowanym okresie. Po zakończeniu inspekcji zwracana jest wartość obliczonego systemu sygnalizacji świetlnej:
- 0: OK
- 1: INFO
- 2: WARNING
Użycie polecenia¶
dignacli inspect <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]
Argumenty¶
- PROJECT_NAME: Nazwa projektu, dla którego mają być sprawdzone dane (wymagane). Użycie słowa kluczowego all-projects w tym argumencie instruuje digna, aby iterował po wszystkich istniejących projektach i zastosował to polecenie.
- FROM_DATE: Data i czas rozpoczęcia inspekcji danych. Akceptowalne formaty obejmują %Y-%m-%d, %Y-%m-%dT%H:%M:%S lub %Y-%m-%d %H:%M:%S (wymagane).
- TO_DATE: Data i czas zakończenia inspekcji danych, zgodnie z tymi samymi formatami co FROM_DATE (wymagane).
Opcje¶
--table-name,-tn: Ogranicza inspekcję do konkretnej tabeli w projekcie.--table-filter,-tf: Filtruje i inspektuje jedynie tabele zawierające określony podciąg w nazwie.--enable_notification,-en: Włącza wysyłanie powiadomień w przypadku alarmów.--bypass-backend,-bb: Pomija backend i uruchamia inspekcję bezpośrednio z CLI (tylko do celów testowych!).
Przykład¶
Aby przeskanować dane dla projektu ProjectA od 1 stycznia 2024 do 31 stycznia 2024:
dignacli inspect ProjectA 2024-01-01 2024-01-31
Aby sprawdzić tylko konkretną tabelę i wymusić ponowne obliczenie predykcji:
dignacli inspect ProjectA 2024-01-01 2024-01-31 --table-name Table1 --force-prediction
inspect-async¶
Polecenie inspect-async w CLI digna służy do tworzenia profili, predykcji i danych systemu sygnalizacji świetlnej dla jednego lub wielu źródeł danych w określonym projekcie. Polecenie pomaga w analizie i monitorowaniu danych w zdefiniowanym okresie. W przeciwieństwie do polecenia inspect-async, to nie czeka na zakończenie inspekcji. Zamiast tego zwraca identyfikator żądania dla przesłanego zapytania inspekcyjnego. Aby sprawdzić postęp procesu inspekcji, użyj polecenia inspect-status
Użycie polecenia¶
dignacli inspect-async <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]
Argumenty¶
- PROJECT_NAME: Nazwa projektu, dla którego mają być sprawdzone dane (wymagane). Użycie słowa kluczowego all-projects w tym argumencie instruuje digna, aby iterował po wszystkich istniejących projektach i zastosował to polecenie.
- FROM_DATE: Data i czas rozpoczęcia inspekcji danych. Akceptowalne formaty obejmują %Y-%m-%d, %Y-%m-%dT%H:%M:%S lub %Y-%m-%d %H:%M:%S (wymagane).
- TO_DATE: Data i czas zakończenia inspekcji danych, zgodnie z tymi samymi formatami co FROM_DATE (wymagane).
Opcje¶
--table-name,-tn: Ogranicza inspekcję do konkretnej tabeli w projekcie.--table-filter,-tf: Filtruje i inspektuje jedynie tabele zawierające określony podciąg w nazwie.--enable_notification,-en: Włącza wysyłanie powiadomień w przypadku alarmów.
Przykład¶
Aby przeskanować dane dla projektu ProjectA od 1 stycznia 2024 do 31 stycznia 2024:
dignacli inspect-async ProjectA 2024-01-01 2024-01-31
inspect-status¶
Polecenie inspect-status w CLI digna służy do sprawdzania postępu asynchronicznej inspekcji na podstawie identyfikatora żądania.
Użycie polecenia¶
dignacli inspect-status <REQUEST ID>
Argumenty¶
- REQUEST_ID: Identyfikator żądania zwrócony przez polecenie
inspect-async
Przykład¶
Aby sprawdzić postęp inspekcji o identyfikatorze żądania 12345:
dignacli inspect-status 12345
inspect-cancel¶
Polecenie inspect-cancel w CLI digna służy do anulowania inspekcji na podstawie identyfikatora żądania lub może być użyte do anulowania wszystkich aktualnych żądań.
Użycie polecenia¶
dignacli inspect-cancel <REQUEST ID>
dignacli inspect-cancel --killall
Argumenty¶
- REQUEST_ID: Identyfikator żądania zwrócony przez polecenie
inspect-async
Przykład¶
Aby anulować inspekcję o identyfikatorze żądania 12345:
dignacli inspect-cancel 12345
Aby anulować wszystkie żądania, które są obecnie uruchomione lub oczekujące:
dignacli inspect-cancel --killall
export-ds¶
Polecenie export-ds w CLI digna służy do utworzenia eksportu źródeł danych z repozytorium digna. Domyślnie eksportowane są wszystkie źródła danych z danego projektu.
Użycie polecenia¶
dignacli export-ds <PROJECT_NAME> [options]
Argumenty¶
- PROJECT_NAME: Nazwa projektu, z którego będą eksportowane źródła danych.
Opcje¶
--table_name,-tn: Eksport konkretnego źródła danych z projektu.--exportfile,-ef: Określenie nazwy pliku dla eksportu.
Przykład¶
Aby wyeksportować wszystkie źródła danych z projektu o nazwie ProjectA:
dignacli export-ds ProjectA
To polecenie eksportuje wszystkie źródła danych z ProjectA jako dokument JSON, który można zaimportować do innego projektu lub repozytorium digna.
import-ds¶
Polecenie import-ds w CLI digna służy do importowania źródeł danych do docelowego projektu i utworzenia raportu importu.
Użycie polecenia¶
dignacli import-ds <PROJECT_NAME> <EXPORT_FILE> [options]
Argumenty¶
- PROJECT_NAME: Nazwa projektu, do którego będą importowane źródła danych.
- EXPORT_FILE: Nazwa pliku eksportu źródeł danych, który ma zostać zaimportowany.
Opcje¶
--output-file,-o: Plik do zapisania raportu z importu (jeśli nie określono, drukuje w terminalu w formie tabelarycznej).--output-format,-f: Format zapisu raportu z importu (json, csv).
Przykład¶
Aby zaimportować wszystkie źródła danych z pliku eksportu my_export.json do ProjectB:
dignacli import-ds ProjectB my_export.json
Po imporcie to polecenie pokaże również raport zaimportowanych i pominiętych obiektów. Do ProjectB zostaną zaimportowane tylko nowe źródła danych. Aby dowiedzieć się, które obiekty zostałyby zaimportowane, a które pominięte, można użyć polecenia plan-import-ds
plan-import-ds¶
Polecenie plan-import-ds w CLI digna służy do zaplanowania importu źródeł danych do docelowego projektu i utworzenia raportu importu bez rzeczywistego wykonania importu.
Użycie polecenia¶
dignacli plan-import-ds <PROJECT_NAME> <EXPORT_FILE> [options]
Argumenty¶
- PROJECT_NAME: Nazwa projektu, do którego źródła danych zostałyby zaimportowane.
- EXPORT_FILE: Nazwa pliku eksportu źródeł danych do analizy przed importem.
Opcje¶
--output-file,-o: Plik do zapisania raportu z importu (jeśli nie określono, drukuje w terminalu w formie tabelarycznej).--output-format,-f: Format zapisu raportu z importu (json, csv).
Przykład¶
Aby sprawdzić, które źródła danych zostałyby zaimportowane, a które pominięte z pliku eksportu my_export.json przy imporcie do ProjectB:
dignacli plan-import-ds ProjectB my_export.json
To polecenie pokaże jedynie plan importu obiektów do zaimportowania i pominięcia.