Skip to main content

CLI Description

As noted previously, the BSP Assistant also includes a CLI executable to run various commands in a terminal window instead of a GUI. To see a list of the various arguments, run the following:

bsp-assistant-cli -h

As an example, the following command and argument lists all the MCUs that contain "PSC":

bsp-assistant-cli list_mcus --filter PSC

The following sections describe each of the arguments available for the BSP Assistant CLI:

change_connectivity <bsp-location> <module-or-device-name>

This argument adds or changes the connectivity module or device specified by the BSP. It displays an error in the following cases:

  • If bsp-location is not the location of a BSP
  • If module-or-device-name is not the name of a connectivity module or connectivity device present in the device database, or if it is incompatible with the MCU/SOC/SIP currently selected in the BSP

change_mcu <bsp-location> <mcu-name>

This argument changes the MCU for the BSP exactly as if you were changing the MCU/SOC/SIP field in the GUI. It displays an error in the following cases:

  • If bsp-location is not the location of a BSP
  • If mcu-name is not the name of an MCU, SOC or SIP present in the device database, or is incompatible with the currently-loaded BSP

create <kit-name> <parent-dir> <bsp-name> [<version>]

This argument creates a new BSP at the specified location from the specified version of the specified board URI, exactly as using the File > New... menu option in the GUI with the appropriate information. It displays an error in the following cases:

  • If kit-name does not match the name or ID of a BSP listed in the board manifests.
  • If parent-dir does not exist
  • If bsp-name begins with "TARGET_"

If you provide the version option, it must be used as follows:

  • A quoted user-facing version string (e.g., "1.2.0 release"), or
  • A commit name (for example, release-v1.2.0), or
  • The special string "latest", which indicates that you want the latest version that specifies a specific version.

Strings such as "Latest 2.X release" and "latest-v2.X" result in an error. If you do not specify version, then the special string "latest" is assumed.

create_from _mpn <mpn-list> <parent-dir> <bsp-name>

This argument creates a BSP that supports the specified MPN or MPNs. The mpn-list is a comma-separated list of MPNs, where the first listed entry is an MCU. It displays an error in the following cases:

  • If parent-dir does not exist
  • If bsp-name begins with "TARGET_"

delete_configuration <bsp-location> <configuration-name>

This argument deletes a configuration file from the BSP. It displays an error if bsp-location is not the location of a BSP.

The configuration-name can be either a configurator name, such as qspi-configurator, or a base configuration file name, such as design.cyqspi.

import <source-bsp-location> <parent-dir> <bsp-name>

This argument imports an existing BSP and creates a new BSP based on it. It displays an error in the following cases:

  • If source-bsp-name is not the location of a BSP
  • If parent-dir does not exist
  • If bsp-name begins with "TARGET_"

list_connectivity [--filter <filter>] [<bsp-location>]

This argument lists all of the connectivity modules and devices that are legal arguments, each on its own line.

  • If you provide the --filter option, the output will only contain devices that match the filter.
  • If you specify the bsp-location option, the output lists only connectivity modules and devices compatible with the specified BSP.

list_kits [--filter <filter>]

This argument lists all of the legal values for kit-name, each on its own line.

  • If you provide the --filter option, the output only contains kits that match the filter.

list_mcus [--filter <filter>] [<bsp-location>]

This argument lists all of the MCUs, SOCs and SIPs that are valid arguments for the following command, each on its own line.

  • If you provide the --filter option, the output only contains kits that match the filter.
  • If you provide the bsp-location option, the output only contains MCUS, SOCs, and SIPs compatible with the specified BSP.

remove_connectivity <bsp-location>

This argument removes connectivity from the given BSP. It displays an error in the following cases:

  • If bsp-location is not the location of a BSP
  • If the BSP currently specifies an SOC or SIP that has built-in connectivity
Last updated on