Mistake on this page?
Report an issue in GitHub or email us

Requirements

  • Python: Mbed CLI is a Python script, so you'll need Python to use it:

    Note: Python 3 usage is not compatible with Mbed OS versions older than 5.9 and Mbed CLI toolchain versions older than 1.7.2.

    Note: Mbed CLI toolchain versions older than 1.5.1 are not compatible with pip version 10.0 (or newer). Please use the latest Mbed CLI with newer version of pip.

  • Git and Mercurial: Mbed CLI supports both Git and Mercurial repositories, and you may need libraries from both sources as you work, so please to install both:

    • Git - version 1.9.5 or later.
    • Mercurial - version 2.2.2 or later.
  • Command-line compiler or IDE toolchain: Mbed CLI invokes the Mbed OS 5 tools for various features, such as compiling, testing and exporting to industry standard toolchains. To compile your code, you need either a compiler or an IDE:

    • Compilers: Arm GCC, Arm Compiler 5, IAR.
    • IDE: Keil uVision, DS-5, IAR Workbench.

    Note: When installing the Arm Compiler 5 on a 64-bit Linux machine, you may need to also install the i386 architecture package:

    $ sudo dpkg --add-architecture i386
    $ sudo apt-get update
    $ sudo apt-get install libc6:i386 libncurses5:i386 libstdc++6:i386
    

Working with virtual environments

Mbed CLI is compatible with Virtual Python Environment (virtualenv).

You may want to install Mbed CLI on a virtual environment if your main environment has an unsupported Python version.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.