digna CLI Reference 2026.04¶

2026-04-08

Tato stránka dokumentuje kompletní sadu příkazů dostupných v CLI digna verze 2026.04, včetně ukázek použití a možností.

Základy CLI¶

help¶

Možnost --help poskytuje informace o dostupných příkazech a jejich použití. Existují dva hlavní způsoby, jak tuto možnost použít:

1. Zobrazení obecné nápovědy:

   Použijte --help bezprostředně za příkazem dignacli
   

   dignacli --help
   

2. Získání nápovědy pro konkrétní příkaz:

   Pro podrobné informace o konkrétním příkazu připojte --help k tomuto příkazu. Například pro získání nápovědy k příkazu add-user spusťte:

   dignacli add-user --help
   

   ### výstup:

   • Popis příkazu: Nabízí podrobný popis toho, co příkaz dělá.
   • Syntaxe: Zobrazuje přesnou syntaxi, včetně povinných a volitelných argumentů.
   • Možnosti: Vypisuje případné možnosti specifické pro příkaz spolu s jejich vysvětlením.
   • Příklady: Uvádí příklady, jak příkaz efektivně použít.

check-config¶

Příkaz check-config je nástroj v CLI digna určený k otestování konfigurace digna. Tento příkaz ověřuje, že komponenty digna najdou v souboru config.toml potřebné konfigurační prvky.

Možnosti¶

• --configpath, -cp: Soubor nebo adresář, který obsahuje konfiguraci. Pokud není zadáno, použije se ../config.toml.

Použití příkazu¶

dignacli check-config

Po úspěšném provedení příkaz vypíše potvrzení o úplnosti konfigurace.

Pokud se konfigurace jeví jako neúplná, budou vypsány chybějící konfigurační prvky.

check-repo-connection¶

Příkaz check-repo-connection je nástroj v CLI digna určený k otestování konektivity a přístupu ke specifikovanému repozitáři digna. Tento příkaz ověřuje, že CLI může s repozitářem komunikovat.

Použití příkazu¶

dignacli check-repo-connection

Po úspěšném provedení příkaz vypíše potvrzení o připojení spolu s detaily o repozitáři: verze repozitáře, hostitel, databáze a schéma.

Pokud připojení k repozitáři není úspěšné, zkontrolujte v souboru config.toml správnost konfiguračních nastavení.

version¶

Pro zjištění nainstalované verze dignacli použijte volbu --version.

Použití příkazu¶

dignacli --version

Příklad výstupu¶

dignacli version 2026.04

možnosti logování¶

Ve výchozím nastavení je výstup příkazů digna na konzoli minimální. Většina příkazů nabízí možnost poskytnout dodatečné informace pomocí následujících možností:

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

„verbose“ a „debug“ určují úroveň podrobností, zatímco přepínač „logfile“ umožňuje přesměrovat výstup do souboru namísto konzole.

Správa uživatelů¶

add-user¶

Příkaz add-user v CLI digna slouží k přidání nového uživatele do systému digna.

Použití příkazu¶

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Argumenty¶

• USER_NAME: Uživatelské jméno nového uživatele (povinné).
• USER_FULL_NAME: Celé jméno nového uživatele (povinné).
• USER_PASSWORD: Heslo nového uživatele (povinné).

Možnosti¶

• --is_superuser, -su: Přepínač pro označení nového uživatele jako administrátora.
• --valid_until, -vu: Nastaví datum vypršení platnosti účtu ve formátu YYYY-MM-DD HH:MI:SS. Pokud není nastaveno, účet nemá datum vypršení.

Příklad¶

Pro přidání nového uživatele s uživatelským jménem jdoe, celým jménem John Doe a heslem password123:

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Pro přidání nového uživatele a nastavení data vypršení účtu:

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

delete-user¶

Příkaz delete-user v CLI digna slouží k odstranění existujícího uživatele ze systému digna.

Použití příkazu¶

dignacli delete-user USER_NAME

Argumenty¶

• USER_NAME: Uživatelské jméno uživatele, který má být smazán (povinné). Toto je jediný požadovaný argument příkazu.

Příklad¶

dignacli delete-user jdoe

Provedením tohoto příkazu bude uživatel jdoe odstraněn ze systému digna, čímž mu bude odňat přístup a budou smazána jeho související data a oprávnění z repozitáře.

modify-user¶

Příkaz modify-user v CLI digna slouží k aktualizaci údajů existujícího uživatele v systému digna.

Použití příkazu¶

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

Argumenty¶

