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 are accepted in any position – before the command and after it: elemctl --timeout 120 apps list and elemctl apps list --timeout 120 are the same run. 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`	the Client-Secret for that Client-Id (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 the version 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
`user-lists`	user lists and their sign-in settings
`probe`	isolated compilation check: build -> throwaway application -> errors with file and position -> cleanup; the project directory must follow the {repository}/{Vendor}/{Name}/Project.yaml layout – the Vendor+Name pair is how the platform identifies the project
`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
`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)
`apply`	apply an uploaded assembly to an application and verify that it really landed
`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 apps list`

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

Options

Option	Description
`-h, --help`	show this help message and exit
`--name NAME`	case-insensitive name substring filter (applied client-side)
`--status STATUS`	filter by status (Running, Stopped, Error, Deleted); several of them separated by commas
`--brief`	brief cards: id, name, status, uri, applied version

`elemctl apps get`

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

Arguments

Option	Description
`APP_ID`	the application id (UUID) or its exact name (default: ELEMENT_APP_ID)

Options

Option	Description
`-h, --help`	show this help message and exit
`--app-id APP_ID`	the same application as an option: deploy and apps ensure take this form only

`elemctl apps find`

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

Arguments

Option	Description
`NAME`	the application name

Options

Option	Description
`-h, --help`	show this help message and exit
`--include-deleted`	search deleted applications too (skipped by default)

`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

Arguments

Option	Description
`NAME`	the application name

Options

Option	Description
`-h, --help`	show this help message and exit
`--project-id PROJECT_ID`	source project
`--version-id VERSION_ID`	id of the source assembly; if the project does not exist yet, create it with ‘builds upload <file>.xasm `--space-id` <id>’ without `--project-id`
`--latest-build`	source: the project’s latest assembly
`--space-id SPACE_ID`	space
`--tech-version TECH_VERSION`	technology version
`--no-dev-mode`	do not create a development environment
`--wait`	wait until the application is ready

`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

Arguments

Option	Description
`NAME`	the application name

Options

Option	Description
`-h, --help`	show this help message and exit
`--project-id PROJECT_ID`	source project
`--version-id VERSION_ID`	id of the source assembly; if the project does not exist yet, create it with ‘builds upload <file>.xasm `--space-id` <id>’ without `--project-id`
`--latest-build`	source: the project’s latest assembly
`--space-id SPACE_ID`	space
`--tech-version TECH_VERSION`	technology version
`--no-dev-mode`	do not create a development environment
`--wait`	wait until the application is ready
`--apply`	when the application already exists, apply the given assembly to it (otherwise the answer only says that it was not applied)

`elemctl apps apply`

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

Arguments

Option	Description
`APP_ID`	the application id (UUID) or its exact name (default: ELEMENT_APP_ID)
`VERSION_ID`	id of the uploaded assembly (the project version id)

Options

Option	Description
`-h, --help`	show this help message and exit
`--app-id APP_ID`	the same application as an option: deploy and apps ensure take this form only

`elemctl apps delete`

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

Arguments

Option	Description
`APP_ID`	the application id (UUID) or its exact name

Options

Option	Description
`-h, --help`	show this help message and exit
`--app-id APP_ID`	the same application as an option: deploy and apps ensure take this form only

`elemctl apps start`

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

Arguments

Option	Description
`APP_ID`	the application id (UUID) or its exact name (default: ELEMENT_APP_ID)

Options

Option	Description
`-h, --help`	show this help message and exit
`--app-id APP_ID`	the same application as an option: deploy and apps ensure take this form only

`elemctl apps stop`

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

Arguments

Option	Description
`APP_ID`	the application id (UUID) or its exact name (default: ELEMENT_APP_ID)

Options

Option	Description
`-h, --help`	show this help message and exit
`--app-id APP_ID`	the same application as an option: deploy and apps ensure take this form only

`elemctl apps debug`

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

Arguments

Option	Description
`APP_ID`	the application id (UUID) or its exact name (default: ELEMENT_APP_ID)

Options

Option	Description
`-h, --help`	show this help message and exit
`--app-id APP_ID`	the same application as an option: deploy and apps ensure take this form only

`elemctl spaces`

usage: elemctl spaces [-h] action ...

Arguments

Option	Description
`list`	list spaces

Options

Option	Description
`-h, --help`	show this help message and exit

`elemctl spaces list`

usage: elemctl spaces list [-h]

Options

Option	Description
`-h, --help`	show this help message and exit

`elemctl projects`

usage: elemctl projects [-h] action ...

Arguments

Option	Description
`list`	list projects
`get`	project details
`delete`	delete a project

Options

Option	Description
`-h, --help`	show this help message and exit

`elemctl projects list`

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

Options

Option	Description
`-h, --help`	show this help message and exit
`--name NAME`	case-insensitive name substring filter (applied client-side)
`--include-deleted`	list deleted projects too (hidden by default)

`elemctl projects get`

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

Arguments

Option	Description
`PROJECT_ID`	the project id (default: ELEMENT_PROJECT_ID)

Options

Option	Description
`-h, --help`	show this help message and exit

`elemctl projects delete`

usage: elemctl projects delete [-h] PROJECT_ID

Arguments

Option	Description
`PROJECT_ID`	the project id

Options

Option	Description
`-h, --help`	show this help message and exit

`elemctl builds`

usage: elemctl builds [-h] action ...

Arguments

Option	Description
`list`	list project assemblies (newest first)
`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 builds list`

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

Options

Option	Description
`-h, --help`	show this help message and exit
`--project-id PROJECT_ID`	the project id (default: ELEMENT_PROJECT_ID)
`--limit LIMIT`	how many assemblies to show (default 10; 0 – all)
`--brief`	brief cards: id, versions, date, branch, commit

`elemctl builds get`

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

Arguments

Option	Description
`VERSION`	the assembly version or its id

Options

Option	Description
`-h, --help`	show this help message and exit
`--project-id PROJECT_ID`	the project id (default: ELEMENT_PROJECT_ID)

`elemctl builds upload`

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

Arguments

Option	Description
`FILE`	the .xasm/.xlib assembly file

Options

Option	Description
`-h, --help`	show this help message and exit
`--project-id PROJECT_ID`	project; WITHOUT it the platform creates a new project – the only way to create a project through the Console API
`--new-project`	upload the build as a new project, ignoring ELEMENT_PROJECT_ID from the environment and the .env file
`--force-rename`	allow uploading an assembly whose name differs: the console renames the target project and its group after the assembly
`--space-id SPACE_ID`	the space to create the project in – needed when `--project-id` is omitted

`elemctl builds delete`

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

Arguments

Option	Description
`VERSION`	the assembly version or its id

Options

Option	Description
`-h, --help`	show this help message and exit
`--project-id PROJECT_ID`	the project id (default: 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]

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/Project.yaml)
`--require-clean`	abort the build if the project directory has uncommitted changes

`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] [--dry-run] [--require-clean] [--allow-data-loss]

