digna CLI Reference 2026.04¶
2026-04-08
На цій сторінці задокументовано повний набір команд, доступних у CLI digna версії 2026.04, включно з прикладами використання та параметрами.
Основи CLI¶
help¶
Опція --help надає інформацію про доступні команди та їх використання. Існує два основних способи використання цієї опції:
-
Відображення загальної довідки:
Використовуйте --help безпосередньо після ключового слова dignacli
-
Отримання довідки по конкретних командах:
Для детальної інформації про певну команду додайте
--helpдо цієї команди.
Наприклад, щоб отримати довідку щодо командиadd-user, виконайте:### вивід:
- Опис команди: Детальний опис того, що виконує команда.
- Синтаксис: Показує точний синтаксис, включаючи обов'язкові та необов'язкові аргументи.
- Параметри: Перелік опцій, специфічних для команди, разом із поясненнями.
- Приклади: Приклади ефективного виконання команди.
check-config¶
Команда check-config — утиліта в CLI digna, призначена для перевірки конфігурації digna. Ця команда гарантує, що компоненти digna можуть знайти необхідні елементи конфігурації у файлі config.toml.
Параметри¶
--configpath,-cp: Файл або каталог, що містить конфігурацію. Якщо не вказано, буде використано ../config.toml.
Використання команди¶
Після успішного виконання команда виводить підтвердження повноти конфігурації.
Якщо конфігурація виявиться неповною, буде виведено перелік відсутніх елементів конфігурації.
check-repo-connection¶
Команда check-repo-connection — утиліта в CLI digna, призначена для перевірки з'єднання та доступу до вказаного репозиторію digna. Ця команда гарантує, що CLI може взаємодіяти з репозиторієм.
Використання команди¶
Після успішного виконання команда виводить підтвердження з'єднання разом із деталями про репозиторій: версія репозиторію, хост, база даних та схема.
Якщо підключення до репозиторію не вдалось, перевірте файл config.toml на предмет правильних налаштувань.
version¶
Щоб перевірити встановлену версію dignacli, використайте опцію --version.
Використання команди¶
Приклад виводу¶
параметри логування¶
За замовчуванням вивід у консоль команд digna мінімалістичний. Більшість команд дозволяють отримати додаткову інформацію, використовуючи такі опції:
-- verbose (-v)
-- debug (-d)
-- logfile (lf)
«verbose» та «debug» визначають рівень деталізації, тоді як перемикач «logfile» дозволяє перенаправити вивід у файл замість вікна консолі.
Керування користувачами¶
add-user¶
Команда add-user у CLI digna використовується для додавання нового користувача до системи digna.
Використання команди¶
Аргументи¶
- USER_NAME: Ім'я користувача для нового облікового запису (обов'язкове).
- USER_FULL_NAME: Повне ім'я нового користувача (обов'язкове).
- USER_PASSWORD: Пароль для нового користувача (обов'язкове).
Параметри¶
--is_superuser,-su: Прапорець для позначення нового користувача як адміністратора.--valid_until,-vu: Встановлює дату закінчення дії облікового запису у форматіYYYY-MM-DD HH:MI:SS. Якщо не вказано, обліковий запис не має дати закінчення.
Приклад¶
Щоб додати нового користувача з ім'ям jdoe, повним іменем John Doe та паролем password123:
Щоб додати нового користувача та встановити дату закінчення дії облікового запису:
delete-user¶
Команда delete-user у CLI digna використовується для видалення існуючого користувача зі системи digna.
Використання команди¶
Аргументи¶
- USER_NAME: Ім'я користувача, якого потрібно видалити (обов'язкове). Це єдиний аргумент, що вимагається командою.
Приклад¶
Виконання цієї команди видалить користувача jdoe з системи digna, відкликаючи його доступ та видаляючи пов'язані дані й дозволи з репозиторію.
modify-user¶
Команда modify-user у CLI digna використовується для оновлення даних існуючого користувача в системі digna.
Використання команди¶
Аргументи¶
- USER_NAME: Ім'я користувача, якого потрібно змінити (обов'язкове).
- USER_FULL_NAME: Нове повне ім'я користувача (обов'язкове).
Параметри¶
--is_superuser,-su: Встановлює користувача як суперкористувача, надаючи підвищені привілеї. Цей прапорець не потребує значення.--valid_until,-vu: Встановлює дату закінчення дії облікового запису у форматі YYYY-MM-DD HH:MI:SS. Якщо не вказано, обліковий запис залишається дійсним необмежено.
Приклад¶
Щоб змінити повне ім'я користувача jdoe на “Johnathan Doe” та призначити користувача суперкористувачем:
modify-user-pwd¶
Команда modify-user-pwd у CLI digna використовується для зміни пароля існуючого користувача в системі digna.
Використання команди¶
Аргументи¶
- USER_NAME: Ім'я користувача, для якого змінюється пароль (обов'язкове).
- USER_PWD: Новий пароль для користувача (обов'язкове).
Приклад¶
Щоб змінити пароль користувача jdoe на newpassword123:
list-users¶
Команда list-users у CLI digna відображає список усіх користувачів, зареєстрованих у системі digna.
Використання команди¶
Виконання цієї команди в CLI digna підключиться до репозиторію digna та виведе список усіх користувачів, показавши їхній ID, ім'я користувача, повне ім'я, статус суперкористувача та часові позначки закінчення дії.
Керування репозиторієм¶
upgrade-repo¶
Команда upgrade-repo у CLI digna використовується для оновлення або ініціалізації репозиторію digna. Ця команда є необхідною для застосування оновлень або налаштування інфраструктури репозиторію вперше.
Використання команди¶
Параметри¶
--simulation-mode,-s: При вмиканні ця опція запускає команду в режимі симуляції, який виводить SQL-запити, що були б виконані, але фактично їх не виконує. Це корисно для попереднього перегляду змін без внесення модифікацій до репозиторію.
Приклад¶
Щоб оновити репозиторій digna, можна виконати команду без жодних опцій:
Щоб запустити оновлення в режимі симуляції (щоб побачити SQL-запити без їхнього застосування):Ця команда є важливою для підтримки системи digna, забезпечуючи відповідність схеми бази даних та інших компонентів репозиторію останній версії програмного забезпечення.
encrypt¶
Команда encrypt у CLI digna використовується для шифрування пароля.
Використання команди¶
Аргументи¶
- PASSWORD: Пароль, який потрібно зашифрувати (обов'язкове).
Приклад¶
Щоб зашифрувати пароль, необхідно передати пароль як аргумент.
Наприклад, щоб зашифрувати пароль mypassword123, використайте:
generate-key¶
Команда generate-key використовується для генерації Fernet-ключа, що необхідний для захисту паролів, збережених у репозиторії digna.
Використання команди¶
Керування даними¶
clean-up¶
Команда clean-up у CLI digna використовується для видалення профілів, прогнозів та даних системи світлофорів для одного або кількох джерел даних у межах вказаного проєкту. Ця команда необхідна для управління життєвим циклом даних, допомагаючи підтримувати організоване й ефективне середовище шляхом очищення застарілих або непотрібних даних.
Використання команди¶
Аргументи¶
- 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 року:
Щоб видалити дані лише з певної таблиці з назвою Table1:
Ця команда допомагає управляти зберіганням даних та забезпечує, щоб у репозиторії залишалась лише релевантна інформація.
remove-orphans¶
Команда remove-orphans у CLI digna використовується для підтримки порядку в репозиторії digna.
Коли користувач видаляє проєкти або джерела даних, профілі та прогнози можуть залишатися в репозиторії. За допомогою цієї команди такі сирітські (orphaned) записи будуть видалені з репозиторію.
Використання команди¶
list-projects¶
Команда list-projects у CLI digna використовується для відображення списку всіх доступних проєктів у системі digna.
Використання команди¶
Ця команда особливо корисна адміністраторам та користувачам, які керують кількома проєктами, надаючи швидкий огляд доступних проєктів у репозиторії digna.
list-ds¶
Команда list-ds у CLI digna використовується для відображення списку всіх доступних джерел даних у вказаному проєкті. Ця команда корисна для розуміння наявних даних для аналізу та керування у системі digna.
Використання команди¶
Аргументи¶
- PROJECT_NAME: Назва проєкту, для якого перелічуються джерела даних (обов'язкове).
Приклад¶
Щоб перелічити всі джерела даних у проєкті з назвою ProjectA:
Ця команда надає користувачам огляд джерел даних у проєкті, допомагаючи ефективніше орієнтуватися та управляти ландшафтом даних.
inspect¶
Команда inspect у CLI digna використовується для створення профілів, прогнозів та даних системи світлофорів для одного або кількох джерел даних у межах вказаного проєкту. Ця команда допомагає аналізувати та моніторити дані за визначений період. Після завершення інспекції повертається значення обчисленої системи світлофорів:
- 0: OK
- 1: INFO
- 2: WARNING
Використання команди¶
Аргументи¶
- 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:
Щоб інспектувати лише конкретну таблицю та примусово перерахувати прогнози:
Ця команда корисна для генерації оновлених профілів і прогнозів, моніторингу цілісності даних та керування системами оповіщення в межах зазначеного періоду проєкту.inspect-async¶
Команда inspect-async у CLI digna використовується для створення профілів, прогнозів та даних системи світлофорів для одного або кількох джерел даних у межах вказаного проєкту. Ця команда допомагає аналізувати та моніторити дані за визначений період. На відміну від синхронної інспекції, ця команда не чекає на завершення інспекції. Натомість вона повертає ідентифікатор запиту для поданої асинхронної інспекції. Щоб дізнатися прогрес виконання інспекції, використовуйте команду inspect-status.
Використання команди¶
Аргументи¶
- 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:
inspect-status¶
Команда inspect-status у CLI digna використовується для перевірки прогресу асинхронної інспекції за ідентифікатором запиту.
Використання команди¶
Аргументи¶
- REQUEST_ID: Ідентифікатор запиту, який повернула команда
inspect-async.
Приклад¶
Щоб перевірити прогрес інспекції з ідентифікатором запиту 12345:
inspect-cancel¶
Команда inspect-cancel у CLI digna використовується для скасування інспекцій за ідентифікатором запиту або для скасування всіх поточних запитів.
Використання команди¶
Аргументи¶
- REQUEST_ID: Ідентифікатор запиту, який повернула команда
inspect-async.
Приклад¶
Щоб скасувати інспекцію з ідентифікатором запиту 12345:
Щоб скасувати всі запити, що наразі виконуються або очікують:
export-ds¶
Команда export-ds у CLI digna використовується для створення експорту джерел даних з репозиторію digna. За замовчуванням експортуються всі джерела даних із вказаного проєкту.
Використання команди¶
Аргументи¶
- PROJECT_NAME: Назва проєкту, з якого будуть експортовані джерела даних.
Параметри¶
--table_name,-tn: Експортувати конкретне джерело даних з проєкту.--exportfile,-ef: Вказати ім'я файлу для експорту.
Приклад¶
Щоб експортувати всі джерела даних з проєкту з назвою ProjectA:
Ця команда експортує всі джерела даних з ProjectA у вигляді JSON-документа, який можна імпортувати в інший проєкт або репозиторій digna.
import-ds¶
Команда import-ds у CLI digna використовується для імпорту джерел даних у цільовий проєкт та створення звіту про імпорт.
Використання команди¶
Аргументи¶
- PROJECT_NAME: Назва проєкту, до якого будуть імпортовані джерела даних.
- EXPORT_FILE: Ім'я файлу експорту джерел даних, який потрібно імпортувати.
Параметри¶
--output-file,-o: Файл для збереження звіту про імпорт (якщо не вказано, друкує у терміналі у табличному вигляді).--output-format,-f: Формат для збереження звіту про імпорт (json, csv).
Приклад¶
Щоб імпортувати всі джерела даних з файлу експорту my_export.json у ProjectB:
Після імпорту ця команда також покаже звіт про імпортовані та пропущені об'єкти. До ProjectB імпортуватимуться лише нові джерела даних. Щоб дізнатися, які об'єкти будуть імпортовані чи пропущені, можна скористатися командою plan-import-ds.
plan-import-ds¶
Команда plan-import-ds у CLI digna використовується для аналізу файлу експорту джерел даних і створення плану імпорту до цільового проєкту.
Використання команди¶
Аргументи¶
- PROJECT_NAME: Назва проєкту, до якого планується імпорт джерел даних.
- EXPORT_FILE: Ім'я файлу експорту джерел даних, який буде проаналізовано перед імпортом.
Параметри¶
--output-file,-o: Файл для збереження звіту-плану імпорту (якщо не вказано, друкує у терміналі у табличному вигляді).--output-format,-f: Формат для збереження звіту-плану імпорту (json, csv).
Приклад¶
Щоб перевірити, які джерела даних будуть імпортовані, а які будуть пропущені з файлу експорту my_export.json при імпорті в ProjectB:
Ця команда лише покаже план імпорту об'єктів, які будуть імпортовані та пропущені.