• USER_NAME: Uživatelské jméno uživatele, kterého je třeba upravit (povinné).
• USER_FULL_NAME: Nové celé jméno uživatele (povinné).

Možnosti¶

• --is_superuser, -su: Nastaví uživatele jako superuživatele, čímž mu udělí zvýšená oprávnění. Tento přepínač nevyžaduje hodnotu.
• --valid_until, -vu: Nastaví datum vypršení platnosti účtu ve formátu YYYY-MM-DD HH:MI:SS. Pokud není poskytnuto, účet zůstává platný neomezeně.

Příklad¶

Pro změnu celého jména uživatele jdoe na „Johnathan Doe“ a zároveň nastavení uživatele jako superuživatele:

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

modify-user-pwd¶

Příkaz modify-user-pwd v CLI digna slouží ke změně hesla existujícího uživatele v systému digna.

Použití příkazu¶

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

Argumenty¶

• USER_NAME: Uživatelské jméno uživatele, jehož heslo se má změnit (povinné).
• USER_PWD: Nové heslo uživatele (povinné).

Příklad¶

Pro změnu hesla uživatele jdoe na newpassword123:

dignacli modify-user-pwd jdoe newpassword123

list-users¶

Příkaz list-users v CLI digna zobrazí seznam všech uživatelů registrovaných v systému digna.

Použití příkazu¶

dignacli list-users

Spuštěním tohoto příkazu se CLI připojí k repozitáři digna a vylistuje všechny uživatele, zobrazí jejich ID, uživatelské jméno, celé jméno, status superuživatele a časy vypršení platnosti.

Správa repozitáře¶

upgrade-repo¶

Příkaz upgrade-repo v CLI digna slouží k upgradu nebo inicializaci repozitáře digna. Tento příkaz je nezbytný pro aplikaci aktualizací nebo nastavení infrastruktury repozitáře poprvé.

Použití příkazu¶

dignacli upgrade-repo [options]

Možnosti¶

• --simulation-mode, -s: Po aktivaci spustí příkaz v simulačním režimu, který vytiskne SQL příkazy, jež by byly vykonány, ale ve skutečnosti je neprovede. To je užitečné pro náhled změn bez jejich aplikace.

Příklad¶

Pro upgrade repozitáře digna můžete spustit příkaz bez jakýchkoli možností:

dignacli upgrade-repo

dignacli upgrade-repo --simulation-mode

Tento příkaz je klíčový pro udržování systému digna, zajišťuje, že schéma databáze a další komponenty repozitáře jsou aktuální s nejnovější verzí softwaru.

encrypt¶

Příkaz encrypt v CLI digna slouží k zašifrování hesla.

Použití příkazu¶

dignacli encrypt <PASSWORD>

Argumenty¶

• PASSWORD: Heslo, které je třeba zašifrovat (povinné).

Příklad¶

Pro zašifrování hesla musíte heslo předat jako argument.
Například pro zašifrování hesla mypassword123 použijte:

dignacli encrypt mypassword123

generate-key¶

Příkaz generate-key slouží k vygenerování Fernet klíče, který je nezbytný k zabezpečení hesel uložených v repozitáři digna.

Použití příkazu¶

dignacli generate-key

Správa dat¶

clean-up¶

Příkaz clean-up v CLI digna slouží k odstranění profilů, predikcí a dat systému semaforů pro jeden nebo více datových zdrojů v rámci specifikovaného projektu. Tento příkaz je důležitý pro řízení životního cyklu dat a pomáhá udržet přehledné a efektivní prostředí odstraněním zastaralých nebo nepotřebných dat.

Použití příkazu¶

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

Argumenty¶

• PROJECT_NAME: Název projektu, ze kterého mají být data odstraněna (povinné). Použití klíčového slova all-projects v tomto argumentu instruuje digna, aby iterovalo přes všechny existující projekty a aplikovalo tento příkaz.
• FROM_DATE: Počáteční datum a čas pro odstranění dat. Přijatelné formáty zahrnují %Y-%m-%d, %Y-%m-%dT%H:%M:%S nebo %Y-%m-%d %H:%M:%S (povinné).
• TO_DATE: Konečné datum a čas pro odstranění dat, v stejných formátech jako FROM_DATE (povinné).

Možnosti¶

• --table-name, -tn: Omezuje operaci clean-up na konkrétní tabulku v projektu.
• --table-filter, -tf: Filtruje tabulky tak, aby se čistilo pouze v tabulkách obsahujících zadaný podřetězec v jejich názvech.
• --timing, -tm: Po dokončení zobrazí dobu trvání procesu clean-up.
• --help: Zobrazí nápovědu pro příkaz clean-up a ukončí se.

