Commands
Reference of elemctl commands and options: common flags, applications, builds, deploy and the rest.
This reference is generated from the tool itself – the same text elemctl --help prints, gathered on one page.
Common flags go before the command: elemctl --timeout 120 apps list. The output language follows --lang, the ELEMCTL_LANG variable, or the system locale.
Common flags
Manage 1C:Enterprise.Element platform applications (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]
command ...
Options
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
--base-url BASE_URL |
platform base URL (ELEMENT_BASE_URL) |
--client-id CLIENT_ID |
Client-Id for obtaining a token (ELEMENT_CLIENT_ID) |
--client-secret CLIENT_SECRET |
Client-Secret (ELEMENT_CLIENT_SECRET) |
--env-file ENV_FILE |
path to the .env file (default: .env in the current directory) |
--timeout TIMEOUT |
request timeout in seconds (default 60) |
--lang {ru,en} |
output language (default: env ELEMCTL_LANG / system locale / ru) |
--version |
show program’s version number and exit |
Commands
| Command | Description |
|---|---|
token |
obtain and print a token |
apps |
applications |
spaces |
spaces |
projects |
projects |
builds |
project assemblies on the platform |
build |
build an assembly archive locally from sources |
inspect |
inspect a prebuilt assembly archive (.xasm/.xlib) |
deploy |
full cycle: build -> upload -> apply -> restart -> verify the apply |
branches |
development-environment branches |
dumps |
application dumps |
tasks |
application tasks |
tech |
technology version |
debug-adapter |
path to the platform debug adapter from the plugin (for the VS Code extension) |
plugins |
elemctl plugin diagnostics (extension points) |
self-update |
update elemctl by unpacking the wheel (safe when the exe is held by the MCP server) |
mcp |
start the MCP server (stdio transport) |
elemctl token
usage: elemctl token [-h]
Options
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
elemctl apps
usage: elemctl apps [-h] action ...
Arguments
| Option | Description |
|---|---|
action |
|
list |
list applications |
get |
application details |
find |
find an application by name (exact, case-insensitive match) |
create |
create an application |
ensure |
create the application if it does not exist yet (idempotent) |
delete |
delete an application (irreversible; the URL changes on re-creation) |
start |
start an application |
stop |
stop an application |
debug |
data for a debug session (debug-token, debug-address) |
Options
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
elemctl spaces
usage: elemctl spaces [-h] action ...
Arguments
| Option | Description |
|---|---|
action |
|
list |
list spaces |
Options
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
elemctl projects
usage: elemctl projects [-h] action ...
Arguments
| Option | Description |
|---|---|
action |
|
list |
list projects |
get |
project details |
delete |
delete a project |
Options
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
elemctl builds
usage: elemctl builds [-h] action ...
Arguments
| Option | Description |
|---|---|
action |
|
list |
list project assemblies |
get |
assembly details by version or id |
upload |
upload an assembly file (.xasm/.xlib) |
delete |
delete an assembly by version or id |
Options
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
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
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
--project-dir PROJECT_DIR |
project directory (by default searched downward from the current one) |
--output OUTPUT |
directory for the archive (default: current) |
--build-version BUILD_VERSION |
explicit assembly version, e.g. 1.0-42 |
--last-build LAST_BUILD |
the project’s last assembly version – for auto-increment |
--commit COMMIT |
commit hash for the manifest (default: from git) |
--branch BRANCH |
branch name for the manifest (default: from git) |
--kind {application,library} |
project kind (default: from Проект.yaml) |
elemctl inspect
usage: elemctl inspect [-h] FILE
Arguments
| Option | Description |
|---|---|
FILE |
assembly archive file |
Options
| Option | Description |
|---|---|
-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
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
--app-id APP_ID |
|
--project-id PROJECT_ID |
|
--project-dir PROJECT_DIR |
|
--output OUTPUT |
directory for the archive (default: a temporary one) |
--build-version BUILD_VERSION |
explicit assembly version |
--branch BRANCH |
branch name for the metadata (default: from git) |
--commit COMMIT |
commit hash for the metadata (default: from git) |
--commit-message COMMIT_MESSAGE |
commit message (upload metadata) |
--dry-run |
build only, no upload |
elemctl branches
usage: elemctl branches [-h] action ...
Arguments
| Option | Description |
|---|---|
action |
|
list |
list branches |
get |
branch details |
create |
create a branch |
update |
update a branch (rebind to an application) |
delete |
delete a branch |
merge |
accept the branch’s changes |
Options
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
elemctl dumps
usage: elemctl dumps [-h] action ...
Arguments
| Option | Description |
|---|---|
action |
|
create |
create a dump |
get |
dump status |
Options
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
elemctl tasks
usage: elemctl tasks [-h] action ...
Arguments
| Option | Description |
|---|---|
action |
|
list |
list application tasks |
get-group |
group task status |
Options
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
elemctl tech
usage: elemctl tech [-h] action ...
Arguments
| Option | Description |
|---|---|
action |
|
get |
the application’s technology version |
set |
update the technology version (group task) |
Options
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
elemctl debug-adapter
usage: elemctl debug-adapter [-h]
Options
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
elemctl plugins
usage: elemctl plugins [-h]
Options
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
elemctl self-update
usage: elemctl self-update [-h] [--version VERSION]
Options
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |
--version VERSION |
target version (default: the latest from PyPI) |
elemctl mcp
usage: elemctl mcp [-h]
Options
| Option | Description |
|---|---|
-h, --help |
show this help message and exit |