Command lines interface

CLI: clock

CLI for SW clock validation

find-clock

Returns an array of filtered configurations based on ids (ids containing the provided string), role, clocked_Instance, type.

Options:

Name	Description	Required	Default value
--clocked-instance <clocked_Instance>	The clocked_Instance to find in the clock tree	false
--exact	Perform an exact search, matching the query string exactly as provided.	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--id <id>	The id to find in the clock tree	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--role <role>	The role to find in the clock tree	false
--type <type>	The type to find in the clock tree	false

get-clock

Returns the configuration of a specific clock element in a formatted object.

Options:

Name	Description	Required	Default value
--format, <string>	Specify the desired format of the returned data. Provide a comma-separated list of fields (e.g., “id,value,type”). If omitted, defaults to “id,value”.	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--id, <string>	exact id of the clock element to retrieve	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

get-clock-constraints

Returns a list of clock elements that have applied constraints

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

get-clock-items

Returns a list of clock items in {key, value} format.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--ids, <string>	exact ids of the clock elements to retrieve	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

get-clock-status

Returns the global status of the clock tree, checking for out-of-range configurations.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

get-clocks

Returns the configuration of all clock elements in a formatted object.

Options:

Name	Description	Required	Default value
--format, <string>	Specify the desired format of the returned data. Provide a comma-separated list of fields (e.g., “id,value,type”). If omitted, defaults to “id,value”.	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

list-possible-values

Lists possible values for a given clock element. Possible values can be a frequency range or a set of multiple values or a fixed value depending on the clock element.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--id, <string>	exact id of the clock element to retrieve	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

reset

Resets clock to default state.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--skip-confirmation	Using this option executes the command without any confirmation.	false

set-clock-constraints

Applies a constraint to a clock element. Supported constraints are: minimize, maximize.

Options:

Name	Description	Required	Default value
--allow-unlock	This option allows unlocking clock elements if they are affected by the current setClockConstraintCommand (i.e., the locked element is in the main update path).	false
--constraints <format>	The string describing the constraints to apply: minimize, maximize, lock, unlock	false
--flexible-path	This option allows the clock solver to make modifictaion in the current clock path.	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--id, <string>	exact id of the clock elements to apply constraints to.	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--role, <string>	Role of the clock elements to apply constraints to.	false

set-max-value-by-hw-instance

Sets a hardware-instance clock element to its defined maximum value.

Options:

Name	Description	Required	Default value
--allow-unlock	This option allows unlocking clock elements if they are affected by the current command (i.e., the locked element is in the main path).	false
--flexible-path	This option allows the clock solver to make modification in the current clock path.	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--hw-instance, <string>	exact hw instance id of the clock element to update	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--type, <string>	type of clock element to update	false

set-value

Sets the value of a specific configuration item.

Options:

Name	Description	Required	Default value
--allow-unlock	This option allows unlocking clock elements if they are affected by the current setValueCommand (i.e., the locked element is in the main path).	false
--flexible-path	This option allows the clock solver to make modifictaion in the current clock path.	false
--fraction-denominator, <string>	Optional fractional denominator for divider elements	false
--fraction-value, <string>	Optional fractional numerator for divider elements	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--id, <string>	exact id of the clock elements to retrieve	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--value, <string>	New element value	true

set-value-by-hw-instance

Sets the value of a specific configuration item.

Options:

Name	Description	Required	Default value
--allow-unlock	This option allows unlocking clock elements if they are affected by the current setValueCommand (i.e., the locked element is in the main path).	false
--flexible-path	This option allows the clock solver to make modifictaion in the current clock path.	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--hw-instance, <string>	exact hw instanceid of the clock elements to retrieve	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--type, <string>	type of clock elements to retrieve	false
--value, <string>	New element value	true

set-values

Sets new values to a set of clock items

Options:

Name	Description	Required	Default value
--allow-unlock	This option allows unlocking clock elements if they are affected by the current setValuesCommand (i.e., the locked element is in the main path).	false
--flexible-path	This option allows the clock solver to make modifictaion in the current clock path.	false
--fraction-denominators, <string>	Optional comma-separated fractional denominators for divider elements	false
--fraction-values, <string>	Optional comma-separated fractional numerators for divider elements	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--ids, <string>	exact ids of the clock elements to retrieve	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--values, <string>	new values for the clock elements	true

solver-on-demand

Calls the clock solver to fix erroneous values in the clock tree.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

CLI: composer

CLI for sw composer feature

add-component

Add one component to an existing software component project

Options:

Name	Description	Required	Default value
-c,--component-id <componentId>	Unique CMSIS component identifier (required)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r,--resolve-dependency-strategy <resolveDependencyStrategy>	Strategy to use for resolving dependencies : ‘optimistic’ -default- or ‘conservative’ (optional)	false
--skip-configuration-instance <skipConfigurationInstance>	With the skip option you could add a component without automatically adding a software instance (optional)	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

add-files

Add any library or dependency files to a SW project

Options:

Name	Description	Required	Default value
-b, --build-target <string>	Build target context representation on format ‘[projectName][.buildType][+targetType]’	false
-c,--category <string>	Category of the file (required) [Allowed values:api, doc, genAsset, genHeader, genParams, genSource, header, headerAsm, headerC, headerCpp, headerLd, image, include, includeAsm, includeC, includeCpp, includeLd, library, linkerScript, object, other, preIncludeGlobal, preIncludeLocal, source, sourceAsm, sourceC, sourceCpp, utility]	true
-f,--files ‘[<string>]’	List of files to add (required)	true
-g,--group <string>	Group of the file (optional) (default value ‘UserCode’)	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