Příklad¶

Pro odstranění dat z projektu ProjectA mezi 1. lednem 2023 a 30. červnem 2023:

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

Pro odstranění dat pouze z konkrétní tabulky s názvem Table1:

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

Tento příkaz pomáhá spravovat úložiště dat a zajistit, že repozitář obsahuje pouze relevantní informace.

remove-orphans¶

Příkaz remove-orphans v CLI digna slouží k údržbě repozitáře digna.
Když uživatel smaže projekty nebo datové zdroje, profily a predikce mohou v repozitáři zůstat jako osiřelé záznamy. Pomocí tohoto příkazu budou takové osiřelé řádky odstraněny z repozitáře.

Použití příkazu¶

dignacli list-projects

list-projects¶

Příkaz list-projects v CLI digna slouží k zobrazení seznamu všech dostupných projektů v systému digna.

Použití příkazu¶

dignacli list-projects

Tento příkaz je obzvláště užitečný pro administrátory a uživatele spravující více projektů, poskytuje rychlý přehled dostupných projektů v repozitáři digna.

list-ds¶

Příkaz list-ds v CLI digna slouží k zobrazení seznamu všech dostupných datových zdrojů v rámci specifikovaného projektu. Tento příkaz je užitečný pro orientaci v datech dostupných pro analýzu a správu v systému digna.

Použití příkazu¶

dignacli list-ds <PROJECT_NAME>

Argumenty¶

• PROJECT_NAME: Název projektu, pro který se datové zdroje vypisují (povinné).

Příklad¶

Pro vypsání všech datových zdrojů v projektu s názvem ProjectA:

dignacli list-ds ProjectA

Tento příkaz poskytuje uživatelům přehled o datových zdrojích dostupných v projektu, což jim pomáhá efektivněji se orientovat a spravovat datovou krajinu.

inspect¶

Příkaz inspect v CLI digna slouží k vytvoření profilů, predikcí a dat systému semaforů pro jeden nebo více datových zdrojů v rámci specifikovaného projektu. Tento příkaz pomáhá při analýze a monitorování dat v definovaném časovém období. Po dokončení inspekce je vrácena hodnota vypočteného stavu systému semaforů:
- 0: OK
- 1: INFO
- 2: WARNING

Použití příkazu¶

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

Argumenty¶

• PROJECT_NAME: Název projektu, pro který mají být data inspektována (povinné). Použití klíčového slova all-projects v tomto argumentu instruuje digna, aby iterovalo přes všechny existující projekty a aplikovalo tento příkaz.
• FROM_DATE: Počáteční datum a čas inspekce dat. Přijatelné formáty zahrnují %Y-%m-%d, %Y-%m-%dT%H:%M:%S nebo %Y-%m-%d %H:%M:%S (povinné).
• TO_DATE: Konečné datum a čas inspekce dat, ve stejných formátech jako FROM_DATE (povinné).

Možnosti¶

• --table-name, -tn: Omezuje inspekci na konkrétní tabulku v projektu.
• --table-filter, -tf: Filtruje a inspektuje pouze tabulky obsahující zadaný podřetězec v jejich názvech.
• --enable_notification, -en: Umožní odesílání notifikací v případě alertů.
• --bypass-backend, -bb: Obchází backend a spustí inspekci přímo z CLI (pouze pro testovací účely!).

Příklad¶

Pro inspekci dat pro projekt ProjectA od 1. ledna 2024 do 31. ledna 2024:

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

Pro inspekci pouze specifické tabulky a vynucení přepočtu predikcí:

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

inspect-async¶

Příkaz inspect-async v CLI digna slouží k vytvoření profilů, predikcí a dat systému semaforů pro jeden nebo více datových zdrojů v rámci specifikovaného projektu. Tento příkaz pomáhá při analýze a monitorování dat v definovaném časovém období. Na rozdíl od příkazu inspect tento příkaz nečeká na dokončení inspekce. Místo toho vrací ID požadavku pro odeslanou inspekční úlohu. Pro dotazování na průběh inspekce použijte příkaz inspect-status.

Použití příkazu¶

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

Argumenty¶

• PROJECT_NAME: Název projektu, pro který mají být data inspektována (povinné). Použití klíčového slova all-projects v tomto argumentu instruuje digna, aby iterovalo přes všechny existující projekty a aplikovalo tento příkaz.
• FROM_DATE: Počáteční datum a čas inspekce dat. Přijatelné formáty zahrnují %Y-%m-%d, %Y-%m-%dT%H:%M:%S nebo %Y-%m-%d %H:%M:%S (povinné).
• TO_DATE: Konečné datum a čas inspekce dat, ve stejných formátech jako FROM_DATE (povinné).

