Команды

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

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

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

Общие флаги

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]
               команда ...

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

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

команды:
  команда
    token               получить и напечатать токен
    apps                приложения
    spaces              пространства
    projects            проекты
    builds              сборки проекта на платформе
    build               локально собрать архив сборки из исходников
    inspect             разобрать готовый архив сборки (.xasm/.xlib)
    deploy              полный цикл: сборка -> загрузка -> применение -> перезапуск ->
                        проверка применения
    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]

options:
  -h, --help  show this help message and exit

elemctl apps

Приложения.

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

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

options:
  -h, --help  show this help message and exit

elemctl apps list

Список приложений.

usage: elemctl apps list [-h] [--name NAME]

options:
  -h, --help   show this help message and exit
  --name NAME  фильтр по имени

elemctl apps get

Карточка приложения.

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

positional arguments:
  APP_ID

options:
  -h, --help  show this help message and exit

elemctl apps find

Найти приложение по имени (точное совпадение без учёта регистра).

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

positional arguments:
  NAME

options:
  -h, --help         show this help message and exit
  --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

positional arguments:
  NAME

options:
  -h, --help            show this help message and exit
  --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]
                           NAME

positional arguments:
  NAME

options:
  -h, --help            show this help message and exit
  --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 delete

Удалить приложение (необратимо, url меняется при пересоздании).

usage: elemctl apps delete [-h] APP_ID

positional arguments:
  APP_ID

options:
  -h, --help  show this help message and exit

elemctl apps start

Запустить приложение.

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

positional arguments:
  APP_ID

options:
  -h, --help  show this help message and exit

elemctl apps stop

Остановить приложение.

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

positional arguments:
  APP_ID

options:
  -h, --help  show this help message and exit

elemctl apps debug

Данные для сессии отладки (debug-token, debug-address).

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

positional arguments:
  APP_ID

options:
  -h, --help  show this help message and exit

elemctl spaces

Пространства.

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

positional arguments:
  действие
    list      список пространств

options:
  -h, --help  show this help message and exit

elemctl spaces list

Список пространств.

usage: elemctl spaces list [-h]

options:
  -h, --help  show this help message and exit

elemctl projects

Проекты.

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

positional arguments:
  действие
    list      список проектов
    get       карточка проекта
    delete    удалить проект

options:
  -h, --help  show this help message and exit

elemctl projects list

Список проектов.

usage: elemctl projects list [-h]

options:
  -h, --help  show this help message and exit

elemctl projects get

Карточка проекта.

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

positional arguments:
  PROJECT_ID

options:
  -h, --help  show this help message and exit

elemctl projects delete

Удалить проект.

usage: elemctl projects delete [-h] PROJECT_ID

positional arguments:
  PROJECT_ID

options:
  -h, --help  show this help message and exit

elemctl builds

Сборки проекта на платформе.

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

positional arguments:
  действие
    list      список сборок проекта
    get       карточка сборки по версии либо ид
    upload    загрузить файл сборки (.xasm/.xlib)
    delete    удалить сборку по версии либо ид

options:
  -h, --help  show this help message and exit

elemctl builds list

Список сборок проекта.

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

options:
  -h, --help            show this help message and exit
  --project-id PROJECT_ID

elemctl builds get

Карточка сборки по версии либо ид.

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

positional arguments:
  VERSION

options:
  -h, --help            show this help message and exit
  --project-id PROJECT_ID

elemctl builds upload

Загрузить файл сборки (.xasm/.xlib).

usage: elemctl builds upload [-h] [--project-id PROJECT_ID] [--space-id SPACE_ID]
                             [--branch BRANCH] [--commit COMMIT]
                             [--commit-message COMMIT_MESSAGE]
                             FILE

positional arguments:
  FILE

options:
  -h, --help            show this help message and exit
  --project-id PROJECT_ID
                        проект; БЕЗ него платформа заводит новый проект – это
                        единственный способ создать проект через Console API
  --space-id SPACE_ID
  --branch BRANCH       имя git-ветки (метаданные)
  --commit COMMIT       хэш коммита (метаданные)
  --commit-message COMMIT_MESSAGE
                        сообщение коммита (метаданные)

elemctl builds delete

Удалить сборку по версии либо ид.

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

positional arguments:
  VERSION

options:
  -h, --help            show this help message and exit
  --project-id 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}]

