diff options
| author | Jos Verlinde <Jos_Verlinde@hotmail.com> | 2025-05-09 20:30:10 +0200 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2025-05-18 00:20:46 +1000 |
| commit | e39243c3820c193b97f34ff033c9a598e40277a7 (patch) | |
| tree | 96bf73b2dab9d2585d53cb23ea8eb5dc3e37afd6 /docs/reference | |
| parent | d9453164320e8c30b665c5252bbf8a59479ae848 (diff) | |
| download | micropython-e39243c3820c193b97f34ff033c9a598e40277a7.tar.gz micropython-e39243c3820c193b97f34ff033c9a598e40277a7.zip | |
docs/reference/mpremote: Document the 'fs tree' command.
Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/mpremote.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/reference/mpremote.rst b/docs/reference/mpremote.rst index 32ca5c246a..bee008c637 100644 --- a/docs/reference/mpremote.rst +++ b/docs/reference/mpremote.rst @@ -234,6 +234,7 @@ The full list of supported commands are: - ``rmdir <dirs...>`` to remove directories on the device - ``touch <file..>`` to create the files (if they don't already exist) - ``sha256sum <file..>`` to calculate the SHA256 sum of files + - ``tree [-vsh] <dirs...>`` to print a tree of the given directories The ``cp`` command uses a convention where a leading ``:`` represents a remote path. Without a leading ``:`` means a local path. This is based on the @@ -264,6 +265,13 @@ The full list of supported commands are: There is no supported way to undelete files removed by ``mpremote rm -r :``. Please use with caution. + The ``tree`` command will print a tree of the given directories. + Using the ``--size/-s`` option will print the size of each file, or use + ``--human/-h`` to use a more human readable format. + Note: Directory size is only printed when a non-zero size is reported by the device's filesystem. + The ``-v`` option can be used to include the name of the serial device in + the output. + All other commands implicitly assume the path is a remote path, but the ``:`` can be optionally used for clarity. |