digna CLI Reference 2025.09¶
2025-09-29
Ta strona dokumentuje pełny zestaw poleceń dostępnych w narzędziu CLI digna w wydaniu 2025.09, wraz 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 korzystania z tej opcji:
-
Wyświetlenie ogólnej pomocy:
Użyj --help bezpośrednio po słowie kluczowym dignacl
-
Uzyskanie pomocy dla konkretnego polecenia:
Aby uzyskać szczegółowe informacje o konkretnym poleceniu, dodaj
--helpdo tego polecenia. Na przykład, aby uzyskać pomoc dla poleceniaadd-user, uruchom:### output:
- 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 wraz z wyjaśnieniami.
- Przykłady: Przykłady skutecznego wykonania polecenia.
check-config¶
Polecenie check-config to narzędzie w ramach CLI digna służące do testowania konfiguracji digna. Polecenie to sprawdza, czy komponenty digna potrafią znaleźć wymagane elementy konfiguracyjne w pliku config.toml.
Opcje¶
--configpath,-cp: Plik lub katalog zawierający konfigurację. Jeśli pominięte, używany będzie ../config.toml.
Użycie polecenia¶
Po pomyślnym wykonaniu polecenie wyświetli potwierdzenie kompletności konfiguracji.
Jeśli konfiguracja jest niepełna, zostaną wyszczególnione 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 to sprawdza, czy CLI może wchodzić w interakcję z repozytorium.
Użycie polecenia¶
Po pomyślnym wykonaniu polecenie wyświetli potwierdzenie połączenia wraz ze szczegółami repozytorium: wersja repozytorium, host, baza danych i schemat.
Jeśli połączenie z repozytorium nie powiedzie się, sprawdź plik config.toml pod kątem poprawnych ustawień konfiguracyjnych.
version¶
Aby sprawdzić zainstalowaną wersję dignacli, użyj opcji --version.
Użycie polecenia¶
Przykładowy wynik¶
logging options¶
Domyślnie wyjście konsoli poleceń digna jest minimalistyczne. Większość poleceń oferuje możliwość uzyskania dodatkowych informacji, używając 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 do okna konsoli.
User Management¶
add-user¶
Polecenie add-user w CLI digna służy do dodania nowego użytkownika do systemu digna.
Użycie polecenia¶
Argumenty¶
- USER_NAME: Nazwa użytkownika dla nowego użytkownika (wymagane).
- USER_FULL_NAME: Pełne imię i nazwisko nowego użytkownika (wymagane).
- USER_PASSWORD: Hasło dla nowego użytkownika (wymagane).
Opcje¶
--is_superuser,-su: Flaga oznaczająca przyznanie nowemu użytkownikowi uprawnień administratora.--valid_until,-vu: Ustawia datę wygaśnięcia konta użytkownika w formacieYYYY-MM-DD HH:MI:SS. Jeśli nie ustawiono, konto nie ma daty wygaśnięcia.
Przykład¶
Aby dodać nowego użytkownika o nazwie użytkownika jdoe, pełnym imieniu John Doe i haśle password123:
Aby dodać nowego użytkownika i ustawić datę wygaśnięcia konta:
delete-user¶
Polecenie delete-user w CLI digna służy do usunięcia istniejącego użytkownika z systemu digna.
Użycie polecenia¶
Argumenty¶
- USER_NAME: Nazwa użytkownika do usunięcia (wymagane). To jedyny wymagany argument polecenia.
Przykład¶
Wykonanie tego polecenia usunie użytkownika jdoe z systemu digna, odbierając mu dostęp oraz usuwając powiązane dane i uprawnienia z repozytorium.
modify-user¶
Polecenie modify-user w CLI digna służy do aktualizacji danych istniejącego użytkownika w systemie digna.
Użycie polecenia¶
Argumenty¶
- USER_NAME: Nazwa użytkownika, którego dane mają zostać zmodyfikowane (wymagane).
- USER_FULL_NAME: Nowe pełne imię i nazwisko użytkownika (wymagane).
Opcje¶
--is_superuser,-su: Ustawia użytkownika jako superużytkownika, nadając podwyższone uprawnienia. Flaga nie wymaga wartości.--valid_until,-vu: Ustawia datę wygaśnięcia konta w formacie YYYY-MM-DD HH:MI:SS. Jeśli nie podano, konto pozostaje ważne bezterminowo.
Przykład¶
Aby zmienić pełne imię użytkownika jdoe na „Johnathan Doe” i ustawić go jako superużytkownika:
modify-user-pwd¶
Polecenie modify-user-pwd w CLI digna służy do zmiany hasła dla istniejącego użytkownika w systemie digna.
Użycie polecenia¶
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:
list-users¶
Polecenie list-users w CLI digna wyświetla listę wszystkich użytkowników zarejestrowanych w systemie digna.
Użycie polecenia¶
Wykonanie tego polecenia spowoduje połączenie z repozytorium digna i wyświetlenie 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.
Repository Management¶
upgrade-repo¶
Polecenie upgrade-repo w CLI digna służy do aktualizacji lub inicjalizacji repozytorium digna. Polecenie to jest niezbędne do stosowania aktualizacji lub do pierwszorazowego skonfigurowania infrastruktury repozytorium.
Użycie polecenia¶
Opcje¶
--simulation-mode,-s: Po włączeniu polecenie działa w trybie symulacji, wypisując instrukcje SQL, które zostałyby wykonane, ale ich nie wykonuje. Przydatne do podglądu zmian bez modyfikowania repozytorium.
Przykład¶
Aby zaktualizować repozytorium digna, możesz uruchomić polecenie bez opcji:
Aby uruchomić aktualizację w trybie symulacji (zobaczyć instrukcje SQL bez ich zastosowania):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¶
Argumenty¶
- PASSWORD: Hasło, które ma zostać zaszyfrowane (wymagane).
Przykład¶
Aby zaszyfrować hasło, należy podać je jako argument.
Na przykład, aby zaszyfrować hasło mypassword123, użyj:
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¶
Data Management¶
clean-up¶
Polecenie clean-up w CLI digna służy do usuwania profili, predykcji oraz danych systemu sygnalizacji świetlnej dla jednego lub więcej źródeł danych w ramach określonego projektu. Polecenie to jest istotne dla zarządzania cyklem życia danych, pomagając utrzymać uporządkowane i wydajne środowisko danych poprzez czyszczenie przestarzałych lub niepotrzebnych informacji.
Użycie polecenia¶
Argumenty¶
- PROJECT_NAME: Nazwa projektu, z którego mają zostać usunięte dane (wymagane). Użycie słowa kluczowego all-projects w tym argumencie instruuje digna, aby przeiterowało po wszystkich istniejących projektach i zastosowało to polecenie.
- FROM_DATE: Data i czas rozpoczęcia usuwania danych. Akceptowalne formaty to %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, w tych samych formatach co FROM_DATE (wymagane).
Opcje¶
--table-name,-tn: Ogranicza operację clean-up do konkretnej tabeli w projekcie.--table-filter,-tf: Filtr ograniczający 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:
Aby usunąć dane tylko z konkretnej tabeli o nazwie Table1:
To polecenie pomaga w zarządzaniu miejscem na dane i zapewnia, że repozytorium zawiera jedynie 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 mogą pozostać w repozytorium. Dzięki temu poleceniu takie osierocone wiersze zostaną usunięte z repozytorium.
Użycie polecenia¶
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¶
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 jest przydatne do zrozumienia zasobów danych dostępnych do analizy i zarządzania w systemie digna.
Użycie polecenia¶
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:
To polecenie daje użytkownikom przegląd dostępnych w projekcie źródeł danych, ułatwiając nawigację i zarządzanie krajobrazem danych.
inspect¶
Polecenie inspect w CLI digna służy do tworzenia profili, predykcji oraz danych systemu sygnalizacji świetlnej dla jednego lub więcej źródeł danych w określonym projekcie. Polecenie to pomaga w analizie i monitorowaniu danych w określonym okresie. Po zakończeniu inspekcji zwracana jest wartość obliczonego systemu sygnalizacji świetlnej:
- 0: OK
- 1: INFO
- 2: WARNING
Użycie polecenia¶
Argumenty¶
- PROJECT_NAME: Nazwa projektu, dla którego mają zostać zbadane dane (wymagane). Użycie słowa kluczowego all-projects w tym argumencie instruuje digna, aby przeiterowało po wszystkich istniejących projektach i zastosowało to polecenie.
- FROM_DATE: Data i czas rozpoczęcia inspekcji danych. Akceptowalne formaty to %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, w tych samych formatach co FROM_DATE (wymagane).
Opcje¶
--table-name,-tn: Ogranicza inspekcję do konkretnej tabeli w projekcie.--table-filter,-tf: Filtruje tak, aby inspekcja obejmowała tylko tabele zawierające określony podciąg w nazwie.--enable_notification,-en: Włącza wysyłanie powiadomień w przypadku alertów.--bypass-backend,-bb: Pomija backend i uruchamia inspekcję bezpośrednio z CLI (tylko do celów testowych!).
Przykład¶
Aby sprawdzić dane projektu ProjectA od 1 stycznia 2024 do 31 stycznia 2024:
Aby sprawdzić tylko konkretną tabelę i wymusić ponowne obliczenie predykcji:
To polecenie jest przydatne do generowania zaktualizowanych profili i predykcji, monitorowania integralności danych oraz zarządzania systemem alertów w określonym przedziale czasowym projektu.inspect-async¶
Polecenie inspect-async w CLI digna służy do tworzenia profili, predykcji oraz danych systemu sygnalizacji świetlnej dla jednego lub więcej źródeł danych w określonym projekcie. Polecenie to pomaga w analizie i monitorowaniu danych w określonym okresie. W przeciwieństwie do polecenia inspect, to polecenie nie czeka na zakończenie inspekcji. Zamiast tego zwraca identyfikator żądania dla wysłanego zadania inspekcji. Aby sprawdzić postęp procesu inspekcji, użyj polecenia inspect-status.
Użycie polecenia¶
Argumenty¶
- PROJECT_NAME: Nazwa projektu, dla którego mają zostać zbadane dane (wymagane). Użycie słowa kluczowego all-projects w tym argumencie instruuje digna, aby przeiterowało po wszystkich istniejących projektach i zastosowało to polecenie.
- FROM_DATE: Data i czas rozpoczęcia inspekcji danych. Akceptowalne formaty to %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, w tych samych formatach co FROM_DATE (wymagane).
Opcje¶
--table-name,-tn: Ogranicza inspekcję do konkretnej tabeli w projekcie.--table-filter,-tf: Filtruje tak, aby inspekcja obejmowała tylko tabele zawierające określony podciąg w nazwie.--enable_notification,-en: Włącza wysyłanie powiadomień w przypadku alertów.
Przykład¶
Aby uruchomić inspekcję danych dla projektu ProjectA od 1 stycznia 2024 do 31 stycznia 2024:
inspect-status¶
Polecenie inspect-status w CLI digna służy do sprawdzania postępu asynchronicznej inspekcji na podstawie identyfikatora żądania.
Użycie polecenia¶
Argumenty¶
- REQUEST_ID: Identyfikator żądania zwrócony przez polecenie
inspect-async
Przykład¶
Aby sprawdzić postęp inspekcji o identyfikatorze żądania 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 bieżących żądań.
Użycie polecenia¶
Argumenty¶
- REQUEST_ID: Identyfikator żądania zwrócony przez polecenie
inspect-async
Przykład¶
Aby anulować inspekcję o identyfikatorze żądania 12345:
Aby anulować wszystkie żądania, które są aktualnie w toku lub oczekujące:
export-ds¶
Polecenie export-ds w CLI digna służy do wygenerowania eksportu źródeł danych z repozytorium digna. Domyślnie eksportowane są wszystkie źródła danych z danego projektu.
Użycie polecenia¶
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:
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 importu źródeł danych do docelowego projektu oraz wygenerowania raportu z importu.
Użycie polecenia¶
Argumenty¶
- PROJECT_NAME: Nazwa projektu, do którego będą importowane źródła danych.
- EXPORT_FILE: Nazwa pliku z eksportem źródeł danych, który ma zostać zaimportowany.
Opcje¶
--output-file,-o: Plik, do którego zostanie zapisany raport z importu (jeśli nie określono, raport jest drukowany 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:
Po imporcie polecenie pokaże również raport zaimportowanych i pominiętych obiektów. Do ProjectB zostaną zaimportowane tylko nowe źródła danych. Aby sprawdzić, które obiekty zostałyby zaimportowane, a które pominięte, możesz użyć polecenia plan-import-ds.
plan-import-ds¶
Polecenie plan-import-ds w CLI digna służy do przygotowania planu importu źródeł danych do docelowego projektu oraz wygenerowania raportu przed właściwym importem.
Użycie polecenia¶
Argumenty¶
- PROJECT_NAME: Nazwa projektu, do którego źródła danych byłyby importowane.
- EXPORT_FILE: Nazwa pliku z eksportem źródeł danych, który ma zostać przeanalizowany przed importem.
Opcje¶
--output-file,-o: Plik, do którego zostanie zapisany raport z planu importu (jeśli nie określono, raport jest drukowany w terminalu w formie tabelarycznej).--output-format,-f: Format zapisu raportu (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 podczas importu do ProjectB:
To polecenie pokaże jedynie plan importu obiektów, które zostałyby zaimportowane i pominięte.