diff options
| author | Jim Mussared <jim.mussared@gmail.com> | 2022-08-18 12:36:42 +1000 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2022-08-18 22:29:13 +1000 |
| commit | 59e3348c101efee4071dd2224d01ccce6075b692 (patch) | |
| tree | 20cc4128a949bbc7463c608ca9e61bb9179199b9 /docs/reference | |
| parent | 263737ecfea6ec1049ef3aff37913866ebd463e5 (diff) | |
| download | micropython-59e3348c101efee4071dd2224d01ccce6075b692.tar.gz micropython-59e3348c101efee4071dd2224d01ccce6075b692.zip | |
tools/mpremote: Add "edit" command.
This allows a remote file to be edited locally by copying it over, running
the local editor, then copying it back.
Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/mpremote.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/reference/mpremote.rst b/docs/reference/mpremote.rst index 3927c9badf..eb0233bdda 100644 --- a/docs/reference/mpremote.rst +++ b/docs/reference/mpremote.rst @@ -133,6 +133,17 @@ 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) +- edit a file on the device: + + .. code-block:: bash + + $ mpremote edit <files...> + + The ``edit`` command will copy each file from the device to a local temporary + directory and then launch your editor for each file (defined by the environment + variable ``$EDITOR``). If the editor exits successfully, the updated file will + be copied back to the device. + - mount the local directory on the remote device: .. code-block:: bash |