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: README.md
+6-7Lines changed: 6 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -853,28 +853,27 @@ Use these with caution because your uncommitted changes and unpublished librarie
853
853
854
854
## Repository caching
855
855
856
-
To minimize traffic and reduce import times, by default Mbed CLI caches repositories by storing their indexes under the Mbed CLI user config folder - typically `~/.mbed/mbed-cache/` on UNIX systems, or `%userprofile%/.mbed/mbed-cache/` on Windows systems. Compared to a fully checked out repository, indexes are significantly smaller in size and number of files, and contain the whole revision history of that repository. This allows Mbed CLI to quickly create copies of previously downloaded repository indexes and pull/fetch only the latest changes from the remote repositories, therefore dramatically reducing network traffic and download times, especially for big repositories like`mbed-os`.
856
+
To minimize traffic and reduce import times, by default Mbed CLI caches repositories by storing their indexes under the Mbed CLI user config folder - typically `~/.mbed/mbed-cache/` on UNIX systems, or `%userprofile%/.mbed/mbed-cache/` on Windows systems. Compared to a fully checked out repository, indexes are significantly smaller in size and number of files and contain the whole revision history of that repository. This allows Mbed CLI to quickly create copies of previously downloaded repository indexes and pull/fetch only the latest changes from the remote repositories, therefore dramatically reducing network traffic and download times, especially for big repositories such as`mbed-os`.
857
857
858
-
You can manage the Mbed CLI caching behavior with the following sub-commands:
858
+
You can manage the Mbed CLI caching behavior with the following subcommands:
859
859
860
860
```
861
861
mbed cache [on|off|dir <path>|ls|purge|-h|--help]
862
862
```
863
863
864
-
*`on` - Turn repository caching on. This will either use the user specified cache directory or the default one. See "dir".
864
+
*`on` - Turn repository caching on. This uses either the user specified cache directory or the default one. See "dir".
865
865
*`off` - Turn repository caching off. Note that this doesn't purge cached repositories. See "purge".
866
-
*`dir` - Set cache directory. Set to "default" to let mbed CLI determine the cache directory location. Typically this is `~/.mbed/mbed-cache/` on UNIX systems, or `%%userprofile%%/.mbed/mbed-cache/` on Windows systems.
866
+
*`dir` - Set cache directory. Set to "default" to let Mbed CLI determine the cache directory location. Typically, this is `~/.mbed/mbed-cache/` on UNIX systems, or `%%userprofile%%/.mbed/mbed-cache/` on Windows systems.
867
867
*`ls` - List cached repositories and their size.
868
868
*`purge` - Purge cached repositories. Note that this doesn't turn caching off.
869
869
*`-h` or `--help` - Print cache command options.
870
870
871
-
If no sub-command is specified to `mbed cache`, mbed CLI prints the current cache setting (ENABLED or DISABLED) and the path to the local cache directory.
871
+
If no subcommand is specified to `mbed cache`, Mbed CLI prints the current cache setting (ENABLED or DISABLED) and the path to the local cache directory.
872
872
873
-
For safety reasons, Mbed CLI uses `mbed-cache` subfolder to a user specified location. This ensure that no user files will deleted during `purge` even if the user has specified root/system folder as a cache location (e.g.`mbed cache dir /` or `mbed cache dir C:\`).
873
+
For safety reasons, Mbed CLI uses the `mbed-cache` subfolder to a user specified location. This ensures that no user files are deleted during `purge` even if the user has specified root/system folder as a cache location (for example,`mbed cache dir /` or `mbed cache dir C:\`).
874
874
875
875
**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.
876
876
877
-
878
877
## Mbed CLI configuration
879
878
880
879
You can streamline many options in Mbed CLI with global and local configuration.
0 commit comments