diff options
| author | Damien George <damien@micropython.org> | 2024-09-27 13:10:32 +1000 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2024-10-09 16:39:06 +1100 |
| commit | e5eeaa7df894b5062c189f5d8da44c67550cf43a (patch) | |
| tree | a61368615d2ccd0c5b05ee8ef2fc4c852f0dd79d /docs/reference | |
| parent | a25b6b9c65a587f534f802f821b30972de29e2af (diff) | |
docs/reference/mpremote: Update docs to mention new features.
Signed-off-by: Damien George <damien@micropython.org>
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/mpremote.rst | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/reference/mpremote.rst b/docs/reference/mpremote.rst index 3ed8a3dbc..4d86f0080 100644 --- a/docs/reference/mpremote.rst +++ b/docs/reference/mpremote.rst @@ -227,11 +227,12 @@ The full list of supported commands are: - ``cat <file..>`` to show the contents of a file or files on the device - ``ls`` to list the current directory - ``ls <dirs...>`` to list the given directories - - ``cp [-r] <src...> <dest>`` to copy files + - ``cp [-rf] <src...> <dest>`` to copy files - ``rm <src...>`` to remove files on the device - ``mkdir <dirs...>`` to create directories on the device - ``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 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 @@ -256,6 +257,11 @@ The full list of supported commands are: This will copy the file to the device then enter the REPL. The ``+`` prevents ``"repl"`` being interpreted as a path. + The ``cp`` command supports the ``-r`` option to make a recursive copy. By + default ``cp`` will skip copying files to the remote device if the SHA256 hash + of the source and destination file matches. To force a copy regardless of the + hash use the ``-f`` option. + **Note:** For convenience, all of the filesystem sub-commands are also :ref:`aliased as regular commands <mpremote_shortcuts>`, i.e. you can write ``mpremote cp ...`` instead of ``mpremote fs cp ...``. |