You copied the Doc URL to your clipboard.

Run Arm® Development Studio IDE from the command-line to clean and build your projects

You can run Arm® Development Studio IDE from the command-line to clean and build your projects. This might be useful when you want to create scripts to automate build procedures.

Before you begin, make sure that the Arm Development Studio IDE session is closed.

Use the Arm Development Studio command-line console to load the Arm Development Studio IDE, make, and other utilities on your PATH environment variable. To launch the console:

  • On Windows, select Start > All Programs > Arm Development Studio > Arm DS Command Prompt.
  • On Linux, run <install_directory>/bin/suite_exec <shell> to open a shell.

Run armds_idec.exe (on Windows) or armds_ide (on Linux) with the following Arm Development Studio IDE arguments as required.

Table 2-1 Arm DS IDE arguments

Argument Description
-nosplash Disables the Arm Development Studio IDE splash screen.
--launcher.suppressErrors Causes errors to be printed to the console instead of being reported in a graphical dialog.
-application com.arm.cmsis.pack.project.headlessbuild Mandatory argument telling Arm Development Studio IDE to run the headless builder.
-data <workspaceDir> Specify the location of your workspace.
-import <projectDir>

Import the project from the specified directory into your workspace.

Use this option multiple times to import multiple projects.

-build <projectName>[/<configName>] | all

Build the project with the specified name, or all projects in your workspace.

By default, this argument builds all the configurations within each project. You can limit this action to a single configuration, such as Debug or Release, by specifying the configuration name immediately after your project name, separated with '/'.

Use this option multiple times to build multiple projects.

-cleanBuild <projectName>[/<configName>] | all

Clean and build the project with the specified name, or all projects in your workspace.

By default, this argument cleans and builds all the configurations within each project. You can limit this action to a single configuration, such as Debug or Release, by specifying the configuration name immediately after your project name, separated with '/'.

Use this option multiple times to clean and build multiple projects.

-cmsisRoot <path> Set the path to the CMSIS Packs root directory

Note

On Windows, you must run armds_idec.exe from either the Arm DS Command Prompt, or directly from the <install_directory>/bin directory. Do not run the armds_idec.exe executable that is in the <install_directory>/sw/eclipse directory.

The armds_idec.exe executable in <install_directory>/bin acts as a wrapper for armds_idec.exe in <install_directory>/sw/eclipse. Running the executable from the <install_directory>/bin directory sets up the Arm Development Studio environment (paths, environment variables, and other similar items) in the same way as the Arm DS Command Prompt.

For example:

"C:\Program Files\Arm\Development Studio <version>\bin\armds_idec.exe" -nosplash -application com.arm.cmsis.pack.project.headlessbuild -data "C:\path\to\your\workspace" -cleanBuild startup_Cortex-R8

Examples

On Windows, to list and view the full set of available options, use the command:

armds_idec.exe -nosplash -consoleLog --launcher.suppressErrors -application com.arm.cmsis.pack.project.headlessbuild -help

On Windows, to clean and build all the projects in a specific workspace, use the command:

armds_idec.exe -nosplash -application com.arm.cmsis.pack.project.headlessbuild -data C:<\path\to\workspace> -cleanBuild all

On Linux, to build the Release configuration of project MyProject in a specific workspace, use the command:

armds_ide -nosplash -application com.arm.cmsis.pack.project.headlessbuild -data </path/to/workspace> -build MyProject/Release