apply-quick-fix

Apply quick fix for a single or multiple actions

Options:

Name	Description	Required	Default value
-a,--actions <string>	Actions (required)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

delete-configuration-instances

Delete a list of configuration instances of a components in a software project

Options:

Name	Description	Required	Default value
-c,--component-id <string>	Unique CMSIS component identifier (required)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-i,--instance-id <string>	A list of configuration instances (required)	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

get-component-label

Get the label of a component

Options:

Name	Description	Required	Default value
-c,--component-id <string>	Unique CMSIS component identifier (required)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

get-processor-configuration

Get processor configuration

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

get-rtos

Get Real-Time Operating System (RTOS) component of a SW project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

list-component-conditions

List the conditions for a specific component

Options:

Name	Description	Required	Default value
-c,--component-id <string>	Unique CMSIS component identifier (required)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

list-component-fixes

List the available fixes for a specific component

Options:

Name	Description	Required	Default value
-c,--component-id <string>	Unique CMSIS component identifier (required)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

list-components

List all the components

Options:

Name	Description	Required	Default value
-e,--extended <boolean>	To indicate that extended information will be displayed (optional)	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

list-files

List any library or dependency files of a SW project

Options:

Name	Description	Required	Default value
-c,--category <string>	Category of the file(s) (optional) [Allowed values: api, doc, genAsset, genHeader, genParams, genSource, header, headerAsm, headerC, headerCpp, headerLd, image, include, includeAsm, includeC, includeCpp, includeLd, library, linkerScript, object, other, preIncludeGlobal, preIncludeLocal, source, sourceAsm, sourceC, sourceCpp, utility]	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

list-packs

List all packs of a SW project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

list-project-fixes

List the available fixes for all the components of a specific software project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

remove-all-components

Remove all the components

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

remove-component

Remove a specific component from an existing software component project

Options:

Name	Description	Required	Default value
-c,--component-id <string>	Unique CMSIS component identifier (required)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--keep-dependencies <boolean>	Keep component dependencies (default: false)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

remove-components

remove a list of components from an existing software component project

Options:

Name	Description	Required	Default value
--component-ids <string>	list of unique CMSIS component identifiers (required)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

remove-files

Remove any files or libraries from a SW project

Options:

Name	Description	Required	Default value
-f,--files ‘[<string>]’	List of files or libraries to remove (required)	true
-g,--group <string>	Group of the file (optional) (default value ‘UserCode’)	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

reorder-component-instances

Reorder component software instances

Options:

Name	Description	Required	Default value
-c,--component-id <string>	Unique CMSIS component identifier (required)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-i,--instance-id <string>	The software instance id to move [Could be retrieved for the SW config store](required)	true
-o,--overlapping-instance-id <string>	Id for the overlapping instance id[Could be retrieved for the SW config store](required)	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

resolve-dependencies

Resolve dependencies for a software project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r,--resolve-dependency-strategy <string>	Strategy to use for resolving dependencies : ‘optimistic’ -default- or ‘conservative’ (optional)	false	optimistic
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

search-components

Search components

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--search-text <string>	Search pattern (required)	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

set-component-label

Change the component label

Options:

Name	Description	Required	Default value
-c,--component-id <string>	Unique CMSIS component identifier (required)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-l,--label <string>	Wanted label to apply for the component(optional)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

set-processor-configuration

Set processor configuration for the configurable values

Options:

Name	Description	Required	Default value
--dsp <string> (on, off)	DSP configuration	false
--fpu <string> (sp, dp, off)	FPU configuration	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

CLI: data-analytics

CLI for data analytics feature

get-telemetry

Retrieve the current telemetry data collection status. This command allows you to check whether telemetry data collection is enabled or disabled for your project.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false

set-telemetry

Opt-in or opt-out of telemetry data collection. This command allows you to enable or disable the collection of telemetry data, which helps us improve our products and services. By opting in, you agree to share anonymous usage data with us. You can opt out at any time using this command.

Arguments:

Name	Description
<enabled>	Enable or disable telemetry data collection. Use “true” or “1” to enable and “false” or “0” to disable.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false

CLI: dma

CLI for dma feature

bind-resource

Bind a specific DMA channel to a MemToMem software configuration.(--project-path (-p) and --channel (-c) are required)

Options:

Name	Description	Required	Default value
-c,--channel <string>	Dma channel (required)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

extract-store

Returns a copy of the DMA store file generated by the tool. (--project-path (-p) is required)

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

get-allocations

Returns all the DMA channels allocations for a specific software project. (--project-path (-p) is required)

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

list-channels

Returns the list of dma channels .(--project-path (-p) is required and --sw-project-path (-s) are required))

Options:

Name	Description	Required	Default value
-d,--dma-controller <string>	Name of the DMA controller	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--hw-instance <string>	Name of the hardware instance	false
-n,--not-used <boolean>	List not used channels only	false	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
-u,--used <boolean>	List used channels only	false	false

list-configurable-channels

Returns the list of configurable channels by IP. (--project-path (-p) is required)

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

list-controllers

Returns the list of dma controllers available in the SoC. (--project-path (-p) is required)

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

list-hw-resources

Returns the list of all the hardware resources allocated for a specific channel. (--project-path (-p) and --channel (-c) are required)

