You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tools/offline/cli-setup.md
+4-1Lines changed: 4 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,14 @@ You can install Mbed CLI on Windows, Linux and Mac OS X.
7
7
## Requirements
8
8
9
9
-**Python:** Mbed CLI is a Python script, so you'll need Python to use it:
10
-
- We test Mbed CLI with [version 2.7.11 of Python](https://www.python.org/downloads/release/python-2711/). It is not compatible with Python 3.
10
+
- We test Mbed CLI with [Python versions 2.7.11+ and 3.6.5+](https://www.python.org/downloads/).
11
11
- pip.
12
+
13
+
<spanclass="notes">**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. </span>
12
14
13
15
<spanclass="notes">**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`.</span>
14
16
17
+
15
18
-**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:
16
19
-[Git](https://git-scm.com/) - version 1.9.5 or later.
17
20
-[Mercurial](https://www.mercurial-scm.org/) - version 2.2.2 or later.
Copy file name to clipboardExpand all lines: docs/tutorials/quickstart/quick-start-cli.md
+30-8Lines changed: 30 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -8,17 +8,39 @@ The setup process for Arm Mbed CLI depends on your operating system. Please choo
8
8
9
9
#### Windows
10
10
11
-
##### 1. Install Mbed CLI
11
+
Two installation methods are available for Windows. The first is a prebuilt installer that you can use quickly. The second installation method is more flexible and allows for greater customization to better fit your system's needs.
12
+
13
+
##### Prebuilt Mbed CLI installer
12
14
13
15
Download and run the [Mbed CLI Windows .exe installer](https://mbed-media.mbed.com/filer_public/50/38/5038849b-16a8-42f3-be7a-43d98c7a3af3/mbed_installer_v043.exe).
14
16
15
17
You can ensure Mbed CLI installed correctly by running `mbed help` from your command-line.
16
18
17
19
<spanclass="notes">**Note:** The Windows installer only installs the GNU Arm embedded toolchain. If you want to compile using Arm Compiler 5 or IAR, visit the [supported compilers page](/docs/latest/tools/index.html#compiler-versions).</span>
18
20
21
+
#### Manual installation
22
+
23
+
###### 1. Download and install Python and Pip
24
+
25
+
Download and install [Python versions 2.7.11+ or 3.6.5+](https://www.python.org/downloads/windows/) for Windows. Both Python versions come with their own version of Pip.
26
+
27
+
<spanclass="notes">**Note:** When the installer launches, check the checkbox that says **Add Python X.Y to PATH**. Otherwise, Windows does not know where to search for the Python executable.</span>
28
+
29
+
###### 2. Install a compiler
30
+
31
+
Download and install a compiler.
32
+
33
+
<spanclass="notes">**Note:** To download the latest toolchains, visit the [supported compilers page](/docs/development/tools/index.html#compiler-versions).</span>
34
+
35
+
###### 3. Install Mbed CLI
36
+
37
+
To install Mbed CLI, run `pip install mbed-cli` from your command-line.
38
+
39
+
You can ensure Mbed CLI installed correctly by running `mbed --version`.
40
+
19
41
##### 2. Setup environment
20
42
21
-
For any installed toolchain, be sure to add the Mbed CLI global configuration:
43
+
After installation is complete, be sure to add any available toolchains to Mbed CLI's global configuration. Below is an example using the ARM compiler:
22
44
23
45
```
24
46
> mbed config -G ARM_PATH <path to ARM bin\>"
@@ -36,7 +58,7 @@ ARM_PATH=<path to ARM bin\>
36
58
37
59
##### 1. Install Python and Pip
38
60
39
-
Mac OS X 10.8+ comes with Python 2.7 preinstalled by Apple. If you are running an earlier version of Mac OS X, download and install [Python 2.7.12+](https://www.python.org/downloads/mac-osx/).
61
+
Mac OS X 10.8+ comes with Python 2.7 preinstalled by Apple. If you are running an earlier version of Mac OS X, download and install [Python versions 2.7.11+ or 3.6.5+](https://www.python.org/downloads/mac-osx/).
40
62
41
63
To install Pip, run `sudo easy_install pip` from your command-line.
42
64
@@ -50,7 +72,7 @@ Download and install a compiler.
50
72
51
73
To install Mbed CLI, run `pip install mbed-cli` from your command-line.
52
74
53
-
You can ensure Mbed CLI installed correctly by running `mbed help`.
75
+
You can ensure Mbed CLI installed correctly by running `mbed --version`.
54
76
55
77
##### 4. Setup environment
56
78
@@ -72,12 +94,12 @@ ARM_PATH=<path to ARM bin\>
72
94
73
95
##### 1. Install Python and Pip
74
96
75
-
Download and install [Python 2.7.12+](https://www.python.org/downloads/source/) or run the following from your command-line:
97
+
Download and install [Python versions 2.7.11+ or 3.6.5+](https://www.python.org/downloads/source/), or use your distrubution's package manager to install Python and Pip.
98
+
99
+
As an example, you can use the following in Ubuntu:
0 commit comments