Options

Option	Description
`-h, --help`	show this help message and exit
`--app-id APP_ID`	the application id (default: ELEMENT_APP_ID)
`--project-id PROJECT_ID`	the project id (default: ELEMENT_PROJECT_ID)
`--project-dir PROJECT_DIR`	the project directory (by default searched downward from the current one)
`--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)
`--dry-run`	build only, no upload
`--require-clean`	abort the deploy if the project directory has uncommitted changes
`--allow-data-loss`	allow an apply that recreates the data of the objects (a narrowed length, a changed attribute type); without the flag such a deploy is refused before the build

`elemctl user-lists`

usage: elemctl user-lists [-h] action ...

Arguments

Option	Description
`list`	list the user lists
`get`	the list card: registration, password policy, account services
`self-registration`	self-registration of users: show or switch
`password-login`	signing in with a login and a password (the Local account service): show or switch
`calculation-rules`	the rules that parse the account service’s answer: show the target or write them

Options

Option	Description
`-h, --help`	show this help message and exit

`elemctl user-lists list`

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

Options

Option	Description
`-h, --help`	show this help message and exit
`--name NAME`	filter by a presentation substring

`elemctl user-lists get`

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

Arguments

Option	Description
`LIST`	the user list id or its exact presentation

Options

Option	Description
`-h, --help`	show this help message and exit
`--app APP`	take the application’s own list (its id or exact name)

`elemctl user-lists self-registration`

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

Arguments

Option	Description
`LIST`	the user list id or its exact presentation

Options

Option	Description
`-h, --help`	show this help message and exit
`--app APP`	take the application’s own list (its id or exact name)
`--enable`	turn on
`--disable`	turn off

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

Arguments

Option	Description
`LIST`	the user list id or its exact presentation

Options

Option	Description
`-h, --help`	show this help message and exit
`--app APP`	take the application’s own list (its id or exact name)
`--enable`	turn on
`--disable`	turn off

`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]

Arguments

Option	Description
`LIST`	the user list id or its exact presentation

Options