Options:

Name	Description	Required	Default value
-c,--channel <string>	Dma channel (required)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

list-sw-instances

Returns the list of all the software instances ids used for a specific channel. (--project-path (-p) and --channel (-c) are required)

Options:

Name	Description	Required	Default value
-c,--channel <string>	Dma channel (required)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

unbind-resource

unbind a specific DMA channel configured in a specific MemToMem configuration. (--project-path (-p) ,-sw-project-path (-s),--channel (-c) are required) and --sw-instance are required.

Options:

Name	Description	Required	Default value
-c,--channel <string>	Dma channel (required)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
--sw-instance <string>	ID of the software instance to unbind(required)	true

CLI: exti

CLI for exti feature

is-used

Returns if an exti line is used

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-l,--line-id <string>	exti line identifier	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

list-hw-resources

Returns the list of all the hardware resources using an exti line

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-l,--line-id <string>	exti line identifier	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

list-lines

Returns the list of exti lines being used|list all exti lines available in the HW

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--hw-instance <string>	name of the hardware instance	false
-n,--not-used	list not used lines only	false	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
-u,--used	list used lines only	false	false

list-sw-instances

Returns the list of all the software instances ids used for a specific exti line

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-l,--line-id <string>	exti line identifier	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

CLI: finder

The finder command is designed to extract and display marketing information for boards and devices. It is particularly useful for developers and engineers who need specific details about supported MX products.

device

Groups all finder’s commands related to device.

info

get device information per CPN or per PPN

Options:

Name	Description	Required	Default value
--cpn <cpn>	Filter by CPN	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
--ppn <ppn>	Filter by PPN	false

list

get all devices

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--line <line>	Filter by line	false
--port <port>	STM32CubeMX2 backend port	false
--series <series>	Filter by series	false

CLI: global-services

Provide users with the ability to manage/view project-level configuration options, enabling them to activate, configure, or deactivate settings as needed

disable

Disable a project global service

Arguments:

Name	Description
<globalServiceId>	Global service to disable

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

enable

Enable a project global service

Arguments:

Name	Description
<globalServiceId>	Global service to enable

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

list

List the project global services

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

CLI: hw-platform

CLI for hardware platform feature

board-info

get Board informations for a given project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

mcu-info

get Mcu informations for a given project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

CLI: ide-project

Cube IDE Project CLI

build-target

Manage the build targets of a software project

add

Add a new build target to the list of build targets

Options:

Name	Description	Required	Default value
--force	The existing build-types/target-types matching the ‘target’ will be overwritten	false	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--name <name>	The name of the build target. String representation of a BuildType on format “[projectName][.buildType][+targetType]”	true
--port <port>	STM32CubeMX2 backend port	false
--profile <profile>	The build profile type	false	Debug
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--toolchain <toolchain>	The toolchain	false	GCC

list

List all build targets for the project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

remove

Remove a build target from the list of build targets

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--name <name>	The name of the build target. String representation of a BuildType on format “[projectName][.buildType][+targetType]”	true
--port <port>	STM32CubeMX2 backend port	false
--profile <profile>	The build profile type	false	Debug
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

flag

Manage the compiler flags of a build setup and the generic settings of a solution or project

add

Add flags to the build setup

Arguments:

Name	Description
<flags>	the list of flags

Options:

Name	Description	Required	Default value
--force	force to add the flags at the end even it already occurs in the list	false	false
--from-scratch	Clear any potentially existing configuration before adding the new flags	false	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--setup <setup name>	For compiler tools: required, the build type (CubeMX default naming = Build Profile type + Compiler Family : “debug_GCC”, “release_GCC”, “debug_ARM”, …). For generic tools: optional, omit it for the solution level (or the project level when --software-project is given), use “.<buildType>” for the build-types level or “+<targetType>” for the target-types level	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
--tool <tool…>	the tool names; choices: [‘asm, c, cpp, link, link-c, link-cpp, generic-define, generic-add-path, generic-optimize’]	true

list

List the flags of a build setup

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--setup <setup name>	For compiler tools: required, the build type (CubeMX default naming = Build Profile type + Compiler Family : “debug_GCC”, “release_GCC”, “debug_ARM”, …). For generic tools: optional, omit it for the solution level (or the project level when --software-project is given), use “.<buildType>” for the build-types level or “+<targetType>” for the target-types level	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
--tool <tool…>	the tool names; choices: [‘asm, c, cpp, link, link-c, link-cpp, generic-define, generic-add-path, generic-optimize’]	true

remove

Remove flags from the build setup

Arguments:

Name	Description
<flags>	the list of flags

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--setup <setup name>	For compiler tools: required, the build type (CubeMX default naming = Build Profile type + Compiler Family : “debug_GCC”, “release_GCC”, “debug_ARM”, …). For generic tools: optional, omit it for the solution level (or the project level when --software-project is given), use “.<buildType>” for the build-types level or “+<targetType>” for the target-types level	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
--tool <tool…>	the tool names; choices: [‘asm, c, cpp, link, link-c, link-cpp, generic-define, generic-add-path, generic-optimize’]	true

fmt

FMT stands for File Mapping Table, which is a set of rules to customize the placement inside the exported IDE project of packs, user modifiable files and generated files.

reload

Reload FMT rules defined in the running STM32CubeMX instance or provided in the file option and overwrite values in project

Options:

