Команды

Справочник команд и параметров elemctl: общие флаги, приложения, сборки, деплой и всё остальное.

Справочник собран из самого инструмента – это то же, что показывает elemctl --help, только на одной странице и целиком.

Общие флаги принимаются в любой позиции – и до команды, и после неё: elemctl --timeout 120 apps list и elemctl apps list --timeout 120 равнозначны. Язык вывода переключается флагом --lang, переменной ELEMCTL_LANG или берётся из локали системы.

Общие флаги

Управление приложениями платформы 1С:Предприятие.Элемент (Console API v2)

usage: elemctl [-h] [--base-url BASE_URL] [--client-id CLIENT_ID] [--client-secret CLIENT_SECRET]
               [--env-file ENV_FILE] [--timeout TIMEOUT] [--lang {ru,en}] [--version]
               команда ...

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--base-url BASE_URL`	базовый URL платформы (ELEMENT_BASE_URL)
`--client-id CLIENT_ID`	Client-Id для получения токена (ELEMENT_CLIENT_ID)
`--client-secret CLIENT_SECRET`	Client-Secret к этому Client-Id (ELEMENT_CLIENT_SECRET)
`--env-file ENV_FILE`	путь к .env-файлу (по умолчанию .env в текущем каталоге)
`--timeout TIMEOUT`	таймаут запросов в секундах (по умолчанию 60)
`--lang {ru,en}`	язык вывода (по умолчанию: env ELEMCTL_LANG / локаль системы / ru)
`--version`	показать версию и выйти

Команды

Команда	Описание
`token`	получить и напечатать токен
`apps`	приложения
`spaces`	пространства
`projects`	проекты
`builds`	сборки проекта на платформе
`build`	локально собрать архив сборки из исходников
`inspect`	разобрать готовый архив сборки (.xasm/.xlib)
`deploy`	полный цикл: сборка -> загрузка -> применение -> перезапуск -> проверка применения
`user-lists`	списки пользователей и их настройки входа
`probe`	изолированная проверка компиляции: сборка -> одноразовое приложение -> ошибки с файлом и позицией -> уборка; каталог проекта обязан лежать по схеме {репозиторий}/{Поставщик}/{Имя}/Проект.yaml – по паре Поставщик+Имя платформа опознаёт проект
`branches`	ветки среды разработки
`dumps`	дампы приложений
`tasks`	задачи приложений
`tech`	версия технологии
`debug-adapter`	путь к debug-адаптеру платформы из плагина (для расширения VS Code)
`plugins`	диагностика плагинов elemctl (точки расширения)
`self-update`	обновить elemctl распаковкой колеса (безопасно, когда exe занят MCP-сервером)
`mcp`	запустить MCP-сервер (транспорт stdio)

`elemctl token`

usage: elemctl token [-h]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl apps`

usage: elemctl apps [-h] действие ...

Аргументы

Параметр	Описание
`list`	список приложений
`get`	карточка приложения
`find`	найти приложение по имени (точное совпадение без учёта регистра)
`create`	создать приложение
`ensure`	создать приложение, если его ещё нет (идемпотентно)
`apply`	применить загруженную сборку к приложению и проверить, что она правда применилась
`delete`	удалить приложение (необратимо, URL меняется при пересоздании)
`start`	запустить приложение
`stop`	остановить приложение
`debug`	данные для сессии отладки (debug-token, debug-address)

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl apps list`

usage: elemctl apps list [-h] [--name NAME] [--status STATUS] [--brief]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--name NAME`	фильтр по подстроке имени без учёта регистра (выполняется на клиенте)
`--status STATUS`	отбор по статусу (Running, Stopped, Error, Deleted); несколько – через запятую
`--brief`	краткие карточки: ид, имя, статус, uri, применённая версия

`elemctl apps get`

usage: elemctl apps get [-h] [--app-id APP_ID] [APP_ID]

Аргументы

Параметр	Описание
`APP_ID`	ид (UUID) либо точное имя приложения (по умолчанию ELEMENT_APP_ID)

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--app-id APP_ID`	то же приложение ключом: deploy и apps ensure принимают только эту форму

`elemctl apps find`

usage: elemctl apps find [-h] [--include-deleted] NAME

Аргументы

Параметр	Описание
`NAME`	имя приложения

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--include-deleted`	искать и среди удалённых приложений (по умолчанию пропускаются)

