Команды
Справочник команд и параметров elemctl: общие флаги, приложения, сборки, развёртывание и всё остальное.
Справочник собран из самого инструмента – это то же, что показывает elemctl --help, только на одной странице и целиком.
Общие флаги принимаются в любой позиции – и до команды, и после неё: elemctl --timeout 120 apps list и elemctl apps list --timeout 120 равнозначны. Язык вывода переключается флагом --lang, переменной ELEMCTL_LANG или берётся из локали системы.
Ключ, в справке которого сказано, что его можно повторить, собирает все значения. Остальные ключи принимают одно значение: повтор с другим значением CLI отвергает до запуска команды, а повтор с тем же значением пропускает.
Общие флаги
Управление приложениями платформы 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}] [--json] [--quiet]
[--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) |
--json |
машиночитаемый вывод: в stdout только JSON ответа, всё остальное (ход работы, предупреждения, ошибки) – в stderr |
--quiet |
не печатать ход работы: в stderr не идут ни строки прогресса, ни предупреждения, остаются ответ и отказ; форма ответа та же |
--version |
показать версию и выйти |
Команды
| Команда | Описание |
|---|---|
token |
получить и напечатать токен |
apps |
приложения |
spaces |
пространства |
projects |
проекты |
builds |
сборки проекта на платформе |
build |
локально собрать архив сборки из исходников (к платформе не обращается: ключи подключения, включая --env-file, команда отвергает, номер версии на сервере не занимается) |
inspect |
разобрать готовый архив сборки (.xasm/.xlib); к платформе не обращается – ключи подключения, включая --env-file, команда отвергает |
deploy |
полный цикл: сборка -> загрузка -> применение -> перезапуск -> проверка применения |
user-lists |
списки пользователей и их настройки входа |
probe |
изолированная проверка компиляции: сборка -> одноразовое приложение -> ошибки с файлом и позицией -> уборка; каталог проекта обязан лежать по схеме {репозиторий}/{Поставщик}/{Имя}/Проект.yaml, как этого требует сборка |
verify-deploy |
проверить, что сборка действительно применилась к приложению: задачи с ошибками (в них файл и позиция ошибки компиляции), сверка применённой сборки, доступность адреса; сама ничего не разворачивает |
branches |
ветки среды разработки |
dumps |
дампы приложений |
tasks |
задачи приложений (перечень – tasks list [--app-id ИД]) |
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 |
карточка приложения; в applied-build – ветка и коммит применённой сборки (из карточки сборки или из локального реестра загрузок) |
find |
найти приложение по имени (точное совпадение без учёта регистра) |
create |
создать приложение |
ensure |
создать приложение, если его ещё нет (идемпотентно) |
apply |
применить загруженную сборку к приложению и проверить, что она правда применилась |
delete |
удалить приложение (необратимо, URL меняется при пересоздании) |
start |
запустить приложение |
stop |
остановить приложение |
debug |
данные для сессии отладки (debug-token, debug-address) |
users |
пользователи, подключённые к приложению: список, ид, представление, администратор ли и есть ли доступ по токену (логина платформа здесь не отдаёт) |
token-access |
доступ пользователя к HTTP-сервисам приложения по токену: показать или переключить (без него вызов сервиса токеном получает 500 “Token access is denied”) |
export |
выгрузить в файл сборку, на которой работает приложение (расширения в нее не входят; их выгружает export-extension) |
export-extension |
выгрузить в файл сборку расширения, примененного в приложении (метод Console API 2.1; сервер без него получает понятный отказ) |
Параметры
| Параметр | Описание |
|---|---|
-h, --help |
показать эту справку и выйти |
elemctl apps list
usage: elemctl apps list [-h] [--name NAME] [--status STATUS] [--include-deleted] [--brief]
Параметры
| Параметр | Описание |
|---|---|
-h, --help |
показать эту справку и выйти |
--name NAME |
фильтр по подстроке имени без учёта регистра (выполняется на клиенте) |
--status STATUS |
отбор по статусу (Running, Stopped, Error, Deleted); несколько – через запятую или повтором ключа |
--include-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] [--verify] [--no-verify]
NAME
Аргументы
| Параметр | Описание |
|---|---|
NAME |
имя приложения |
Параметры
| Параметр | Описание |
|---|---|
-h, --help |
показать эту справку и выйти |
--project-id PROJECT_ID |
проект-источник; с --version-id по перечню его сборок команда проверяет, что платформа ещё не удалила сборку-источник (по умолчанию ELEMENT_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 |
дождаться готовности приложения (заодно проверяет, что стоит нужная сборка) |
--verify |
проверить, что приложение правда работает на запрошенной сборке (подразумевает --wait); при неудаче код возврата 1 |
--no-verify |
не проверять применённую сборку – только дождаться готовности |
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] [--verify] [--no-verify] [--apply]
NAME
Аргументы
| Параметр | Описание |
|---|---|
NAME |
имя приложения |
Параметры
| Параметр | Описание |
|---|---|
-h, --help |
показать эту справку и выйти |
--project-id PROJECT_ID |
проект-источник; с --version-id по перечню его сборок команда проверяет, что платформа ещё не удалила сборку-источник (по умолчанию ELEMENT_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 |
дождаться готовности приложения (заодно проверяет, что стоит нужная сборка) |
--verify |
проверить, что приложение правда работает на запрошенной сборке (подразумевает --wait); при неудаче код возврата 1 |
--no-verify |
не проверять применённую сборку – только дождаться готовности |
--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 apps users
usage: elemctl apps users [-h] [--app-id APP_ID] [APP_ID]
Аргументы
| Параметр | Описание |
|---|---|
APP_ID |
ид (UUID) либо точное имя приложения (по умолчанию ELEMENT_APP_ID) |
Параметры
| Параметр | Описание |
|---|---|
-h, --help |
показать эту справку и выйти |
--app-id APP_ID |
то же приложение ключом: deploy и apps ensure принимают только эту форму |
elemctl apps token-access
usage: elemctl apps token-access [-h] [--app-id APP_ID] [--user USER] [--enable] [--disable]
[APP_ID]
Аргументы
| Параметр | Описание |
|---|---|
APP_ID |
ид (UUID) либо точное имя приложения |
Параметры
| Параметр | Описание |
|---|---|
-h, --help |
показать эту справку и выйти |
--app-id APP_ID |
то же приложение ключом: deploy и apps ensure принимают только эту форму |
--user USER |
логин, представление или ид пользователя (по умолчанию – учётная запись, под которой работает elemctl); ключ можно повторить: у каждого пользователя тогда своя запись в ответе, а сбой одного не останавливает остальных |
--enable |
разрешить доступ по токену и перечитать признак |
--disable |
запретить доступ по токену и перечитать признак |
elemctl apps export
usage: elemctl apps export [-h] [--app-id APP_ID] [--output OUTPUT] [APP_ID]
Аргументы
| Параметр | Описание |
|---|---|
APP_ID |
ид (UUID) либо точное имя приложения (по умолчанию ELEMENT_APP_ID) |
Параметры
| Параметр | Описание |
|---|---|
-h, --help |
показать эту справку и выйти |
--app-id APP_ID |
то же приложение ключом: deploy и apps ensure принимают только эту форму |
--output OUTPUT |
файл или каталог для сборки; по умолчанию текущий каталог и имя из манифеста архива, “<Имя> <Версия>.xasm” |
elemctl apps export-extension
usage: elemctl apps export-extension [-h] [--app-id APP_ID] [--output OUTPUT] [APP_ID] EXTENSION
Аргументы
| Параметр | Описание |
|---|---|
APP_ID |
ид (UUID) либо точное имя приложения (по умолчанию ELEMENT_APP_ID) |
EXTENSION |
расширение: ид расширения, ид его проекта, имя или представление проекта |
Параметры
| Параметр | Описание |
|---|---|
-h, --help |
показать эту справку и выйти |
--app-id APP_ID |
то же приложение ключом: deploy и apps ensure принимают только эту форму |
--output OUTPUT |
файл или каталог для сборки; по умолчанию текущий каталог и имя из манифеста архива, “<Имя> <Версия>.xasm” |
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-файла: сервер положит ее в проект с ее Ид из Проект.yaml либо заведет новый |
--force-rename |
разрешить загрузку сборки с чужим именем: панель переименует проект-цель и его группу именем сборки |
--space-id SPACE_ID |
пространство, в котором завести проект, когда --project-id не задан (по умолчанию ELEMENT_SPACE_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,extension}] [--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,extension} |
вид проекта (по умолчанию из Проект.yaml/Project.yaml) |
--require-clean |
прервать сборку, если в каталоге проекта есть незакоммиченные изменения |
elemctl inspect
usage: elemctl inspect [-h] FILE
Аргументы
| Параметр | Описание |
|---|---|
FILE |
файл архива сборки |
Параметры
| Параметр | Описание |
|---|---|
-h, --help |
показать эту справку и выйти |
elemctl deploy
usage: elemctl deploy [-h] [--expected-app-name EXPECTED_APP_NAME]
[--expected-app-uri EXPECTED_APP_URI] [--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]
[--server-start-timeout SERVER_START_TIMEOUT]
Параметры
| Параметр | Описание |
|---|---|
-h, --help |
показать эту справку и выйти |
--expected-app-name EXPECTED_APP_NAME |
ожидаемое точное имя приложения; несовпадение останавливает деплой до сборки |
--expected-app-uri EXPECTED_APP_URI |
ожидаемый точный URI приложения; несовпадение останавливает деплой до сборки |
--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 |
разрешить применение, которое пересоздаёт или удаляет данные (сужение длины, смена типа реквизита, в том числе в табличной части, снятие целиком справочника, документа или регистра, в том числе описанного заново с новым Ид); без флага такое развёртывание отклоняется до сборки. Снятие реквизита или табличной части флага не требует: деплой называет его и идёт дальше |
--server-start-timeout SERVER_START_TIMEOUT |
сколько секунд ждать сервер 1С:Элемент, пока он стартует и его консоль отвечает 404 “Application “console” not found“ (по умолчанию 900; 0 – не ждать) |
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 |
выключить |
elemctl user-lists password-login
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] [--cleanup APP_ID]
Параметры
| Параметр | Описание |
|---|---|
-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 |
прервать проверку, если в каталоге проекта есть незакоммиченные изменения |
--cleanup APP_ID |
убрать оставленный пробник по его приложению (ид или имя): приложение, сборку пробника в его проекте и проект, если в нём больше ничего нет; пробник со своими именем и версией узнаётся по локальному реестру загрузок; чужое приложение команда не тронет. Ключ можно повторить: пробники убираются по очереди, у каждого свой отчет, и отказ одного не останавливает остальных |
elemctl verify-deploy
usage: elemctl verify-deploy [-h] [--app-id APP_ID] [--version-id VERSION_ID]
[--expected-version EXPECTED_VERSION] [--since-minutes SINCE_MINUTES]
[APP_ID]
Аргументы
| Параметр | Описание |
|---|---|
APP_ID |
ид (UUID) либо точное имя приложения (по умолчанию ELEMENT_APP_ID) |
Параметры
| Параметр | Описание |
|---|---|
-h, --help |
показать эту справку и выйти |
--app-id APP_ID |
то же приложение ключом: deploy и apps ensure принимают только эту форму |
--version-id VERSION_ID |
ид загруженной сборки, которую ждем примененной – надежная сверка (строку версии сборки, загруженной в проект, сервер назначает сам); сборку расширения команда узнает сама и сверяет с расширениями приложения |
--expected-version EXPECTED_VERSION |
строка версии вместо ид сборки – запасная сверка |
--since-minutes SINCE_MINUTES |
за сколько последних минут считать ошибки задач своими (по умолчанию 30) |
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
Задачи приложений. Формы: elemctl tasks list [--app-id ИД] – перечень задач; elemctl tasks get-group TASK_ID – статус групповой задачи. Ключ --app-id принадлежит действию list и ставится после него.
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 [{servers,all}]]
Параметры
| Параметр | Описание |
|---|---|
-h, --help |
показать эту справку и выйти |
--version VERSION |
целевая версия (по умолчанию – последняя с PyPI) |
--stop-holders [{servers,all}] |
снять серверы, держащие установку (MCP-сессии elemctl), и обновиться. Идущие команды других сессий называются по pid и не трогаются; со значением all снимаются и они, и такая команда обрывается без результата. Без флага держатели только называются |
elemctl mcp
usage: elemctl mcp [-h]
Параметры
| Параметр | Описание |
|---|---|
-h, --help |
показать эту справку и выйти |