digna CLI Reference 2025.09¶
2025-09-29
На цій сторінці задокументовано повний набір команд, доступних у CLI digna релізу 2025.09, включно з прикладами використання та опціями.
Основи CLI¶
help¶
Опція --help надає інформацію про доступні команди та їх використання. Існує два основних способи використання цієї опції:
-
Відображення загальної допомоги:
Використовуйте
--helpбезпосередньо після ключового словаdignacli
dignacli --help -
Отримання допомоги по конкретних командах:
Для детальної інформації про конкретну команду додайте
--helpдо цієї команди.
Наприклад, щоб отримати допомогу щодо командиadd-user, виконайте:dignacli add-user --help### output:
- Опис команди: Детальний опис того, що робить команда.
- Синтаксис: Показує точний синтаксис, включно з обов’язковими та опціональними аргументами.
- Опції: Перелік опцій, специфічних для команди, разом з їхніми поясненнями.
- Приклади: Приклади ефективного виконання команди.
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
Після успішного виконання команда виводить підтвердження підключення разом із деталями про репозиторій: версія репозиторію, хост, база даних та схема.
Якщо підключення до репозиторію не відбулося, перевірте файл config.toml на предмет правильних налаштувань.
version¶
Щоб перевірити встановлену версію dignacli, використовуйте опцію --version.
Використання команди¶
dignacli --version
Приклад виводу¶
dignacli version 2025.09
параметри логування¶
За замовчуванням вивід у консоль команд 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
dignacli upgrade-repo --simulation-mode
Ця команда є критичною для підтримки системи digna, забезпечуючи актуальність схеми бази даних та інших компонентів репозиторію відповідно до останньої версії програмного забезпечення.
encrypt¶
Команда encrypt у CLI digna використовується для шифрування пароля.
Використання команди¶
dignacli encrypt <PASSWORD>
Аргументи¶
- PASSWORD: Пароль, який потрібно зашифрувати (обов’язково).
Приклад¶
Щоб зашифрувати пароль, потрібно передати його як аргумент.
Наприклад, щоб зашифрувати пароль mypassword123, використайте:
dignacli encrypt mypassword123
generate-key¶
Команда generate-key використовується для генерації ключа Fernet, який необхідний для захисту паролів, що зберігаються в репозиторії digna.
Використання команди¶
dignacli generate-key
Керування даними¶
clean-up¶
Команда clean-up у CLI digna використовується для видалення профілів, прогнозів та даних системи сигнальних індикаторів (traffic light system) для одного або кількох джерел даних у межах вказаного проєкту. Ця команда важлива для управління життєвим циклом даних, допомагаючи підтримувати організоване та ефективне середовище шляхом очищення застарілих або непотрібних даних.
Використання команди¶
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) записи будуть видалені з репозиторію.
Використання команди¶
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 system) для одного або кількох джерел даних у межах вказаного проєкту. Ця команда допомагає аналізувати та контролювати дані за визначений період. Після завершення інспекції повертається значення розрахованої системи сигнальних індикаторів:
- 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 system) для одного або кількох джерел даних у межах вказаного проєкту. Ця команда допомагає аналізувати та контролювати дані за визначений період. На відміну від синхронної версії, ця команда не чекає на завершення інспекції. Замість цього вона повертає ідентифікатор запиту для поданої асинхронної інспекції. Щоб перевірити прогрес інспекції, використовуйте команду 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
Ця команда лише покаже план імпорту об’єктів, які будуть імпортовані та пропущені.