`elemctl apps create`

usage: elemctl apps create [-h] [--project-id PROJECT_ID] [--version-id VERSION_ID]
                           [--latest-build] [--space-id SPACE_ID] [--tech-version TECH_VERSION]
                           [--no-dev-mode] [--wait]
                           NAME

Аргументы

Параметр	Описание
`NAME`	имя приложения

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--project-id PROJECT_ID`	проект-источник
`--version-id VERSION_ID`	id сборки-источника; нового проекта ещё нет – заведите его ‘builds upload <файл>.xasm `--space-id` <id>’ без `--project-id`
`--latest-build`	источник – последняя сборка проекта
`--space-id SPACE_ID`	пространство
`--tech-version TECH_VERSION`	версия технологии
`--no-dev-mode`	не создавать среду разработки
`--wait`	дождаться готовности приложения

`elemctl apps ensure`

usage: elemctl apps ensure [-h] [--project-id PROJECT_ID] [--version-id VERSION_ID]
                           [--latest-build] [--space-id SPACE_ID] [--tech-version TECH_VERSION]
                           [--no-dev-mode] [--wait] [--apply]
                           NAME

Аргументы

Параметр	Описание
`NAME`	имя приложения

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--project-id PROJECT_ID`	проект-источник
`--version-id VERSION_ID`	id сборки-источника; нового проекта ещё нет – заведите его ‘builds upload <файл>.xasm `--space-id` <id>’ без `--project-id`
`--latest-build`	источник – последняя сборка проекта
`--space-id SPACE_ID`	пространство
`--tech-version TECH_VERSION`	версия технологии
`--no-dev-mode`	не создавать среду разработки
`--wait`	дождаться готовности приложения
`--apply`	если приложение уже есть – применить ему указанную сборку (иначе только сообщается, что сборка не применена)

`elemctl apps apply`

usage: elemctl apps apply [-h] [--app-id APP_ID] [APP_ID] VERSION_ID

Аргументы

Параметр	Описание
`APP_ID`	ид (UUID) либо точное имя приложения (по умолчанию ELEMENT_APP_ID)
`VERSION_ID`	ид загруженной сборки (project version id)

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--app-id APP_ID`	то же приложение ключом: deploy и apps ensure принимают только эту форму

`elemctl apps delete`

usage: elemctl apps delete [-h] [--app-id APP_ID] [APP_ID]

Аргументы

Параметр	Описание
`APP_ID`	ид (UUID) либо точное имя приложения

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--app-id APP_ID`	то же приложение ключом: deploy и apps ensure принимают только эту форму

`elemctl apps start`

usage: elemctl apps start [-h] [--app-id APP_ID] [APP_ID]

Аргументы

Параметр	Описание
`APP_ID`	ид (UUID) либо точное имя приложения (по умолчанию ELEMENT_APP_ID)

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--app-id APP_ID`	то же приложение ключом: deploy и apps ensure принимают только эту форму

`elemctl apps stop`

usage: elemctl apps stop [-h] [--app-id APP_ID] [APP_ID]

Аргументы

Параметр	Описание
`APP_ID`	ид (UUID) либо точное имя приложения (по умолчанию ELEMENT_APP_ID)

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--app-id APP_ID`	то же приложение ключом: deploy и apps ensure принимают только эту форму

`elemctl apps debug`

usage: elemctl apps debug [-h] [--app-id APP_ID] [APP_ID]

Аргументы

Параметр	Описание
`APP_ID`	ид (UUID) либо точное имя приложения (по умолчанию ELEMENT_APP_ID)

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--app-id APP_ID`	то же приложение ключом: deploy и apps ensure принимают только эту форму

`elemctl spaces`

usage: elemctl spaces [-h] действие ...

Аргументы

Параметр	Описание
`list`	список пространств

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl spaces list`

usage: elemctl spaces list [-h]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl projects`

usage: elemctl projects [-h] действие ...

Аргументы

Параметр	Описание
`list`	список проектов
`get`	карточка проекта
`delete`	удалить проект

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl projects list`

