Skip to content

Commit e39243c

Browse files
Josverldpgeorge
authored andcommitted
docs/reference/mpremote: Document the 'fs tree' command.
Signed-off-by: Jos Verlinde <[email protected]>
1 parent d945316 commit e39243c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/reference/mpremote.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,7 @@ The full list of supported commands are:
234234
- ``rmdir <dirs...>`` to remove directories on the device
235235
- ``touch <file..>`` to create the files (if they don't already exist)
236236
- ``sha256sum <file..>`` to calculate the SHA256 sum of files
237+
- ``tree [-vsh] <dirs...>`` to print a tree of the given directories
237238

238239
The ``cp`` command uses a convention where a leading ``:`` represents a remote
239240
path. Without a leading ``:`` means a local path. This is based on the
@@ -264,6 +265,13 @@ The full list of supported commands are:
264265
There is no supported way to undelete files removed by ``mpremote rm -r :``.
265266
Please use with caution.
266267

268+
The ``tree`` command will print a tree of the given directories.
269+
Using the ``--size/-s`` option will print the size of each file, or use
270+
``--human/-h`` to use a more human readable format.
271+
Note: Directory size is only printed when a non-zero size is reported by the device's filesystem.
272+
The ``-v`` option can be used to include the name of the serial device in
273+
the output.
274+
267275
All other commands implicitly assume the path is a remote path, but the ``:``
268276
can be optionally used for clarity.
269277

0 commit comments

Comments
 (0)