6.3. Project Command Line Interface

CCStudio for VS Code includes a command-line interface (CLI) for managing projects — importing, building, and inspecting them — without using the Projects view. This is useful for scripting, automated/nightly builds, or working from a terminal instead of the GUI.

Open a terminal with the CLI's location already set up on the PATH using Open CLI Terminal in the Projects view toolbar (see Working with Projects), then run cli (cli.bat on Windows) with one of the commands below. The CLI's own --help output refers to itself as ccs-project-services-cli; this is the name of the underlying library the CLI is built from, not the command to type.

All commands support -h, --help for their own detailed usage, and most accept -c, --configuration <path> to override the default IDE Configuration location (<user-home>/.../Texas Instruments/CCSVSC/, where ... is AppData/Local on Windows, .config on Linux, or Library/Application Support on macOS).

_images/ccsvsc_project-cli-help-output.png

6.3.1. IDE Configuration Commands

6.3.1.1. initialize

Installs required components and discovers locally installed compilers, products, and SDKs.

  • -f, --clean: Perform a full "clean" initialization by purging all cached data. Default: false.

  • -c, --configuration <path>: IDE Configuration location.

Example:

.\cli initialize -f

6.3.1.2. inspect

Inspects the IDE Configuration to view locally discovered compilers, products, and SDKs.

  • -t, --compilers [id-regex]: List all (or matching a given id-regex) locally discovered compiler tools and their details.

  • -p, --products [id-regex]: List all (or matching a given id-regex) locally discovered products/SDKs and their details.

  • -c, --configuration <path>: IDE Configuration location.

Example:

.\cli inspect -p

6.3.2. Project Management Commands

6.3.2.1. project-build

Builds an existing project in the user workspace.

  • -n, --name <name>: Name of the project to build (same as the project's root folder name, by default).

  • -l, --location <path>: Alternatively, the location of the root folder of the project to build.

  • -t, --build-type <type>: Build type — one of incremental, full, clean. Default: incremental.

  • -b, --build-configuration <name>: Name of the build configuration to build. Default: the first one found.

  • -w, --workspace <path>: User workspace location. Required.

  • -c, --configuration <path>: IDE Configuration location.

Example:

.\cli project-build -w C:/Users/user/workspace_ccsvsc -n gpio_toggle_output_LP_MSPM0H3216_nortos_ticlang

6.3.2.2. project-import

Imports an existing project or an example .projectspec file into the user workspace.

  • -l, --location <path>: Location of the root folder of an existing project, or an example .projectspec file to import. Required.

  • -f, --overwrite: Overwrite any existing project by fully deleting it before import. Default: false.

  • -w, --workspace <path>: User workspace location. Required.

  • -c, --configuration <path>: IDE Configuration location.

Example:

.\cli project-build -w C:/Users/user/workspace_ccsvsc -l C:/ti/mspm0_sdk_2_11_00_07/examples/nortos/LP_MSPM0H3216/driverlib/empty/ticlang/empty_LP_MSPM0H3216_nortos_ticlang.projectspec

6.3.2.3. project-inspect

Inspects the list of existing projects in the user workspace, or a specific project's details.

  • -n, --name <name>: Inspect details of the project with the given name (same as the project's root folder name, by default).

  • -l, --location <path>: Alternatively, inspect details of the project at the given location.

  • -r, --show-raw-values: Show raw setting values, without expanding variables.

  • -v, --list-variables: List all variables available in scope of the project.

  • -p, --list-projects: List all projects in the user workspace.

  • -w, --workspace <path>: User workspace location. Required.

  • -c, --configuration <path>: IDE Configuration location.

Example:

.\cli project-build -w C:/Users/user/workspace_ccsvsc -n gpio_toggle_output_LP_MSPM0H3216_nortos_ticlang