options:
  -h, --help            show this help message and exit
  --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)

elemctl inspect

Разобрать готовый архив сборки (.xasm/.xlib).

usage: elemctl inspect [-h] FILE

positional arguments:
  FILE        файл архива сборки

options:
  -h, --help  show this help message and exit

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] [--commit-message COMMIT_MESSAGE] [--dry-run]

options:
  -h, --help            show this help message and exit
  --app-id APP_ID
  --project-id PROJECT_ID
  --project-dir PROJECT_DIR
  --output OUTPUT       каталог для архива (по умолчанию временный)
  --build-version BUILD_VERSION
                        явная версия сборки
  --branch BRANCH       имя ветки в метаданные (по умолчанию из git)
  --commit COMMIT       хэш коммита в метаданные (по умолчанию из git)
  --commit-message COMMIT_MESSAGE
                        сообщение коммита (метаданные загрузки)
  --dry-run             только сборка, без загрузки

elemctl branches

Ветки среды разработки.

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

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

options:
  -h, --help  show this help message and exit

elemctl branches list

Список веток.

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

options:
  -h, --help            show this help message and exit
  --project-id PROJECT_ID
  --name NAME

elemctl branches get

Карточка ветки.

usage: elemctl branches get [-h] ID

positional arguments:
  ID

options:
  -h, --help  show this help message and exit

elemctl branches create

Создать ветку.

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

positional arguments:
  NAME

options:
  -h, --help            show this help message and exit
  --project-id PROJECT_ID
  --app-id APP_ID       сразу привязать к приложению

elemctl branches update

Изменить ветку (перепривязать к приложению).

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

positional arguments:
  ID

options:
  -h, --help       show this help message and exit
  --app-id APP_ID

elemctl branches delete

Удалить ветку.

usage: elemctl branches delete [-h] ID

positional arguments:
  ID

options:
  -h, --help  show this help message and exit

elemctl branches merge

Принять изменения ветки.

usage: elemctl branches merge [-h] ID

positional arguments:
  ID

options:
  -h, --help  show this help message and exit

elemctl dumps

Дампы приложений.

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

positional arguments:
  действие
    create    создать дамп
    get       статус дампа

options:
  -h, --help  show this help message and exit

elemctl dumps create

Создать дамп.

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

positional arguments:
  APP_ID

options:
  -h, --help            show this help message and exit
  --description DESCRIPTION
                        описание дампа

elemctl dumps get

Статус дампа.

usage: elemctl dumps get [-h] APP_ID DUMP_ID

positional arguments:
  APP_ID
  DUMP_ID

options:
  -h, --help  show this help message and exit

elemctl tasks

Задачи приложений.

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

positional arguments:
  действие
    list       список задач приложений
    get-group  статус групповой задачи

options:
  -h, --help   show this help message and exit

elemctl tasks list

Список задач приложений.

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

options:
  -h, --help       show this help message and exit
  --app-id APP_ID  фильтр по приложению (на клиенте)

elemctl tasks get-group

Статус групповой задачи.

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

positional arguments:
  TASK_ID

options:
  -h, --help  show this help message and exit

elemctl tech

Версия технологии.

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

positional arguments:
  действие
    get       версия технологии приложения
    set       обновить версию технологии (групповая задача)

options:
  -h, --help  show this help message and exit

elemctl tech get

Версия технологии приложения.

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

positional arguments:
  APP_ID

options:
  -h, --help  show this help message and exit

elemctl tech set

Обновить версию технологии (групповая задача).

usage: elemctl tech set [-h] APP_ID VERSION

positional arguments:
  APP_ID
  VERSION

options:
  -h, --help  show this help message and exit

elemctl debug-adapter

Путь к debug-адаптеру платформы из плагина (для расширения vs.

usage: elemctl debug-adapter [-h]

options:
  -h, --help  show this help message and exit

elemctl plugins

Диагностика плагинов elemctl (точки расширения).

usage: elemctl plugins [-h]

options:
  -h, --help  show this help message and exit

elemctl self-update

Обновить elemctl распаковкой колеса (безопасно, когда exe.

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

options:
  -h, --help         show this help message and exit
  --version VERSION  целевая версия (по умолчанию – последняя с PyPI)

elemctl mcp

Запустить mcp-сервер (транспорт stdio).

usage: elemctl mcp [-h]

options:
  -h, --help  show this help message and exit