summaryrefslogtreecommitdiff
path: root/docs/reference/mpremote.rst
diff options
context:
space:
mode:
authorJim Mussared <jim.mussared@gmail.com>2022-09-29 00:45:34 +1000
committerJim Mussared <jim.mussared@gmail.com>2022-10-01 22:44:24 +1000
commit12ca918eb2ac062f6e6df0772e528eef9d050cb7 (patch)
tree49be20380cce7d51d63a9dbf03b8628c622f1cb3 /docs/reference/mpremote.rst
parent68d094358ec71aa8cdec97e9e6fc3c6d46dedfbf (diff)
tools/mpremote: Add `mpremote mip install` to install packages.
This supports the same package sources as the new `mip` tool. - micropython-lib (by name) - http(s) & github packages with json description - directly downloading a .py/.mpy file The version is specified with an optional `@version` on the end of the package name. The target dir, index, and mpy/no-mpy can be set through command line args. This work was funded through GitHub Sponsors. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
Diffstat (limited to 'docs/reference/mpremote.rst')
-rw-r--r--docs/reference/mpremote.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/reference/mpremote.rst b/docs/reference/mpremote.rst
index e3902f8e5..bb0686237 100644
--- a/docs/reference/mpremote.rst
+++ b/docs/reference/mpremote.rst
@@ -146,6 +146,14 @@ The full list of supported commands are:
variable ``$EDITOR``). If the editor exits successfully, the updated file will
be copied back to the device.
+- install packages from :term:`micropython-lib` (or GitHub) using the ``mip`` tool:
+
+ .. code-block:: bash
+
+ $ mpremote mip install <packages...>
+
+ See :ref:`packages` for more information.
+
- mount the local directory on the remote device:
.. code-block:: bash
@@ -269,3 +277,9 @@ Examples
mpremote cp -r dir/ :
mpremote cp a.py b.py : + repl
+
+ mpremote mip install aioble
+
+ mpremote mip install github:org/repo@branch
+
+ mpremote mip install --target /flash/third-party functools