Skip to content

Commit 6316021

Browse files
committed
Add sub-section in the documentation regarding offline mode
1 parent dd00221 commit 6316021

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -874,6 +874,11 @@ For safety reasons, Mbed CLI uses the `mbed-cache` subfolder to a user specified
874874

875875
**Security notice**: If you use cache location outside your user home/profile directory, then other system users might be able to access the repository cache and therefore the data of the cached repositories.
876876

877+
### Offline mode
878+
Through the caching feature in Mbed CLI, you can enable offline mode, which will use the already cached repositories on your system. You can enable offline mode by adding `--offline` switch to `mbed import`, `mbed add`, `mbed update` and `mbed new`.
879+
880+
In offline mode, Mbed CLI will look up for locally cached repositories and use them without fetching new content from their remote repositories. This is particularly useful if for example you are in a plane and you'd like to create another Mbed OS project (assuming you've imported or crated one before), but you don't have access to Internet. By using the command `mbed new <project_name> --offline`, you will be able to create the project with Mbed OS included.
881+
877882
## Mbed CLI configuration
878883

879884
You can streamline many options in Mbed CLI with global and local configuration.

0 commit comments

Comments
 (0)