digna CLI Reference 2026.04¶
2026-04-08
На этой странице задокументирован полный набор команд, доступных в CLI digna релиза 2026.04, включая примеры использования и опции.
CLI Basics¶
help¶
Опция --help предоставляет информацию о доступных командах и их использовании. Существует два основных способа использования этой опции:
-
Отображение общей помощи:
Вызовите --help сразу после ключевого слова dignacli
dignacli --help -
Получение помощи по конкретным командам:
Для подробной информации о конкретной команде добавьте
--helpк этой команде. Например, чтобы получить помощь по командеadd-user, выполните:dignacli add-user --help### output:
- Описание команды: Подробное описание выполняемой командой операции.
- Синтаксис: Показывает точный синтаксис, включая обязательные и необязательные аргументы.
- Опции: Перечисляет опции, специфичные для команды, с их объяснением.
- Примеры: Приводит примеры эффективного выполнения команды.
check-config¶
Команда check-config — утилита в CLI digna, предназначенная для проверки конфигурации digna. Эта команда проверяет, может ли компоненты digna найти необходимые элементы конфигурации в config.toml.
Options¶
--configpath,-cp: Файл или директория, содержащие конфигурацию. Если не указано, будет использован ../config.toml.
Command Usage¶
dignacli check-config
При успешном выполнении команда выводит подтверждение полноты конфигурации.
Если конфигурация неполная, будут перечислены отсутствующие элементы конфигурации.
check-repo-connection¶
Команда check-repo-connection — утилита в CLI digna, предназначенная для проверки подключаемости и доступа к указанному репозиторию digna. Эта команда гарантирует, что CLI может взаимодействовать с репозиторием.
Command Usage¶
dignacli check-repo-connection
При успешном выполнении команда выводит подтверждение соединения и информацию о репозитории: версия репозитория, хост, база данных и схема.
Если подключение к репозиторию не удалось, проверьте файл config.toml на предмет корректных настроек.
version¶
Чтобы узнать установленную версию dignacli, используйте опцию --version.
Command Usage¶
dignacli --version
Example Output¶
dignacli version 2026.04
logging options¶
По умолчанию вывод команд digna в консоль минималистичен. Большинство команд позволяют получить дополнительную информацию с помощью следующих опций:
-- verbose (-v)
-- debug (-d)
-- logfile (lf)
«verbose» и «debug» определяют уровень детализации, тогда как переключатель «logfile» позволяет перенаправить вывод в файл вместо консоли.
User Management¶
add-user¶
Команда add-user в CLI digna используется для добавления нового пользователя в систему digna.
Command Usage¶
dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD
Arguments¶
- USER_NAME: Имя пользователя для нового аккаунта (обязательно).
- USER_FULL_NAME: Полное имя нового пользователя (обязательно).
- USER_PASSWORD: Пароль для нового пользователя (обязательно).
Options¶
--is_superuser,-su: Флаг для обозначения нового пользователя как администратора.--valid_until,-vu: Устанавливает дату истечения действия аккаунта в форматеYYYY-MM-DD HH:MI:SS. Если не задано, аккаунт не имеет срока действия.
Example¶
Чтобы добавить нового пользователя с именем 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.
Command Usage¶
dignacli delete-user USER_NAME
Arguments¶
- USER_NAME: Имя пользователя, которого необходимо удалить (обязательно). Это единственный обязательный аргумент команды.
Example¶
dignacli delete-user jdoe
Выполнение этой команды удалит пользователя jdoe из системы digna, отзовет его доступ и удалит связанные с ним данные и права в репозитории.
modify-user¶
Команда modify-user в CLI digna используется для обновления данных существующего пользователя в системе digna.
Command Usage¶
dignacli modify-user <USER_NAME> <USER_FULL_NAME> [options]
Arguments¶
- USER_NAME: Имя пользователя, которого требуется изменить (обязательно).
- USER_FULL_NAME: Новое полное имя пользователя (обязательно).
Options¶
--is_superuser,-su: Устанавливает пользователя как суперпользователя, предоставляя повышенные привилегии. Этот флаг не требует значения.--valid_until,-vu: Устанавливает дату истечения действия аккаунта в формате YYYY-MM-DD HH:MI:SS. Если не указано, аккаунт остается действительным бессрочно.
Example¶
Чтобы изменить полное имя пользователя jdoe на “Johnathan Doe” и назначить пользователя суперпользователем:
dignacli modify-user jdoe "Johnathan Doe" --is_superuser
modify-user-pwd¶
Команда modify-user-pwd в CLI digna используется для изменения пароля существующего пользователя в системе digna.
Command Usage¶
dignacli modify-user-pwd <USER_NAME> <USER_PWD>
Arguments¶
- USER_NAME: Имя пользователя, чей пароль необходимо изменить (обязательно).
- USER_PWD: Новый пароль для пользователя (обязательно).
Example¶
Чтобы изменить пароль пользователя jdoe на newpassword123:
dignacli modify-user-pwd jdoe newpassword123
list-users¶
Команда list-users в CLI digna отображает список всех пользователей, зарегистрированных в системе digna.
Command Usage¶
dignacli list-users
Выполнение этой команды в CLI digna подключится к репозиторию digna и выведет список всех пользователей с их ID, именем пользователя, полным именем, статусом суперпользователя и метками времени истечения действия.
Repository Management¶
upgrade-repo¶
Команда upgrade-repo в CLI digna используется для обновления или инициализации репозитория digna. Эта команда необходима для применения обновлений или первоначальной настройки инфраструктуры репозитория.
Command Usage¶
dignacli upgrade-repo [options]
Options¶
--simulation-mode,-s: При включении эта опция выполняет команду в режиме симуляции, печатая SQL-запросы, которые были бы выполнены, но не выполняя их фактически. Это полезно для предварительного просмотра изменений без внесения модификаций в репозиторий.
Example¶
Чтобы обновить репозиторий digna, можно выполнить команду без опций:
dignacli upgrade-repo
dignacli upgrade-repo --simulation-mode
Эта команда важна для поддержки системы digna, гарантируя, что схема базы данных и другие компоненты репозитория соответствуют последней версии ПО.
encrypt¶
Команда encrypt в CLI digna используется для шифрования пароля.
Command Usage¶
dignacli encrypt <PASSWORD>
Arguments¶
- PASSWORD: Пароль, который необходимо зашифровать (обязательно).
Example¶
Чтобы зашифровать пароль, необходимо передать пароль в качестве аргумента.
Например, чтобы зашифровать пароль mypassword123, используйте:
dignacli encrypt mypassword123
generate-key¶
Команда generate-key используется для генерации Fernet-ключа, необходимого для защиты паролей, хранящихся в репозитории digna.
Command Usage¶
dignacli generate-key
Data Management¶
clean-up¶
Команда clean-up в CLI digna используется для удаления профилей, предсказаний и данных системы светофора для одного или нескольких источников данных в пределах указанного проекта. Эта команда важна для управления жизненным циклом данных, помогая поддерживать организованную и эффективную среду данных путем очистки устаревших или ненужных данных.
Command Usage¶
dignacli clean-up <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]
Arguments¶
- 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 (обязательно).
Options¶
--table-name,-tn: Ограничивает операцию очистки конкретной таблицей в проекте.--table-filter,-tf: Фильтр для ограничения очистки таблицами, содержащими указанный подстроку в именах.--timing,-tm: Показывает продолжительность выполнения операции очистки после завершения.--help: Показывает информацию справки по команде clean-up и завершает выполнение.
Example¶
Чтобы удалить данные из проекта 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 используется для обслуживания (house-keeping) репозитория digna.
Когда пользователь удаляет проекты или источники данных, профили и предсказания могут оставаться в репозитории. С помощью этой команды такие «сиротские» строки будут удалены из репозитория.
Command Usage¶
dignacli list-projects
list-projects¶
Команда list-projects в CLI digna используется для отображения списка всех доступных проектов в системе digna.
Command Usage¶
dignacli list-projects
Эта команда особенно полезна администраторам и пользователям, управляющим несколькими проектами, предоставляя быстрый обзор доступных проектов в репозитории digna.
list-ds¶
Команда list-ds в CLI digna используется для отображения списка всех доступных источников данных в указанном проекте. Эта команда полезна для понимания доступных данных для анализа и управления в системе digna.
Command Usage¶
dignacli list-ds <PROJECT_NAME>
Arguments¶
- PROJECT_NAME: Название проекта, для которого перечисляются источники данных (обязательно).
Example¶
Чтобы перечислить все источники данных в проекте с именем ProjectA:
dignacli list-ds ProjectA
Эта команда даёт пользователям обзор доступных в проекте источников данных, помогая эффективнее ориентироваться и управлять ландшафтом данных.
inspect¶
Команда inspect в CLI digna используется для создания профилей, предсказаний и данных системы светофора для одного или нескольких источников данных в указанном проекте. Эта команда помогает анализировать и мониторить данные за определённый период. По завершении инспекции возвращается значение рассчитанной системы светофора:
- 0: OK
- 1: INFO
- 2: WARNING
Command Usage¶
dignacli inspect <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]
Arguments¶
- 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 (обязательно).
Options¶
--table-name,-tn: Ограничивает инспекцию конкретной таблицей в проекте.--table-filter,-tf: Фильтр для инспекции только таблиц, содержащих указанную подстроку в именах.--enable_notification,-en: Включает отправку уведомлений в случае срабатывания оповещений.--bypass-backend,-bb: Обход бэкенда и запуск инспекции непосредственно из CLI (только для тестирования!).
Example¶
Чтобы проинспектировать данные проекта 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 используется для создания профилей, предсказаний и данных системы светофора для одного или нескольких источников данных в указанном проекте. Эта команда помогает анализировать и мониторить данные за определённый период. В отличие от команды inspect, эта команда не дожидается завершения инспекции. Вместо этого она возвращает идентификатор запроса для отправленной задачи инспекции. Для запроса статуса выполнения используйте команду inspect-status.
Command Usage¶
dignacli inspect-async <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]
Arguments¶
- 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 (обязательно).
Options¶
--table-name,-tn: Ограничивает инспекцию конкретной таблицей в проекте.--table-filter,-tf: Фильтр для инспекции только таблиц, содержащих указанную подстроку в именах.--enable_notification,-en: Включает отправку уведомлений в случае срабатывания оповещений.
Example¶
Чтобы запустить асинхронную инспекцию данных проекта ProjectA с 1 января 2024 по 31 января 2024:
dignacli inspect-async ProjectA 2024-01-01 2024-01-31
inspect-status¶
Команда inspect-status в CLI digna используется для проверки прогресса асинхронной инспекции по идентификатору запроса.
Command Usage¶
dignacli inspect-status <REQUEST ID>
Arguments¶
- REQUEST_ID: Идентификатор запроса, возвращённый командой
inspect-async
Example¶
Чтобы проверить прогресс инспекции с идентификатором запроса 12345:
dignacli inspect-status 12345
inspect-cancel¶
Команда inspect-cancel в CLI digna используется для отмены инспекций по идентификатору запроса либо для отмены всех текущих запросов.
Command Usage¶
dignacli inspect-cancel <REQUEST ID>
dignacli inspect-cancel --killall
Arguments¶
- REQUEST_ID: Идентификатор запроса, возвращённый командой
inspect-async
Example¶
Чтобы отменить инспекцию с идентификатором запроса 12345:
dignacli inspect-cancel 12345
Чтобы отменить все запросы, которые в данный момент выполняются или ожидают выполнения:
dignacli inspect-cancel --killall
export-ds¶
Команда export-ds в CLI digna используется для создания экспорта источников данных из репозитория digna. По умолчанию экспортируются все источники данных из указанного проекта.
Command Usage¶
dignacli export-ds <PROJECT_NAME> [options]
Arguments¶
- PROJECT_NAME: Название проекта, из которого будут экспортироваться источники данных.
Options¶
--table_name,-tn: Экспортировать конкретный источник данных из проекта.--exportfile,-ef: Указать имя файла для экспорта.
Example¶
Чтобы экспортировать все источники данных из проекта с именем ProjectA:
dignacli export-ds ProjectA
Эта команда экспортирует все источники данных из ProjectA в виде JSON-документа, который затем можно импортировать в другой проект или репозиторий digna.
import-ds¶
Команда import-ds в CLI digna используется для импорта источников данных в целевой проект и создания отчёта об импорте.
Command Usage¶
dignacli import-ds <PROJECT_NAME> <EXPORT_FILE> [options]
Arguments¶
- PROJECT_NAME: Название проекта, в который будут импортированы источники данных.
- EXPORT_FILE: Имя файла экспорта источников данных для импорта.
Options¶
--output-file,-o: Файл для сохранения отчёта об импорте (если не задано, выводится в терминал в табличном виде).--output-format,-f: Формат для сохранения отчёта об импорте (json, csv).
Example¶
Чтобы импортировать все источники данных из файла экспорта my_export.json в ProjectB:
dignacli import-ds ProjectB my_export.json
После импорта эта команда также покажет отчёт об импортированных и пропущенных объектах. В ProjectB будут импортированы только новые источники данных. Чтобы узнать, какие объекты будут импортированы, а какие пропущены, можно использовать команду plan-import-ds.
plan-import-ds¶
Команда plan-import-ds в CLI digna используется для анализа файла экспорта источников данных и составления плана импорта в целевой проект.
Command Usage¶
dignacli plan-import-ds <PROJECT_NAME> <EXPORT_FILE> [options]
Arguments¶
- PROJECT_NAME: Название проекта, в который планируется импортировать источники данных.
- EXPORT_FILE: Имя файла экспорта источников данных для анализа перед импортом.
Options¶
--output-file,-o: Файл для сохранения отчёта плана импорта (если не задано, выводится в терминал в табличном виде).--output-format,-f: Формат для сохранения отчёта плана импорта (json, csv).
Example¶
Чтобы проверить, какие источники данных будут импортированы и какие будут пропущены из файла экспорта my_export.json при импорте в ProjectB:
dignacli plan-import-ds ProjectB my_export.json
Эта команда только покажет план импорта объектов — какие будут импортированы и какие пропущены.