usage: elemctl projects list [-h] [--name NAME] [--include-deleted]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--name NAME`	фильтр по подстроке имени без учёта регистра (выполняется на клиенте)
`--include-deleted`	показывать и удалённые проекты (по умолчанию скрыты)

`elemctl projects get`

usage: elemctl projects get [-h] [PROJECT_ID]

Аргументы

Параметр	Описание
`PROJECT_ID`	ид проекта (по умолчанию ELEMENT_PROJECT_ID)

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl projects delete`

usage: elemctl projects delete [-h] PROJECT_ID

Аргументы

Параметр	Описание
`PROJECT_ID`	ид проекта

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl builds`

usage: elemctl builds [-h] действие ...

Аргументы

Параметр	Описание
`list`	список сборок проекта (свежие первыми)
`get`	карточка сборки по версии либо ид
`upload`	загрузить файл сборки (.xasm/.xlib)
`delete`	удалить сборку по версии либо ид

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl builds list`

usage: elemctl builds list [-h] [--project-id PROJECT_ID] [--limit LIMIT] [--brief]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--project-id PROJECT_ID`	ид проекта (по умолчанию ELEMENT_PROJECT_ID)
`--limit LIMIT`	сколько сборок показать (по умолчанию 10; 0 – все)
`--brief`	краткие карточки: ид, версии, дата, ветка, коммит

`elemctl builds get`

usage: elemctl builds get [-h] [--project-id PROJECT_ID] VERSION

Аргументы

Параметр	Описание
`VERSION`	версия сборки либо её ид

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--project-id PROJECT_ID`	ид проекта (по умолчанию ELEMENT_PROJECT_ID)

`elemctl builds upload`

usage: elemctl builds upload [-h] [--project-id PROJECT_ID] [--new-project] [--force-rename]
                             [--space-id SPACE_ID]
                             FILE

Аргументы

Параметр	Описание
`FILE`	файл сборки .xasm/.xlib

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--project-id PROJECT_ID`	проект; БЕЗ него платформа заводит новый проект – это единственный способ создать проект через Console API
`--new-project`	загрузить сборку новым проектом, игнорируя ELEMENT_PROJECT_ID из окружения и .env-файла
`--force-rename`	разрешить загрузку сборки с ЧУЖИМ именем: панель переименует проект-цель и его группу именем сборки
`--space-id SPACE_ID`	пространство, в котором завести проект – нужно, когда `--project-id` не задан

`elemctl builds delete`

usage: elemctl builds delete [-h] [--project-id PROJECT_ID] VERSION

Аргументы

Параметр	Описание
`VERSION`	версия сборки либо её ид

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--project-id PROJECT_ID`	ид проекта (по умолчанию ELEMENT_PROJECT_ID)

`elemctl build`

usage: elemctl build [-h] [--project-dir PROJECT_DIR] [--output OUTPUT]
                     [--build-version BUILD_VERSION] [--last-build LAST_BUILD] [--commit COMMIT]
                     [--branch BRANCH] [--kind {application,library}] [--require-clean]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--project-dir PROJECT_DIR`	каталог проекта (по умолчанию ищется вглубь от текущего)
`--output OUTPUT`	каталог для архива (по умолчанию текущий)
`--build-version BUILD_VERSION`	явная версия сборки, например 1.0-42
`--last-build LAST_BUILD`	версия последней сборки проекта – для автоинкремента
`--commit COMMIT`	хэш коммита в манифест (по умолчанию из git)
`--branch BRANCH`	имя ветки в манифест (по умолчанию из git)
`--kind {application,library}`	вид проекта (по умолчанию из Проект.yaml/Project.yaml)
`--require-clean`	прервать сборку, если в каталоге проекта есть незакоммиченные изменения

`elemctl inspect`

usage: elemctl inspect [-h] FILE

Аргументы

Параметр	Описание
`FILE`	файл архива сборки

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl deploy`