Name	Description	Required	Default value
--file <fmtFilePath>	The FMT rules file to load, if not provided, the one configured in the running STM32CubeMX instance will be used	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

show

Show FMT rules values stored in the project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

show-schema

Show the FMT JSON Schema

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false

validate

Validate FMT rules file defined in the running STM32CubeMX instance or provided in the file option

Options:

Name	Description	Required	Default value
--file <fmtFilePath>	The FMT rules file to load, if not provided, the one configured in the running STM32CubeMX instance will be used	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false

validate-project

Validate FMT rules file defined in the running STM32CubeMX instance or provided in the file option and compare it with the values stored in the project

Options:

Name	Description	Required	Default value
--file <fmtFilePath>	The FMT rules file to load, if not provided, the one configured in the running STM32CubeMX instance will be used	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

generate

Generate the project

Options:

Name	Description	Required	Default value
--build-profile <buildProfile>	The build profile used when no explicit build target is provided	false
--build-target <buildTarget…>	The name of the build target (repeatable: “--build-target .BT1 .BT2”). String representation of a BuildTarget on format “[projectName][.buildType][+targetType]”	false
--destination <destination>	The destination	false
--diff <diff>	The diff option to handle file collision. This option is not saved and needs to be set every time if you choose something different than keep_user	false	keep_user
-f, --force	Allow generation into a non-empty export destination	false	false
--format <format>	The project format	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--keep-folder-structure <value>	Allow keeping original folder structure. Auto will let STM32CubeMX2 handle it. This option is not saved and needs to be set everytime if you choose something different than auto	false	auto
--make-user-code-local <value>	Allow making user code local to exported project. Auto will let STM32CubeMX2 handle it. This option is not saved and needs to be set everytime if you choose something different than auto	false	auto
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--remove-board	Remove board and associated packs	false	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
--source <source>	The export source	false

list-available-toolchains-by-format

List the available toolchains by format

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false

list-format

List all available project formats

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false

list-generator

List the generators for the project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

list-source

List all available project sources

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false

list-toolchain

List the available toolchains

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false

set-destination

Set the destination folder for project generation

Options:

Name	Description	Required	Default value
--destination <destination>	the generation destination folder	true
--format <format>	The format to export as	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

set-format

Set the default format for the project - see list-format for available formats

Options:

Name	Description	Required	Default value
--format <format>	The format to export as	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

set-modifiable-base-dir

Set the directory for user modifiable code

Options:

Name	Description	Required	Default value
--base-dir <baseDir>	Base directory to set	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

set-remove-board

Set the removal of board and associated packs when generating the project

Options:

Name	Description	Required	Default value
--format <format>	The format to export as	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--remove-board	Remove board and associated packs	false	false

set-source

Set the source - see list-source for available sources

Options:

Name	Description	Required	Default value
--format <format>	The format to export as	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--source <source>	the source pack location	true

set-target

Set the target on format [projectName][.buildType][+targetType] to assign to the project

Options:

Name	Description	Required	Default value
--format <format>	The format to export as	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--target <target>	the target to assign	true

show-config

Show the export configuration of the project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

status

Get status

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--only-application-project	Get status for application project	false	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

CLI: middleware

CLI for middleware feature

disable-middleware

Disable a middleware from the software project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-n,--name <readableName>	readable middleware name (required)	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

enable-middleware

Enable a middleware in the software project. If no version is specified, the latest installed compatible version will be enabled. If none of the compatible versions are installed, the latest compatible version will be downloaded (requires network access) and enabled.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-n,--name <readableName>	readable middleware name (required)	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
-v,--version <version>	middleware pack version	false

get-available-middleware

Get the list of all available middleware for the project. If --all-versions is specified, all compatible versions will be returned, otherwise only the preferred version will be returned. The result contains the following properties: - name: The metadata name of the middleware. - id: The metadata unique identifier of the middleware. - category: The metadata category of the middleware. - componentDescriptionId: The CMSIS component description ID of the middleware. - enabled: A boolean indicating if the middleware is already enabled on this project. - compatibility: A string indicating the compatibility of the middleware pack with the project. Possible values are ‘compatible’, ‘incompatible’, or ‘unknown’. - pack: An object containing information about the pack associated with the middleware: - name: The name of the pack. - version: The version of the pack. - installed: A boolean indicating if the pack is already installed.

Options:

Name	Description	Required	Default value
--all-versions	Get all versions of the middleware	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

get-default-middleware

Get the list of default middleware for the project. If --all-versions is specified, all compatible versions will be returned, otherwise only the preferred version will be returned. The result contains the following properties: - name: The metadata name of the middleware. - id: The metadata unique identifier of the middleware. - category: The metadata category of the middleware. - componentDescriptionId: The CMSIS component description ID of the middleware. - enabled: A boolean indicating if the middleware is already enabled on this project. - compatibility: A string indicating the compatibility of the middleware pack with the project. Possible values are ‘compatible’, ‘incompatible’, or ‘unknown’. - pack: An object containing information about the pack associated with the middleware: - name: The name of the pack. - version: The version of the pack. - installed: A boolean indicating if the pack is already installed.

Options:

Name	Description	Required	Default value
--all-versions	Get all versions of the default middleware	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

CLI: nvic

CLI for nvic feature

get-grouping

Returns grouping.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-v, --values	get possible values	false

get-interrupt

Returns the nvic interrupt details.

Options:

