@@ -6,35 +6,16 @@ This document covers the installation and usage of mbed CLI.
6
6
7
7
## Table of Contents
8
8
9
- 1 . [ Requirements ] ( #requirements )
10
- 1 . [ Installing and uninstalling ] ( #installing-mbed-cli )
11
- 1 . [ Working context and command help ] ( #working-context )
9
+ 1 . [ Using mbed CLI ] ( #using-mbed-cli )
10
+ 1 . [ Installation ] ( #installation )
11
+ 1 . [ Before you begin ] ( #before-you-begin-understanding-the- working-context-and-program-root )
12
12
1 . [ Creating and importing programs] ( #creating-and-importing-programs )
13
- 1 . [ Creating a new program] ( #creating-a-new-program )
14
- 2. [Importing an existing program](#importing-an-existing-program)
15
13
1 . [ Adding and removing libraries] ( #adding-and-removing-libraries )
16
- 1. [Adding a library](#adding-a-library)
17
- 2. [Removing a library](#removing-a-library)
18
- 1 . [ Updating programs and libraries] ( #updating-programs-and-libraries )
19
- 1. [Synchronizing library references](#synchronizing-library-references)
20
- 2. [Update scenarios](#update-scenarios)
21
- 3. [Updating to an upstream version](#updating-to-an-upstream-version)
22
- 1 . [ Publishing your changes] ( #publishing-your-changes )
23
- 1. [Checking status](#checking-status)
24
- 2. [Pushing upstream](#pushing-upstream)
25
14
1 . [ Compiling code] ( #compiling-code )
26
- 1. [Toolchain selection](#toolchain-selection)
27
- 2. [Compiling your program](#compiling-your-program)
28
- 3. [Compiling static libraries](#compiling-static-libraries)
29
- 4 . [ Compile configuration system] ( #compile-configuration-system )
30
- 5 . [ Compile-time customizations] ( #compile-time-customizations )
31
- 6 . [ Automating toolchain and target selection] ( #automating-toolchain-and-target-selection )
32
15
1 . [ Exporting to desktop IDEs] ( #exporting-to-desktop-ides )
33
16
1 . [ Testing] ( #testing )
34
- 1 . [ Finding available tests] ( #finding-available-tests )
35
- 2 . [ Change the test action] ( #change-the-test-action )
36
- 3 . [ Limiting the test scope] ( #limiting-the-test-scope )
37
- 4 . [ Test directory structure] ( #test-directory-structure )
17
+ 1 . [ Publishing your changes] ( #publishing-your-changes )
18
+ 1 . [ Updating programs and libraries] ( #updating-programs-and-libraries )
38
19
1 . [ mbed CLI configuration] ( #mbed-cli-configuration )
39
20
40
21
## Using mbed CLI
@@ -178,15 +159,27 @@ You can create plain (empty) programs, without either mbed OS 5 or mbed OS 2, by
178
159
Use ` mbed import ` to clone an existing program and all its dependencies to your machine:
179
160
180
161
```
181
- $ mbed import https://github.com/ARMmbed/mbed-blinky/
182
- $ cd mbed-blinky
162
+ $ mbed import https://github.com/ARMmbed/mbed-os-example- blinky
163
+ $ cd mbed-os-example- blinky
183
164
```
184
165
185
166
mbed CLI also supports programs based on mbed OS 2, which are automatically detected and do not require additional options:
186
167
187
168
```
188
- $ mbed import https://developer.mbed.org/teams/mbed/code/mbed_blinky/
189
- $ cd mbed_blinky
169
+ $ mbed import https://developer.mbed.org/teams/mbed-os-examples/code/mbed-os-example-blinky/
170
+ $ cd mbed-os-example-blinky
171
+ ```
172
+
173
+ You can use the "import" command without specicying a full URL; a default prefix (https://github.com/ARMmbed ) is added to the URL. For example, this command:
174
+
175
+ ```
176
+ $ mbed import mbed-os-example-blinky
177
+ ```
178
+
179
+ is equivalent to this command:
180
+
181
+ ```
182
+ $ mbed import https://github.com/ARMmbed/mbed-os-example-blinky
190
183
```
191
184
192
185
### Importing from a Git or GitHub clone
0 commit comments