usage: elemctl deploy [-h] [--app-id APP_ID] [--project-id PROJECT_ID] [--project-dir PROJECT_DIR]
                      [--output OUTPUT] [--build-version BUILD_VERSION] [--branch BRANCH]
                      [--commit COMMIT] [--dry-run] [--require-clean] [--allow-data-loss]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--app-id APP_ID`	ид приложения (по умолчанию ELEMENT_APP_ID)
`--project-id PROJECT_ID`	ид проекта (по умолчанию ELEMENT_PROJECT_ID)
`--project-dir PROJECT_DIR`	каталог проекта (по умолчанию ищется вглубь от текущего)
`--output OUTPUT`	каталог для архива (по умолчанию временный)
`--build-version BUILD_VERSION`	явная версия сборки
`--branch BRANCH`	имя ветки в метаданные (по умолчанию из git)
`--commit COMMIT`	хэш коммита в метаданные (по умолчанию из git)
`--dry-run`	только сборка, без загрузки
`--require-clean`	прервать деплой, если в каталоге проекта есть незакоммиченные изменения
`--allow-data-loss`	разрешить применение, пересоздающее данные объектов (сужение длины, смена типа реквизита); без флага такой деплой отклоняется до сборки

`elemctl user-lists`

usage: elemctl user-lists [-h] действие ...

Аргументы

Параметр	Описание
`list`	список списков пользователей
`get`	карточка списка: регистрация, политика паролей, сервисы учётных записей
`self-registration`	самостоятельная регистрация пользователей: показать или переключить
`password-login`	вход по логину и паролю (сервис учётных записей Local): показать или переключить
`calculation-rules`	правила разбора ответа сервиса учётных записей: показать цель или записать правила

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl user-lists list`

usage: elemctl user-lists list [-h] [--name NAME]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--name NAME`	фильтр по подстроке представления

`elemctl user-lists get`

usage: elemctl user-lists get [-h] [--app APP] [LIST]

Аргументы

Параметр	Описание
`LIST`	ид списка пользователей либо его точное представление

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--app APP`	взять собственный список приложения (ид либо точное имя приложения)

`elemctl user-lists self-registration`

usage: elemctl user-lists self-registration [-h] [--app APP] [--enable] [--disable] [LIST]

Аргументы

Параметр	Описание
`LIST`	ид списка пользователей либо его точное представление

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--app APP`	взять собственный список приложения (ид либо точное имя приложения)
`--enable`	включить
`--disable`	выключить

usage: elemctl user-lists password-login [-h] [--app APP] [--enable] [--disable] [LIST]

Аргументы

Параметр	Описание
`LIST`	ид списка пользователей либо его точное представление

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--app APP`	взять собственный список приложения (ид либо точное имя приложения)
`--enable`	включить
`--disable`	выключить

`elemctl user-lists calculation-rules`

usage: elemctl user-lists calculation-rules [-h] [--app APP] [--rules-file RULES_FILE]
                                            [--response-kind RESPONSE_KIND]
                                            [--presentation-rule PRESENTATION_RULE]
                                            [--phone-rule PHONE_RULE] [--email-rule EMAIL_RULE]
                                            [--service SERVICE] [--service-type SERVICE_TYPE]
                                            [LIST]

Аргументы

Параметр	Описание
`LIST`	ид списка пользователей либо его точное представление

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--app APP`	взять собственный список приложения (ид либо точное имя приложения)
`--rules-file RULES_FILE`	файл JSON с правилами целиком
`--response-kind RESPONSE_KIND`	вид ответа, который разбирается
`--presentation-rule PRESENTATION_RULE`	правило представления пользователя
`--phone-rule PHONE_RULE`	правило телефона
`--email-rule EMAIL_RULE`	правило почты
`--service SERVICE`	сервис учётных записей: идентификатор (по умолчанию – первый сервис типа Oidc)
`--service-type SERVICE_TYPE`	тип сервиса учётных записей, если идентификатор не задан

`elemctl probe`

usage: elemctl probe [-h] [--project-dir PROJECT_DIR] [--output OUTPUT]
                     [--build-version BUILD_VERSION] [--name NAME] [--space-id SPACE_ID] [--keep]
                     [--require-clean]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--project-dir PROJECT_DIR`	каталог проекта – вида …/{Поставщик}/{Имя} с Проект.yaml внутри (по умолчанию ищется вглубь от текущего)