Možnosti¶

• --table-name, -tn: Omezuje inspekci na konkrétní tabulku v projektu.
• --table-filter, -tf: Filtruje a inspektuje pouze tabulky obsahující zadaný podřetězec v jejich názvech.
• --enable_notification, -en: Umožní odesílání notifikací v případě alertů.

Příklad¶

Pro asynchronní inspekci dat pro projekt ProjectA od 1. ledna 2024 do 31. ledna 2024:

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

inspect-status¶

Příkaz inspect-status v CLI digna slouží ke kontrole průběhu asynchronní inspekce na základě ID požadavku.

Použití příkazu¶

dignacli inspect-status <REQUEST ID>

Argumenty¶

• REQUEST_ID: ID požadavku vrácené příkazem inspect-async

Příklad¶

Pro kontrolu průběhu inspekce s ID požadavku 12345:

dignacli inspect-status 12345

inspect-cancel¶

Příkaz inspect-cancel v CLI digna slouží ke zrušení inspekcí na základě ID požadavku, nebo lze použít k zrušení všech aktuálních požadavků.

Použití příkazu¶

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

Argumenty¶

• REQUEST_ID: ID požadavku vrácené příkazem inspect-async

Příklad¶

Pro zrušení inspekce s ID požadavku 12345:

dignacli inspect-cancel 12345

Pro zrušení všech požadavků, které jsou aktuálně spuštěné nebo čekající:

dignacli inspect-cancel --killall

export-ds¶

Příkaz export-ds v CLI digna slouží k vytvoření exportu datových zdrojů z repozitáře digna. Ve výchozím nastavení budou exportovány všechny datové zdroje z daného projektu.

Použití příkazu¶

dignacli export-ds <PROJECT_NAME> [options]

Argumenty¶

• PROJECT_NAME: Název projektu, ze kterého budou datové zdroje exportovány.

Možnosti¶

• --table_name, -tn: Exportovat konkrétní datový zdroj z projektu.
• --exportfile, -ef: Určit název souboru pro export.

Příklad¶

Pro export všech datových zdrojů z projektu s názvem ProjectA:

dignacli export-ds ProjectA

Tento příkaz exportuje všechny datové zdroje z ProjectA jako JSON dokument, který lze importovat do jiného projektu nebo repozitáře digna.

import-ds¶

Příkaz import-ds v CLI digna slouží k importu datových zdrojů do cílového projektu a vytvoření importního reportu.

Použití příkazu¶

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

Argumenty¶

• PROJECT_NAME: Název projektu, do kterého budou datové zdroje importovány.
• EXPORT_FILE: Název souboru s exportem datových zdrojů, který má být importován.

Možnosti¶

• --output-file, -o: Soubor pro uložení importního reportu (pokud není zadáno, vytiskne se do terminálu v tabulární podobě).
• --output-format, -f: Formát pro uložení importního reportu (json, csv).

Příklad¶

Pro import všech datových zdrojů ze souboru exportu my_export.json do ProjectB:

dignacli import-ds ProjectB my_export.json

Po importu tento příkaz také zobrazí report importovaných a přeskočených objektů. Do ProjectB budou importovány pouze nové datové zdroje. Pokud chcete zjistit, které objekty by byly importovány a které přeskočeny, můžete použít příkaz plan-import-ds.

plan-import-ds¶

Příkaz plan-import-ds v CLI digna slouží k analyzování exportu datových zdrojů pro import do cílového projektu a vytvoření plánu importu.

Použití příkazu¶

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

Argumenty¶

• PROJECT_NAME: Název projektu, do kterého by byly datové zdroje importovány.
• EXPORT_FILE: Název souboru s exportem datových zdrojů, který má být analyzován před importem.

Možnosti¶

• --output-file, -o: Soubor pro uložení importního reportu (pokud není zadáno, vytiskne se do terminálu v tabulární podobě).
• --output-format, -f: Formát pro uložení importního reportu (json, csv).

Příklad¶

Pro kontrolu, které datové zdroje by byly importovány a které přeskočeny ze souboru exportu my_export.json při importu do ProjectB:

dignacli plan-import-ds ProjectB my_export.json

Tento příkaz pouze zobrazí plán importu objektů, které by byly importovány nebo přeskočeny.