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
```
### вывод:
- Описание команды: Подробное описание того, что делает команда.
- Синтаксис: Показывает точный синтаксис, включая обязательные и опциональные аргументы.
- Параметры: Перечисляет параметры, специфичные для команды, с их объяснениями.
- Примеры: Приводит примеры эффективного выполнения команды.

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

Чтобы выполнить обновление в режиме симуляции (чтобы увидеть 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 используется для удаления профилей, предсказаний и данных системы светофора для одного или нескольких источников данных в указанном проекте. Эта команда важна для управления жизненным циклом данных, помогая поддерживать организованную и эффективную среду данных путём очистки устаревших или ненужных данных.

Использование команды¶

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.
Когда пользователь удаляет проекты или источники данных, профили и предсказания могут оставаться в репозитории. С помощью этой команды такие сиротские строки будут удалены из репозитория.

Использование команды¶

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 используется для создания профилей, предсказаний и данных системы светофора для одного или нескольких источников данных в указанном проекте. Эта команда помогает анализировать и контролировать данные за заданный период. По завершении инспекции возвращается значение рассчитанной системы светофора:
- 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 используется для создания профилей, предсказаний и данных системы светофора для одного или нескольких источников данных в указанном проекте. Эта команда помогает анализировать и контролировать данные за заданный период. В отличие от команды 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

Эта команда только покажет план импорта объектов, которые будут импортированы и пропущены.