Option	Description
`-h, --help`	show this help message and exit
`--app APP`	take the application’s own list (its id or exact name)
`--rules-file RULES_FILE`	a JSON file with the whole set of rules
`--response-kind RESPONSE_KIND`	the kind of answer being parsed
`--presentation-rule PRESENTATION_RULE`	the rule that builds the user’s presentation
`--phone-rule PHONE_RULE`	the phone rule
`--email-rule EMAIL_RULE`	the email rule
`--service SERVICE`	the account service by id (default: the first service of type Oidc)
`--service-type SERVICE_TYPE`	the type of the account service when no id is given

`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]

Options

Option	Description
`-h, --help`	show this help message and exit
`--project-dir PROJECT_DIR`	the project directory – …/{Vendor}/{Name} with Project.yaml inside (by default searched downward from the current one)
`--output OUTPUT`	directory for the archive (default: a temporary one)
`--build-version BUILD_VERSION`	explicit build version (default {base}`-probe-`{token} – it has to be a new one)
`--name NAME`	name of the throwaway application (default elemctl-probe-{token})
`--space-id SPACE_ID`	the space for the project and the application (ELEMENT_SPACE_ID)
`--keep`	skip the cleanup: leave the application and the build for a hands-on look
`--require-clean`	abort the check if the project directory has uncommitted changes

`elemctl branches`

usage: elemctl branches [-h] action ...

Arguments

Option	Description
`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 branches list`

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

Options

Option	Description
`-h, --help`	show this help message and exit
`--project-id PROJECT_ID`	the project id (default: ELEMENT_PROJECT_ID)
`--name NAME`	filter by branch name

`elemctl branches get`

usage: elemctl branches get [-h] ID

Arguments

Option	Description
`ID`	the branch id

Options

Option	Description
`-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

Arguments

Option	Description
`NAME`	the branch name

Options

Option	Description
`-h, --help`	show this help message and exit
`--project-id PROJECT_ID`	the project id (default: ELEMENT_PROJECT_ID)
`--app-id APP_ID`	bind to an application right away

`elemctl branches update`

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

Arguments

Option	Description
`ID`	the branch id

Options

Option	Description
`-h, --help`	show this help message and exit
`--app-id APP_ID`	the application id (default: ELEMENT_APP_ID)

`elemctl branches delete`

usage: elemctl branches delete [-h] ID

Arguments

Option	Description
`ID`	the branch id

Options

Option	Description
`-h, --help`	show this help message and exit

`elemctl branches merge`

usage: elemctl branches merge [-h] ID

Arguments

Option	Description
`ID`	the branch id

Options

Option	Description
`-h, --help`	show this help message and exit

`elemctl dumps`

usage: elemctl dumps [-h] action ...

Arguments

Option	Description
`create`	create a dump
`get`	dump status

Options

Option	Description
`-h, --help`	show this help message and exit

`elemctl dumps create`

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

Arguments

Option	Description
`APP_ID`	the application id (default: ELEMENT_APP_ID)

Options

Option	Description
`-h, --help`	show this help message and exit
`--description DESCRIPTION`	dump description

`elemctl dumps get`

usage: elemctl dumps get [-h] APP_ID DUMP_ID

Arguments

Option	Description
`APP_ID`	the application id
`DUMP_ID`	the dump id

Options

Option	Description
`-h, --help`	show this help message and exit

`elemctl tasks`

usage: elemctl tasks [-h] action ...

Arguments

Option	Description
`list`	list application tasks
`get-group`	group task status

Options

Option	Description
`-h, --help`	show this help message and exit

`elemctl tasks list`

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

Options

Option	Description
`-h, --help`	show this help message and exit
`--app-id APP_ID`	filter by application (client-side)

`elemctl tasks get-group`

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

Arguments

Option	Description
`TASK_ID`	the group task id

Options

Option	Description
`-h, --help`	show this help message and exit

`elemctl tech`

usage: elemctl tech [-h] action ...

Arguments

Option	Description
`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 tech get`

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

Arguments

Option	Description
`APP_ID`	the application id (default: ELEMENT_APP_ID)

Options

Option	Description
`-h, --help`	show this help message and exit

`elemctl tech set`

usage: elemctl tech set [-h] APP_ID VERSION

Arguments

Option	Description
`APP_ID`	the application id
`VERSION`	the technology version to move the application to

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] [--stop-holders]

Options

Option	Description
`-h, --help`	show this help message and exit
`--version VERSION`	target version (default: the latest from PyPI)
`--stop-holders`	stop the processes holding the installation (elemctl MCP sessions) and update; without the flag the command only names them

`elemctl mcp`

usage: elemctl mcp [-h]

Options

Option	Description
`-h, --help`	show this help message and exit