digna CLI Reference 2026.01¶

2026-01-15

На цій сторінці задокументовано повний набір команд, доступних у CLI digna версії 2026.01, включно з прикладами використання та опціями.

Основи CLI¶

help¶

Опція --help надає інформацію про доступні команди та їх використання. Існує два основні способи використання цієї опції:

Відображення загальної довідки:

Використовуйте –help безпосередньо після ключового слова dignacl
```
dignacli --help
```
Отримання довідки для конкретних команд:

Для детальної інформації про певну команду додайте --help до цієї команди. Наприклад, щоб отримати довідку по команді add-user, виконайте:
```
dignacli add-user --help
```
### вивід:
- Опис команди: Детальний опис того, що робить команда.
- Синтаксис: Показує точний синтаксис, включно з обов'язковими та необов'язковими аргументами.
- Опції: Перелік опцій конкретної команди з їх поясненнями.
- Приклади: Приклади того, як ефективно виконувати команду.

check-config¶

Команда check-config — це утиліта в CLI digna, призначена для перевірки конфігурації digna. Ця команда забезпечує перевірку того, що компоненти digna можуть знайти необхідні елементи конфігурації у config.toml.

Опції¶

--configpath, -cp: Файл або каталог, який містить конфігурацію. Якщо не вказано, використовується ../config.toml.

Використання команди¶

dignacli check-config

Після успішного виконання команда виводить підтвердження повноти конфігурації.

Якщо конфігурація виявиться неповною, буде наведено список відсутніх елементів конфігурації.

check-repo-connection¶

Команда check-repo-connection — це утиліта в CLI digna, призначена для перевірки підключення та доступу до вказаного репозиторія digna. Ця команда гарантує, що CLI може взаємодіяти з репозиторієм.

Використання команди¶

dignacli check-repo-connection

Після успішного виконання команда виводить підтвердження з'єднання разом з деталями про репозиторій: версія репозиторія, Host, Database та Schema.

Якщо підключення до репозиторія не вдалося, перевірте файл config.toml на предмет коректних налаштувань.

version¶

Щоб перевірити встановлену версію dignacli, використайте опцію --version.

Використання команди¶

dignacli --version

Приклад виводу¶

dignacli version 2026.01

параметри логування¶

За замовчуванням вивід у консоль команд digna зроблено мінімалістичним. Більшість команд дозволяють отримати додаткову інформацію, використовуючи такі опції:

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

«verbose» та «debug» визначають рівень деталізації, тоді як перемикач «logfile» дозволяє перенаправити вивід у файл замість вікна консолі.

Керування користувачами¶

add-user¶

Команда add-user у CLI digna використовується для додавання нового користувача до системи digna.

Використання команди¶

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Аргументи¶

USER_NAME: Ім'я користувача для нового облікового запису (обов'язково).
USER_FULL_NAME: Повне ім'я нового користувача (обов'язково).
USER_PASSWORD: Пароль для нового користувача (обов'язково).

Опції¶

--is_superuser, -su: Прапорець для призначення нового користувача адміністратором.
--valid_until, -vu: Встановлює дату закінчення дії облікового запису у форматі YYYY-MM-DD HH:MI:SS. Якщо не вказано, обліковий запис не має дати закінчення.

Приклад¶

Щоб додати нового користувача з іменем jdoe, повним ім'ям John Doe та паролем password123:

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Щоб додати нового користувача та встановити дату закінчення дії облікового запису:

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

delete-user¶

Команда delete-user у CLI digna використовується для видалення існуючого користувача зі системи digna.

Використання команди¶

dignacli delete-user USER_NAME

Аргументи¶

USER_NAME: Ім'я користувача, якого потрібно видалити (обов'язково). Це єдиний аргумент, який вимагає команда.

Приклад¶

dignacli delete-user jdoe

Виконання цієї команди видалить користувача jdoe з системи digna, відкликавши його доступ та видаливши пов'язані дані й дозволи з репозиторія.

modify-user¶

Команда modify-user у CLI digna використовується для оновлення даних існуючого користувача в системі digna.

Використання команди¶

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

Аргументи¶

USER_NAME: Ім'я користувача, якого потрібно змінити (обов'язково).
USER_FULL_NAME: Нове повне ім'я користувача (обов'язково).

Опції¶

