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/CLI/cli-setup/cli-reqs.md
+21-9Lines changed: 21 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -196,14 +196,14 @@ Add the following to the system `PATH`:
196
196
You must inform Mbed CLI about the location of your compiler using one of the following methods:
197
197
198
198
- The Mbed CLI configuration command.
199
-
- Adding the compiler's directory to your PATH.
200
199
- Setting an environment variable.
200
+
- Adding the compiler's directory to your PATH.
201
201
202
202
<span class="tips">**Tip:** You may configure more than one toolchain. However, you may only use one toolchain at a time. For more information, see [the multiple toolchains section below](#optional-configuring-multiple-toolchains)</span>
203
203
204
204
#### Method 1: Mbed CLI configuration
205
205
206
-
Mbed CLI stores its own configuration about compiler locations in both project local settings and user wide global settings. You may set and view these settings with the `mbed config` command. For example, set the Arm Compiler 5 location for your user with the command:
206
+
Mbed CLI stores its own configuration about compiler locations in both project local settings and user wide global settings. You may set and view these settings with the `mbed config` command. For example, set the Arm Compiler 5 location with the command:
207
207
208
208
```
209
209
$ mbed config -G ARM_PATH "C:\Program Files\ARM"
@@ -221,15 +221,28 @@ Mbed CLI supports a setting for each toolchain path:
In addition to the Mbed CLI configuration, Mbed CLI detects executables that are in toolchain-specific environment variables. These environment variables are the same as their corresponding configuration <!--where is the corresponding configuration variable?-->variable, with a prefix of `MBED_` added. For example, when configuring Arm Compiler 5, you set the `MBED_ARM_PATH` environment variable to the base directory of your Arm Compiler 5 installation.<!--what do I actually do in this section? And is it a standalone, or does it go with something else (since you used "also" I'm not sure)-->
230
+
231
+
Mbed CLI detects compilers with specially named environment variables. These environment variables are the same as their corresponding configuration <!--where is the corresponding configuration variable?-->variable, with a prefix of `MBED_` added. For example, when configuring Arm Compiler 5, you set the `MBED_ARM_PATH` environment variable to the base directory of your Arm Compiler 5 installation.<!--what do I actually do in this section? And is it a standalone, or does it go with something else (since you used "also" I'm not sure)-->
232
+
233
+
#### Method 3: system PATH
234
+
235
+
<!-- vvv (Chris) added this, may need TLC <3 vvv -->
236
+
In addition to toolchain-specific environment variables, Mbed CLI detects executables that are in your system `PATH`. This means that if you install a toolchain in the system `PATH` (different for each OS), Mbed CLI will automatically find the toolchain.
237
+
238
+
<!-- (Chris) rm me?
226
239
The `mbed compile` command checks your system `PATH` for an executable that the toolchain setting specifies. This is the same check that a shell would perform to find the executable on the command-line. `mbed compile` uses absolute path names for every toolchain except `GCC_ARM`.
240
+
-->
227
241
228
242
<!--so what do I do in this section - set paths? This feels more like background info than instructions. And is the GCC_ARM thing part of the previous sentence, or in contradiction? what should I do with GCC_ARM, if it's in contradiction?-->
229
243
230
-
#### Method 3: environment variable
231
244
232
-
Mbed CLI detects compilers with specially named environment variables. These environment variables are the same as their corresponding configuration <!--where is the corresponding configuration variable?-->variable, with a prefix of `MBED_` added. For example, when configuring Arm Compiler 5, you set the `MBED_ARM_PATH` environment variable to the base directory of your Arm Compiler 5 installation.<!--what do I actually do in this section? And is it a standalone, or does it go with something else (since you used "also" I'm not sure)-->
245
+
233
246
234
247
#### Optional: configuring multiple toolchains
235
248
@@ -258,6 +271,7 @@ To install `mbed-cli` bash tab completion:
258
271
## Reference: Working with `mbed config`
259
272
260
273
<!--should this be here, or in another part of the CLI docs?-->
274
+
<!--(Chris) This is needed above! Should we move this up?-->
261
275
262
276
The Mbed CLI configuration syntax is:
263
277
@@ -281,13 +295,11 @@ Command options:
281
295
282
296
| Option | Explanation |
283
297
| --- | --- |
284
-
| `--global` | Defines the default behavior of Mbed CLI across programs, unless overridden by *local* settings. |
285
-
| None | Any configuration done without `--global` is specific to the Mbed program. It overrides global or default Mbed CLI settings. If you do not specify a value, then Mbed CLI prints the value for this setting in the current working context. |
298
+
| `--global` | Defines the default behavior of Mbed CLI across all applications, unless overridden by *local* settings. |
299
+
| None | Any configuration done without `--global` is specific to a single Mbed application. It overrides global or default Mbed CLI settings. If you do not specify a value, then Mbed CLI prints the value for this setting in the current working context. |
286
300
| `--unset` | Remove a setting. |
287
301
| `--list` | List global and local configuration. |
288
302
289
-
<!--what does "Mbed program" mean? This isn't a term I've seen us use before-->
0 commit comments