Skip to content

Commit e5eeaa7

Browse files
committed
docs/reference/mpremote: Update docs to mention new features.
Signed-off-by: Damien George <[email protected]>
1 parent a25b6b9 commit e5eeaa7

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/reference/mpremote.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -227,11 +227,12 @@ The full list of supported commands are:
227227
- ``cat <file..>`` to show the contents of a file or files on the device
228228
- ``ls`` to list the current directory
229229
- ``ls <dirs...>`` to list the given directories
230-
- ``cp [-r] <src...> <dest>`` to copy files
230+
- ``cp [-rf] <src...> <dest>`` to copy files
231231
- ``rm <src...>`` to remove files on the device
232232
- ``mkdir <dirs...>`` to create directories on the device
233233
- ``rmdir <dirs...>`` to remove directories on the device
234234
- ``touch <file..>`` to create the files (if they don't already exist)
235+
- ``sha256sum <file..>`` to calculate the SHA256 sum of files
235236

236237
The ``cp`` command uses a convention where a leading ``:`` represents a remote
237238
path. Without a leading ``:`` means a local path. This is based on the
@@ -256,6 +257,11 @@ The full list of supported commands are:
256257
This will copy the file to the device then enter the REPL. The ``+`` prevents
257258
``"repl"`` being interpreted as a path.
258259

260+
The ``cp`` command supports the ``-r`` option to make a recursive copy. By
261+
default ``cp`` will skip copying files to the remote device if the SHA256 hash
262+
of the source and destination file matches. To force a copy regardless of the
263+
hash use the ``-f`` option.
264+
259265
**Note:** For convenience, all of the filesystem sub-commands are also
260266
:ref:`aliased as regular commands <mpremote_shortcuts>`, i.e. you can write
261267
``mpremote cp ...`` instead of ``mpremote fs cp ...``.

0 commit comments

Comments
 (0)