Справочник digna CLI 2026.01¶

2026-01-15

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

Основы CLI¶

help¶

Опция --help предоставляет информацию о доступных командах и их использовании. Существует два основных способа использования этой опции:

Отображение общей справки:

Используйте --help непосредственно после ключевого слова dignacli
```
dignacli --help
```
Получение справки по конкретной команде:

Для получения подробной информации о конкретной команде добавьте --help к этой команде. Например, чтобы получить справку по команде add-user, выполните:
```
dignacli add-user --help
```
### вывод:
- Описание команды: Подробное описание того, что делает команда.
- Синтаксис: Показывает точный синтаксис, включая обязательные и опциональные аргументы.
- Параметры (Options): Перечисляет параметры, специфичные для команды, с их объяснениями.
- Примеры: Предоставляет примеры эффективного выполнения команды.

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

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

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

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

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

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