Install tools on the command line using vcpkg
Introduction
Install vcpkg
Initialize vcpkg
Create a vcpkg-configuration.json file
Use vcpkg
Activate a license
Remove vcpkg
Next Steps

  Log an issue

  Fork and edit

  Discuss on Discord

Create a vcpkg-configuration.json file

A configuration file ensures a consistent installation of tools across all platforms. It installs the correct binaries depending on the platform (host OS and architecture). Thus, the first step is to create such a configuration file.

Notice of Product License Terms

Your use of an Arm tool is subject to your acceptance of the End User License Agreement for Arm Software Development Tools, located within the license_terms folder of the downloaded archive. By installing and using the Arm tool, you agree to be bound by the terms and conditions of the End User License Agreement.

Create a new file called vcpkg-configuration.json. The following template gives a good starting point for your own configuration file:

    

        
        
{
  "registries": [
    {
      "kind": "artifact",
      "location": "https://artifacts.tools.arm.com/vcpkg-ce-registry/registry.zip",
      "name": "arm"
    }
  ],
  "requires": {
    "arm:tools/kitware/cmake": "^3.25.2",
    "arm:tools/ninja-build/ninja": "^1.10.2",
    "arm:tools/open-cmsis-pack/cmsis-toolbox": "^2.0.0-0",
    "arm:compilers/arm/armclang": "^6.20.0",
    "arm:compilers/arm/arm-none-eabi-gcc": "^12.2.1-0"
  }
}
Note

If you are using the conversion flow for MDK v5 uvprojx files , a configuration file is automatically created.

Anatomy of the JSON file

  • The registries section starting at line 2 specifies the locations containing the tools you want to install.
  • The requires section starting at line 9 contains the tools you want to install. You can select specific versions of the tools in case you do not want to update automatically once a newer version is available. The entry ^6.20.0 specifies that the minimal version is 6.20.0 but all other version above are accepted as well.
  • The CMSIS-Toolbox requires at least one compiler (Arm Compiler for Embedded or GCC) to be installed, as well as cmake and ninja.
Tip

You can now start using the vcpkg environment.

Back
Next