Name	Description	Required	Default value
--description	get only interrupt description	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-n,--name <string>	name of nvic interrupt	true
--port <port>	STM32CubeMX2 backend port	false
--priority	get only interrupt priority (and subpriority)	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--status	get only interrupt status	false

get-interrupts-by-instance

Returns nvic interrupts by instance.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-i,--instance <string>	instance name	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

get-priority

Returns priority.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-n,--name <string>	name of nvic interrupt	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-v, --values	get possible values	false

list-interrupts

Returns the list of nvic interrupts.

Options:

Name	Description	Required	Default value
--full	full output	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--peripheral	list only peripheral interrupts	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
--system	list only system interrupts	false
--used	list only used interrupts	false

set-grouping

Change priority grouping.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-v, --value <number>	priority grouping value	true

set-interrupts

Enable/Disable NVIC system interrupts.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-n,--names <names…>	Names of NVIC interrupts, separated by commas	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
--status <number>	true to enable the interrupts, false to disable them	true

set-priorities

Set priorities of NVIC interrupts.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-i, --interrupts <string…>	list of nvic interrupts with priorities (format: name1,priority1,subpriority1;name2,priority2,subpriority2;…)	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

CLI: pack-manager

CLI for pack manager feature

add-registry

Add one or more registries to the pack manager configuration

Options:

Name	Description	Required	Default value
--cmsis-pack-root <path>	Use specific <path> instead of env CMSIS_PACK_ROOT (optional)	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
--url <url…>	Registry URL(s) to add (required)	true

get-license-path

Shows the license path for an installed pack.

Options:

Name	Description	Required	Default value
--cmsis-pack-root <path>	Use specific <path> instead of env CMSIS_PACK_ROOT (optional)	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pack-id <string>	A pack identifier such as ARM.CMSIS.5.8.0	true
--port <port>	STM32CubeMX2 backend port	false

install

Install one or multiple packs using either URL, VENDOR.NAME.VERSION identifier, or a local extracted package folder.

Options:

Name	Description	Required	Default value
--cmsis-pack-root <string>	Use specific <path> instead of env CMSIS_PACK_ROOT (optional)	false
--destination <string>	Use specific <path> to install the pack to this local destination. If multiple packs are installed, the identifier will be a subfolder of the destination. (optional)	false
--force	Force installation even if pack is already present. (optional)	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--mcu-package <string>	A local path to a stm32 cube mcu package folder	false
--pack-ids <string…>	One or more pack URLs or identifiers such as ARM.CMSIS.5.8.0	false
--port <port>	STM32CubeMX2 backend port	false

list-boards

List of available board(s).

Options:

Name	Description	Required	Default value
--cmsis-pack-root <path>	Use specific <path> instead of env CMSIS_PACK_ROOT (optional)	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
--verbose	display full board name (optional)	false

list-devices

List of available devices(s).

Options:

Name	Description	Required	Default value
--cmsis-pack-root <path>	Use specific <path> instead of env CMSIS_PACK_ROOT (optional)	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false

list-packs

List of available pack(s).

Options:

Name	Description	Required	Default value
--cmsis-pack-root <path>	Use specific <path> instead of env CMSIS_PACK_ROOT (optional)	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false

remove

Remove selected pack(s).

Options:

Name	Description	Required	Default value
--cmsis-pack-root <string>	Path to the software project directory [relative paths are supported]. (optional)	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pack-ids <string…>	An identifier such as ARM.CMSIS.5.8.0 (required)	true
--port <port>	STM32CubeMX2 backend port	false

CLI: partitioning

CLI to manage partitioning information (view, edition, validation)

create-contextual-ioc2

Create a Context project (.ioc2) for an ExecutionContext defined in the system project

Options:

Name	Description	Required	Default value
--all	Create a Context project for every ExecutionContext defined in the system project	false
-n, --context-name <name>	Name of the ExecutionContext to materialize as a Context project	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	true

list-contexts

List the ExecutionContexts defined in the system project, with their execution domain and IOC2 attributes

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	true

model

View and edit the partitioning model

generate-markdown

Generate a Markdown report from the live multi-context model

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--output-file <path>	Write command output to this file	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	true

get

Read and print the current live generated DSL model document

Options:

Name	Description	Required	Default value
--format <format>	Output format: json or mc	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--output-file <path>	Write command output to this file	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	true

init

Replace the live multi-context model with an empty generated DSL model document

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	true

set

Replace the full live generated DSL model document from a JSON or McDSL file

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--input-file <path>	Path to a JSON file or .mc file containing the generated DSL Model payload	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	true

validate

Validate a generated DSL model document from a JSON or McDSL file

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--input-file <path>	Path to a JSON file or .mc file containing the generated DSL Model payload	true
--port <port>	STM32CubeMX2 backend port	false

CLI: parts

CLI for parts feature

add-standalone-part

Add a standalone hardware part to the project by applying case-insensitive substring filters (metadata & pack id). Fails if zero or multiple parts match; succeeds only when exactly one candidate is found.

Options:

Name	Description	Required	Default value
--hclass <readableName>	Hardware class substring filter (optional)	false
--hgroup <readableName>	Hardware group substring filter (optional)	false
--hname <readableName>	Hardware name substring filter (optional)	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--hrevision <readableName>	Hardware revision substring filter (optional)	false
--hsub <readableName>	Hardware sub-group substring filter (optional)	false
--hvariant <readableName>	Hardware variant substring filter (optional)	false
--hvendor <readableName>	Hardware vendor substring filter (optional)	false
--packidName <readableName>	CMSIS pack name substring filter (optional)	false
--packidVendor <readableName>	CMSIS pack vendor substring filter (optional)	false
--packidVersion <readableName>	CMSIS pack version substring filter (optional)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--shortname <readableName>	Friendly name substring filter (optional)	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