`--output OUTPUT`	каталог для архива (по умолчанию временный)
`--build-version BUILD_VERSION`	явная версия сборки (по умолчанию {база}`-probe-`{токен} – она обязана быть новой)
`--name NAME`	имя одноразового приложения (по умолчанию elemctl-probe-{токен})
`--space-id SPACE_ID`	пространство для проекта и приложения (ELEMENT_SPACE_ID)
`--keep`	не убирать за собой: оставить приложение и сборку для разбора руками
`--require-clean`	прервать проверку, если в каталоге проекта есть незакоммиченные изменения

`elemctl branches`

usage: elemctl branches [-h] действие ...

Аргументы

Параметр	Описание
`list`	список веток
`get`	карточка ветки
`create`	создать ветку
`update`	изменить ветку (перепривязать к приложению)
`delete`	удалить ветку
`merge`	принять изменения ветки

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl branches list`

usage: elemctl branches list [-h] [--project-id PROJECT_ID] [--name NAME]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--project-id PROJECT_ID`	ид проекта (по умолчанию ELEMENT_PROJECT_ID)
`--name NAME`	фильтр по имени ветки

`elemctl branches get`

usage: elemctl branches get [-h] ID

Аргументы

Параметр	Описание
`ID`	ид ветки

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl branches create`

usage: elemctl branches create [-h] [--project-id PROJECT_ID] [--app-id APP_ID] NAME

Аргументы

Параметр	Описание
`NAME`	имя ветки

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--project-id PROJECT_ID`	ид проекта (по умолчанию ELEMENT_PROJECT_ID)
`--app-id APP_ID`	сразу привязать к приложению

`elemctl branches update`

usage: elemctl branches update [-h] [--app-id APP_ID] ID

Аргументы

Параметр	Описание
`ID`	ид ветки

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--app-id APP_ID`	ид приложения (по умолчанию ELEMENT_APP_ID)

`elemctl branches delete`

usage: elemctl branches delete [-h] ID

Аргументы

Параметр	Описание
`ID`	ид ветки

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl branches merge`

usage: elemctl branches merge [-h] ID

Аргументы

Параметр	Описание
`ID`	ид ветки

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl dumps`

usage: elemctl dumps [-h] действие ...

Аргументы

Параметр	Описание
`create`	создать дамп
`get`	статус дампа

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl dumps create`

usage: elemctl dumps create [-h] [--description DESCRIPTION] [APP_ID]

Аргументы

Параметр	Описание
`APP_ID`	ид приложения (по умолчанию ELEMENT_APP_ID)

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--description DESCRIPTION`	описание дампа

`elemctl dumps get`

usage: elemctl dumps get [-h] APP_ID DUMP_ID

Аргументы

Параметр	Описание
`APP_ID`	ид приложения
`DUMP_ID`	ид дампа

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl tasks`

usage: elemctl tasks [-h] действие ...

Аргументы

Параметр	Описание
`list`	список задач приложений
`get-group`	статус групповой задачи

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl tasks list`

usage: elemctl tasks list [-h] [--app-id APP_ID]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--app-id APP_ID`	фильтр по приложению (на клиенте)

`elemctl tasks get-group`

usage: elemctl tasks get-group [-h] TASK_ID

Аргументы

Параметр	Описание
`TASK_ID`	ид групповой задачи

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl tech`

usage: elemctl tech [-h] действие ...

Аргументы

Параметр	Описание
`get`	версия технологии приложения
`set`	обновить версию технологии (групповая задача)

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl tech get`

usage: elemctl tech get [-h] [APP_ID]

Аргументы

Параметр	Описание
`APP_ID`	ид приложения (по умолчанию ELEMENT_APP_ID)

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl tech set`

usage: elemctl tech set [-h] APP_ID VERSION

Аргументы

Параметр	Описание
`APP_ID`	ид приложения
`VERSION`	версия технологии, на которую перевести приложение

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl debug-adapter`

usage: elemctl debug-adapter [-h]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl plugins`

usage: elemctl plugins [-h]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти

`elemctl self-update`

usage: elemctl self-update [-h] [--version VERSION] [--stop-holders]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти
`--version VERSION`	целевая версия (по умолчанию – последняя с PyPI)
`--stop-holders`	снять процессы, держащие установку (MCP-сессии elemctl), и обновиться; без флага команда только назовёт их

`elemctl mcp`

usage: elemctl mcp [-h]

Параметры

Параметр	Описание
`-h, --help`	показать эту справку и выйти