--is_superuser, -su: Призначає користувача суперкористувачем, надаючи підвищені привілеї. Цей прапорець не потребує значення.
--valid_until, -vu: Встановлює дату закінчення дії облікового запису у форматі YYYY-MM-DD HH:MI:SS. Якщо не вказано, обліковий запис залишатиметься дійсним безстроково.

Приклад¶

Щоб змінити повне ім'я користувача jdoe на “Johnathan Doe” та призначити його суперкористувачем:

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

modify-user-pwd¶

Команда modify-user-pwd у CLI digna використовується для зміни пароля існуючого користувача в системі digna.

Використання команди¶

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

Аргументи¶

USER_NAME: Ім'я користувача, для якого потрібно змінити пароль (обов'язково).
USER_PWD: Новий пароль для користувача (обов'язково).

Приклад¶

Щоб змінити пароль користувача jdoe на newpassword123:

dignacli modify-user-pwd jdoe newpassword123

list-users¶

Команда list-users у CLI digna відображає список усіх користувачів, зареєстрованих у системі digna.

Використання команди¶

dignacli list-users

Виконання цієї команди у CLI digna підключиться до репозиторія digna та виведе список усіх користувачів, показавши їх ID, ім'я користувача, повне ім'я, статус суперкористувача та часові позначки закінчення дії.

Керування репозиторієм¶

upgrade-repo¶

Команда upgrade-repo у CLI digna використовується для оновлення або ініціалізації репозиторія digna. Ця команда є необхідною для застосування оновлень або для первинного налаштування інфраструктури репозиторія.

Використання команди¶

dignacli upgrade-repo [options]

Опції¶

--simulation-mode, -s: При увімкненні ця опція запускає команду в режимі симуляції, який друкує SQL-запити, які були б виконані, але фактично їх не виконує. Це корисно для попереднього перегляду змін без внесення модифікацій у репозиторій.

Приклад¶

Щоб оновити репозиторій digna, можна виконати команду без опцій:

dignacli upgrade-repo

Щоб запустити оновлення в режимі симуляції (щоб побачити SQL-запити без їх застосування):

dignacli upgrade-repo --simulation-mode

Ця команда є критичною для підтримки системи digna, забезпечуючи актуальність схеми бази даних та інших компонентів репозиторія відповідно до останньої версії ПЗ.

encrypt¶

Команда encrypt у CLI digna використовується для шифрування пароля.

Використання команди¶

dignacli encrypt <PASSWORD>

Аргументи¶

PASSWORD: Пароль, який потрібно зашифрувати (обов'язково).

Приклад¶

Щоб зашифрувати пароль, потрібно вказати його як аргумент.
Наприклад, щоб зашифрувати пароль mypassword123, використайте:

dignacli encrypt mypassword123

Ця команда виведе зашифровану версію переданого пароля, яку можна використовувати в безпечних контекстах. Якщо аргумент пароля не був наданий, CLI покаже помилку про відсутній аргумент.

generate-key¶

Команда generate-key використовується для генерації Fernet-ключа, який необхідний для захисту паролів, що зберігаються в репозиторії digna.

Використання команди¶

dignacli generate-key

Керування даними¶

clean-up¶

Команда clean-up у CLI digna використовується для видалення профілів, прогнозів та даних системи traffic light для одного або кількох джерел даних у вказаному проекті. Ця команда необхідна для управління життєвим циклом даних, допомагаючи підтримувати упорядковане й ефективне середовище даних шляхом очищення застарілої або непотрібної інформації.

Використання команди¶

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

Аргументи¶

PROJECT_NAME: Назва проєкту, з якого потрібно видалити дані (обов'язково). Використання ключового слова all-projects у цьому аргументі вказує digna на необхідність ітерації по всіх існуючих проєктах і застосування цієї команди.
FROM_DATE: Початкова дата та час для видалення даних. Допустимі формати включають %Y-%m-%d, %Y-%m-%dT%H:%M:%S або %Y-%m-%d %H:%M:%S (обов'язково).
TO_DATE: Кінцева дата та час для видалення даних, у тих самих форматах, що й FROM_DATE (обов'язково).

Опції¶

--table-name, -tn: Обмежує операцію очищення певною таблицею в проєкті.
--table-filter, -tf: Фільтр, який обмежує очищення таблицями, що містять заданий підрядок у назві.
--timing, -tm: Показує тривалість виконання процесу очищення після завершення.
--help: Відображає довідкову інформацію для команди clean-up та виходить.

Приклад¶

Щоб видалити дані з проєкту ProjectA між 1 січня 2023 і 30 червня 2023:

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

Щоб видалити дані лише з певної таблиці з ім'ям Table1:

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

Ця команда допомагає в керуванні зберіганням даних і забезпечує наявність у репозиторії лише релевантної інформації.

remove-orphans¶

Команда remove-orphans у CLI digna використовується для прибирання в репозиторії digna.
Коли користувач видаляє проєкти або джерела даних, у репозиторії залишаються профілі та прогнози. За допомогою цієї команди такі сироти (orphaned rows) будуть видалені з репозиторія.

Використання команди¶

dignacli list-projects

list-projects¶

Команда list-projects у CLI digna використовується для відображення списку всіх доступних проєктів у системі digna.

Використання команди¶

dignacli list-projects

Ця команда особливо корисна для адміністраторів та користувачів, які керують кількома проєктами, забезпечуючи швидкий огляд доступних проєктів у репозиторії digna.

list-ds¶

Команда list-ds у CLI digna використовується для відображення списку всіх доступних джерел даних у вказаному проєкті. Ця команда корисна для розуміння наявних активів даних для аналізу та управління в системі digna.

Використання команди¶

dignacli list-ds <PROJECT_NAME>

Аргументи¶

PROJECT_NAME: Назва проєкту, для якого перелічуються джерела даних (обов'язково).

Приклад¶

Щоб перелічити всі джерела даних у проєкті з ім'ям ProjectA:

dignacli list-ds ProjectA

Ця команда надає користувачам огляд доступних у проєкті джерел даних, допомагаючи їм ефективніше орієнтуватися та керувати ландшафтом даних.

inspect¶

Команда inspect у CLI digna використовується для створення профілів, прогнозів та даних системи traffic light для одного або кількох джерел даних у вказаному проєкті. Ця команда допомагає аналізувати та моніторити дані за визначений період. Після завершення інспекції повертається значення розрахованої системи traffic light:
- 0: OK
- 1: INFO
- 2: WARNING

Використання команди¶

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

Аргументи¶

PROJECT_NAME: Назва проєкту, для якого потрібно виконати інспекцію даних (обов'язково). Використання ключового слова all-projects у цьому аргументі вказує digna на необхідність ітерації по всіх існуючих проєктах і застосування цієї команди.
FROM_DATE: Початкова дата та час для інспекції даних. Допустимі формати включають %Y-%m-%d, %Y-%m-%dT%H:%M:%S або %Y-%m-%d %H:%M:%S (обов'язково).
TO_DATE: Кінцева дата та час для інспекції даних у тих самих форматах, що й FROM_DATE (обов'язково).

Опції¶

--table-name, -tn: Обмежує інспекцію конкретною таблицею в проєкті.
--table-filter, -tf: Фільтр для інспекції лише таблиць, що містять заданий підрядок у своїх назвах.
--enable_notification, -en: Увімкнути надсилання повідомлень у разі алертів.
--bypass-backend, -bb: Обійти бекенд і виконати інспекцію безпосередньо з CLI (лише для тестування!).

Приклад¶

Щоб інспектувати дані проєкту ProjectA з 1 січня 2024 до 31 січня 2024:

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

Щоб інспектувати лише конкретну таблицю та примусово перевирахувати прогнози:

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

Ця команда корисна для генерації оновлених профілів і прогнозів, моніторингу цілісності даних та керування системою сповіщень у межах заданого проміжку часу проєкту.

inspect-async¶

Команда inspect-async у CLI digna використовується для створення профілів, прогнозів та даних системи traffic light для одного або кількох джерел даних у вказаному проєкті. Ця команда допомагає аналізувати та моніторити дані за визначений період. На відміну від команди inspect, вона не очікує на завершення інспекції. Натомість вона повертає ідентифікатор запиту для поданої інспекції. Щоб опитати прогрес процесу інспекції, використовуйте команду inspect-status

Використання команди¶

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

Аргументи¶

PROJECT_NAME: Назва проєкту, для якого потрібно виконати інспекцію даних (обов'язково). Використання ключового слова all-projects у цьому аргументі вказує digna на необхідність ітерації по всіх існуючих проєктах і застосування цієї команди.
FROM_DATE: Початкова дата та час для інспекції даних. Допустимі формати включають %Y-%m-%d, %Y-%m-%dT%H:%M:%S або %Y-%m-%d %H:%M:%S (обов'язково).
TO_DATE: Кінцева дата та час для інспекції даних у тих самих форматах, що й FROM_DATE (обов'язково).

Опції¶

--table-name, -tn: Обмежує інспекцію конкретною таблицею в проєкті.
--table-filter, -tf: Фільтр для інспекції лише таблиць, що містять заданий підрядок у своїх назвах.
--enable_notification, -en: Увімкнути надсилання повідомлень у разі алертів.

Приклад¶

Щоб інспектувати дані проєкту ProjectA з 1 січня 2024 до 31 січня 2024:

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

inspect-status¶

Команда inspect-status у CLI digna використовується для перевірки прогресу асинхронної інспекції за ідентифікатором запиту.

Використання команди¶

dignacli inspect-status <REQUEST ID>

Аргументи¶

REQUEST_ID: Ідентифікатор запиту, який повертає команда inspect-async.

Приклад¶

Щоб перевірити прогрес інспекції з ідентифікатором запиту 12345:

dignacli inspect-status 12345

inspect-cancel¶

Команда inspect-cancel у CLI digna використовується для скасування інспекцій за ідентифікатором запиту або для скасування усіх поточних запитів.

Використання команди¶

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

Аргументи¶

REQUEST_ID: Ідентифікатор запиту, який повертає команда inspect-async.

Приклад¶

Щоб скасувати інспекцію з ідентифікатором запиту 12345:

dignacli inspect-cancel 12345

Щоб скасувати всі запити, які наразі виконуються або очікують:

dignacli inspect-cancel --killall

export-ds¶

Команда export-ds у CLI digna використовується для створення експорту джерел даних з репозиторія digna. За замовчуванням будуть експортовані всі джерела даних з вказаного проєкту.

Використання команди¶

dignacli export-ds <PROJECT_NAME> [options]

Аргументи¶

PROJECT_NAME: Назва проєкту, з якого будуть експортовані джерела даних.

Опції¶

--table_name, -tn: Експортувати конкретне джерело даних з проєкту.
--exportfile, -ef: Вказати ім'я файлу для експорту.

Приклад¶

Щоб експортувати всі джерела даних з проєкту з ім'ям ProjectA:

dignacli export-ds ProjectA

Ця команда експортує всі джерела даних з ProjectA у вигляді JSON-документа, який можна імпортувати в інший проєкт або репозиторій digna.

import-ds¶

Команда import-ds у CLI digna використовується для імпорту джерел даних у цільовий проєкт та створення звіту про імпорт.

Використання команди¶

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

Аргументи¶

PROJECT_NAME: Назва проєкту, до якого будуть імпортовані джерела даних.
EXPORT_FILE: Ім'я файлу експорту джерел даних, який потрібно імпортувати.

Опції¶

--output-file, -o: Файл для збереження звіту про імпорт (якщо не вказано, виводиться в термінал у табличному вигляді).
--output-format, -f: Формат для збереження звіту про імпорт (json, csv).

Приклад¶

Щоб імпортувати всі джерела даних з файлу експорту my_export.json у ProjectB:

dignacli import-ds ProjectB my_export.json

Після імпорту ця команда також покаже звіт про імпортовані та пропущені об'єкти. У ProjectB будуть імпортовані лише нові джерела даних. Щоб дізнатися, які об'єкти будуть імпортовані та пропущені, можна використати команду plan-import-ds

plan-import-ds¶

Команда plan-import-ds у CLI digna використовується для аналізу імпорту джерел даних у цільовий проєкт та створення звіту про імпорт (плану).

Використання команди¶

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

Аргументи¶

PROJECT_NAME: Назва проєкту, до якого планується імпорт джерел даних.
EXPORT_FILE: Ім'я файлу експорту джерел даних, який потрібно проаналізувати перед імпортом.

Опції¶

--output-file, -o: Файл для збереження звіту про імпорт (якщо не вказано, виводиться в термінал у табличному вигляді).
--output-format, -f: Формат для збереження звіту про імпорт (json, csv).

Приклад¶

Щоб перевірити, які джерела даних будуть імпортовані і які будуть пропущені з файлу експорту my_export.json при імпорті до ProjectB:

dignacli plan-import-ds ProjectB my_export.json

Ця команда лише покаже план імпорту об'єктів, які будуть імпортовані та пропущені.