disable-part

Disable a part for the targeted sw project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pcb <readableName>	Printed Circuit Board of the part to be enabled (optional)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r,--referenceOnBoard <readableName>	referenceOnBoard of the part to be disable (required)	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

enable-part

Enable a part for the targeted sw project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pcb <readableName>	Printed Circuit Board of the part to be enabled (optional)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r,--referenceOnBoard <readableName>	referenceOnBoard of the part to be enabled (required)	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

get-mounted-parts

Get the list of mounted parts for the project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

get-standalone-parts

List all standalone parts currently added to the project; excludes mounted parts already available through the board definition.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

remove-standalone-part

Remove a standalone hardware part by its exact referenceOnBoard; only succeeds if the reference matches one and only one standalone part.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r,--referenceOnBoard <readableName>	referenceOnBoard of the part to be removed (required)	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

search-standalone-parts

List compatible standalone parts applying case-insensitive substring filters; returns metadata summaries.

Options:

Name	Description	Required	Default value
--hclass <readableName>	Hardware class substring filter (optional)	false
--hgroup <readableName>	Hardware group substring filter (optional)	false
--hname <readableName>	Hardware name substring filter (optional)	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--hrevision <readableName>	Hardware revision substring filter (optional)	false
--hsub <readableName>	Hardware sub-group substring filter (optional)	false
--hvariant <readableName>	Hardware variant substring filter (optional)	false
--hvendor <readableName>	Hardware vendor substring filter (optional)	false
--packidName <readableName>	CMSIS pack name substring filter (optional)	false
--packidVendor <readableName>	CMSIS pack vendor substring filter (optional)	false
--packidVersion <readableName>	CMSIS pack version substring filter (optional)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--shortname <readableName>	Friendly name substring filter (optional)	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

CLI: peripherals

CLI for peripherals feature

description

Display the informations about a peripheral.

Options:

Name	Description	Required	Default value
--cpn <cpn>	Specify the CPN of a board	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--peripheral <peripheral>	The id of the peripheral	true
--port <port>	STM32CubeMX2 backend port	false

disable

Disable a peripheral.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--peripheral <peripheral>	The id of the peripheral to disable	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	true
--software-project <softwareProject>	Name of the software project in which peripheral will be disabled	false

enable

Enable a peripheral.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--mode <mode>	Name of the mode to use (some peripherals require mode choice in order to be used)	false
--override	Override the existing mode of an already enabled peripheral	false
--peripheral <peripheral>	The id of the peripheral to enable	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	true
--software-project <softwareProject>	Name of the software project in which peripheral will be enabled	false

list

List peripherals in an MX2 project.

Options:

Name	Description	Required	Default value
--details	Include more information about each peripheral	false	false
--enabled	Filter to keep only peripherals that are enabled	false	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	true
--search <search>	Search peripheral by id in the project	false

resource

Display the hardware resource of a peripheral.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--peripheral <peripheral>	The id of the peripheral (e.g. I2C3)	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	true
--software-project <softwareProject>	The name of the software project (defaults to the default software project)	false

view

Display the id, name, and other information about a peripheral.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--peripheral <peripheral>	The id of the peripheral to view	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	true
--software-project <softwareProject>	Name of the software project (defaults to the default software project)	false

CLI: pinout

Pinout CLI for STM32CubeMX2

add-label

Add a label to a pin.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--label <label>	label (example: My_ADC1_input)	false
--pin <pinName>	pin name (example: PA15)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

add-to-group

Adds a pin to a GPIO group (uses the default group if --group is omitted).

Options:

Name	Description	Required	Default value
--group <group>	group name (example: gpio_default)	false	gpio_default
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pin <pinName>	pin name (example: PA15)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

all-pins

Returns all the pins.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--short	shorter output	false

assign-signal

Assigns a signal to a pin.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pin <pinName>	pin name (example: PA15)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--signal <signal>	signal name (example: GPIO)	false

assigned-pins

Returns all pins with assigned signal(s).

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--short	shorter output	false

exclude-pin

Excludes a pin from pinout configuration and automatic resolution algorithm.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pin <pinName>	pin name (example: PA15)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

group

Returns a GPIO group description (default group if groupName is omitted).

Options:

Name	Description	Required	Default value
--group <group>	group name (example: gpio_default)	false	gpio_default
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--short	shorter output	false

include-pin

Includes a pin (previously excluded) for pinout configuration and automatic resolution algorithm.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pin <pinName>	pin name (example: PA15)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

needs

Get for each configured pin, the SW instance using it and with which signal.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--instance [instanceName]	instance name (example: I2C1)	false	all
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--short	shorter output	false

pin

Returns a pin description.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pin <pinName>	pin name (example: PA15)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--short	shorter output	false

pin-signal

Pins a signal to a pin.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pin <pinName>	pin name (example: PA15)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--signal <signal>	signal name (example: GPIO)	false

remove-from-group

Removes a pin from a GPIO group (default group if groupName is omitted).

Options:

Name	Description	Required	Default value
--group <group>	group name (example: gpio_default)	false	gpio_default
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pin <pinName>	pin name (example: PA15)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

remove-label

Remove a label from a pin.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--label <label>	label (example: My_ADC1_input)	false
--pin <pinName>	pin name (example: PA15)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

reset-pin

Reset a pin. Reserved signals are reset, configured signals are preserved, labels are preserved, excluded pins are restored

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pin <pinName>	pin name (example: PA15)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

reset-pinout

Reset all the pins. Reserved signals are reset, configured signals are preserved, labels are preserved, excluded pins are restored

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

unassign-signal

Unassigns a signal from a pin.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pin <pinName>	pin name (example: PA15)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--signal <signal>	signal name (example: GPIO)	false

unpin-signal

Unpins a signal from a pin.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pin <pinName>	pin name (example: PA15)	false
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--signal <signal>	signal name (example: GPIO)	false

CLI: preferences

CLI for preferences feature

get-preference

Return the current value of a specified preference

Options:

Name	Description	Required	Default value
--default-value	Return the default value of the specified preference	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
--possible-values	Return the possible values of the specified preference	false
--pref <preference>	Return the current value of the specified preference	true

get-preferences

Return the whole list of preferences with their current values

Options:

Name	Description	Required	Default value
--default-values	Return the whole list of preferences with their default values	false
-e, --export <path>	Save the result to the given path	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
--possible-values	Return the whole list of preferences with their possible values	false

list-preferences

Display the list of user preferences

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false

set-preference

Change the value of a specified preference

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
--pref <preference>	The preference to set	true
--value <value>	New value for the specified preference	true

set-preferences

Set several preferences at once

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
--prefs <preferences>	JSON file path or JSON string with preference key/value pairs	true

CLI: project

close

close a project

Options:

Name	Description	Required	Default value
--discard	If specified, discard unsaved changes on the project.	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

create-from-board

Create an Application Project from Board

Options:

Name	Description	Required	Default value
--cpn <cpn>	Specify the CPN of a board (must have an STM32 mounted device)	true
--empty-project	Create an empty project without any example code (only the board support package will be included)	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--overwrite	Overwrite existing project at target IOC2 path	false
--pack-name <packName>	Specify the board pack name; filters boards by pack name (case-insensitive)	false
--pack-version <packVersion>	Specify the board pack version; filters boards by pack version (case-insensitive)	false
--port <port>	STM32CubeMX2 backend port	false
-l, --project-location <projectLocation>	Project location (use “.” to create locally)	true
-n, --project-name <projectName>	Specify project name	true

create-from-mcu

Create an Application Project from MCU

Options:

Name	Description	Required	Default value
--cpn <cpn>	Specify the CPN of a STM32 MCU	true
--empty-project	Create an empty project without any example code (only the board support package will be included)	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--overwrite	Overwrite existing project at target IOC2 path	false
--pack-name <packName>	Specify the mcu pack name. Limits the results to the specified <packName>	false
--pack-version <packVersion>	Specify the mcu pack version. Limits the results to the specified <packVersion>	false
--port <port>	STM32CubeMX2 backend port	false
-l, --project-location <projectLocation>	Project location (use “.” to create locally)	true
-n, --project-name <projectName>	Specify project name	true

create-software

create a software Project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--software-project <softwareProject>	Optionally provide a software project name (by default takes <cubemx project name>)	false

delete

delete a project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

get-sw-project-list

list software projects in the project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

pack

Manage application project packs

add

The command adds a pack inside the project csolution.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--pack-id <packId>	The pack to add	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

list

The command enumerates all the packs utilized within a project.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
--upgradable	lists packs which can be upgraded.	false	false

update

Resolve and apply application project pack updates.

save

save a project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

set-linked

Set IOC2 linked attribute to true

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

set-read-only

Set IOC2 read-only attribute to true

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

unset-linked

Unset IOC2 linked attribute (remove the flag)

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

unset-read-only

Unset IOC2 read-only attribute (remove the flag)

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false

CLI: sw-config

CLI for sw-configuration feature

add-array-element

Add an element to an array

Options:

Name	Description	Required	Default value
-e, --element-to-add <elementToAdd>	element to be added to the array	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--parameter-path <pathToParameter>	json path to the parameter	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r, --resource-name <resourceName>	Resource name (HW resource name for bound components, or a unique identifier for unbound components such as middleware or parts).	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

get-parameter-actions

Get the actions (if any, from the parameters.json) of a given parameter

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--parameter-path <pathToParameter>	json path to the parameter	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r, --resource-name <resourceName>	Resource name (HW resource name for bound components, or a unique identifier for unbound components such as middleware or parts).	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

get-parameter-possible-values

Get the possible values of a given parameter

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--parameter-path <pathToParameter>	json path to the parameter	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r, --resource-name <resourceName>	Resource name (HW resource name for bound components, or a unique identifier for unbound components such as middleware or parts).	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
--use-internal-value	By default, parameter values use their user-friendly representation. Set the “use-internal-value” option to use the internal value instead (the one used in the ioc2 file).	false

get-parameter-value

Get the value of a given parameter

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--parameter-path <pathToParameter>	json path to the parameter	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r, --resource-name <resourceName>	Resource name (HW resource name for bound components, or a unique identifier for unbound components such as middleware or parts).	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
--use-internal-value	By default, parameter values use their user-friendly representation. Set the “use-internal-value” option to use the internal value instead (the one used in the ioc2 file).	false

list-available-parameters

List the visible parameters in a given component instance

Options:

Name	Description	Required	Default value
-d, --details <string>	The “details” option can be equal to “short” or “full” (it is optional). The “short” choice adds the value for each parameter to the output and if it is readonly or not. The “full” choice for each parameter adds the value, if it is readonly or not, its possible values and its actions (if any) to the output.	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r, --resource-name <resourceName>	Resource name (HW resource name for bound components, or a unique identifier for unbound components such as middleware or parts).	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
--use-internal-value	By default, parameter values use their user-friendly representation. Set the “use-internal-value” option to use the internal value instead (the one used in the ioc2 file).	false

list-configurations

List the configurations of the project (the whole ones or for an optional component)

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
-c, --sw-component-id <string>	component identifier (optional)	false

list-parameters

List all the parameters in a given component instance

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r, --resource-name <resourceName>	Resource name (HW resource name for bound components, or a unique identifier for unbound components such as middleware or parts).	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

move-array-element

Move an element to a given rank

Options:

Name	Description	Required	Default value
-e, --element-to-move <elementToMove>	element to be moved in the array	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--parameter-path <pathToParameter>	json path to the parameter	true
--port <port>	STM32CubeMX2 backend port	false
--position <position>	position can be up, down or a specific rank	true
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r, --resource-name <resourceName>	Resource name (HW resource name for bound components, or a unique identifier for unbound components such as middleware or parts).	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

move-array-elements

Move several elements to the given ranks

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-m, --moves <moves>	array of {”_itemTitle”: “keyValue”, “rank”: “rankValue”}	true
--parameter-path <pathToParameter>	json path to the parameter	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r, --resource-name <resourceName>	Resource name (HW resource name for bound components, or a unique identifier for unbound components such as middleware or parts).	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

remove-array-element

Remove an element from an array

Options:

Name	Description	Required	Default value
-i, --element-index <elementIndex>	index of the element to be removed (index in 0..arraySize-1)	true
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--parameter-path <pathToParameter>	json path to the parameter	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r, --resource-name <resourceName>	Resource name (HW resource name for bound components, or a unique identifier for unbound components such as middleware or parts).	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

reset-configuration

Reset a configuration (restores default; same action than UI button Reset Configuration)

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r, --resource-name <resourceName>	Resource name (HW resource name for bound components, or a unique identifier for unbound components such as middleware or parts).	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

set-multiple-parameters

Set the value of several parameters

Options:

Name	Description	Required	Default value
--force	disable parameter validation checks for this command	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--parameters <parameters>	array of {“path”: “parameterPath”, “value”: “parametervalue”}	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r, --resource-name <resourceName>	Resource name (HW resource name for bound components, or a unique identifier for unbound components such as middleware or parts).	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

set-parameter-value

Set the value of a given parameter

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--parameter-path <pathToParameter>	json path to the parameter	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-r, --resource-name <resourceName>	Resource name (HW resource name for bound components, or a unique identifier for unbound components such as middleware or parts).	true
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
-v, --value <value>	parameter value	true

CLI: utilities

CLI for utilities feature

disable-utility

Disable a utility from the software project

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-n,--name <readableName>	readable utility name (required)	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

enable-utility

Enable a utility in the software project. If no version is specified, the latest installed compatible version will be enabled. If none of the compatible versions are installed, the latest compatible version will be downloaded (requires network access) and enabled.

Options:

Name	Description	Required	Default value
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
-n,--name <readableName>	readable utility name (required)	true
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false
-v,--version <version>	utility pack version	false

get-available-utilities

Get the list of all available utilities for the project. If --all-versions is specified, all compatible versions will be returned, otherwise only the preferred version will be returned. The result contains the following properties: - name: The metadata name of the utility. - id: The metadata unique identifier of the utility. - category: The metadata category of the utility. - componentDescriptionId: The CMSIS component description ID of the utility. - enabled: A boolean indicating if the utility is already enabled on this project. - compatibility: A string indicating the compatibility of the utility pack with the project. Possible values are ‘compatible’, ‘incompatible’, or ‘unknown’. - pack: An object containing information about the pack associated with the utility: - name: The name of the pack. - version: The version of the pack. - installed: A boolean indicating if the pack is already installed.

Options:

Name	Description	Required	Default value
--all-versions	Get all versions of the utilities	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

get-default-utilities

Get the list of default utilities for the project. If --all-versions is specified, all compatible versions will be returned, otherwise only the preferred version will be returned. The result contains the following properties: - name: The metadata name of the utility. - id: The metadata unique identifier of the utility. - category: The metadata category of the utility. - componentDescriptionId: The CMSIS component description ID of the utility. - enabled: A boolean indicating if the utility is already enabled on this project. - compatibility: A string indicating the compatibility of the utility pack with the project. Possible values are ‘compatible’, ‘incompatible’, or ‘unknown’. - pack: An object containing information about the pack associated with the utility: - name: The name of the pack. - version: The version of the pack. - installed: A boolean indicating if the pack is already installed.

Options:

Name	Description	Required	Default value
--all-versions	Get all versions of the default utilities	false
--host <host>	STM32CubeMX2 backend host	false	127.0.0.1
--port <port>	STM32CubeMX2 backend port	false
-p, --project-path <projectPath>	Path to the ‘.ioc2’ file.	false
-s, --software-project <softwareProjectName>	Software project name. If not specified a default software project will be used if any.	false

---

Last updated 2026-11-03 b’10:07:20 CET’