From e76ba5c95855b40e8a91fbf8a244022d17c9b410 Mon Sep 17 00:00:00 2001 From: Ian McEwen Date: Mon, 23 Dec 2024 12:47:45 -0700 Subject: [PATCH] Add the recommendation of installing the meshtastic python package with the CLI extras packages (#1637) * Add the recommendation of installing the meshtastic python package with the CLI extras packages * quote meshtastic[cli] since some shells treat square brackets specially --- docs/software/python-cli/installation.mdx | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/software/python-cli/installation.mdx b/docs/software/python-cli/installation.mdx index f073ec1e..6f4b2d79 100644 --- a/docs/software/python-cli/installation.mdx +++ b/docs/software/python-cli/installation.mdx @@ -96,11 +96,12 @@ values={[ ``` - Install meshtastic: ```shell - pip3 install --upgrade meshtastic + pip3 install --upgrade "meshtastic[cli]" ``` + (the `[cli]` suffix installs a few optional dependencies that match older versions of the CLI) - Using pipx as an alternative to pip3 if `externally-managed-environment` error is encountered ```shell - sudo apt install pipx && pipx install meshtastic + sudo apt install pipx && pipx install "meshtastic[cli]" ``` - If using `pipx` it may be necessary to update `$PATH` by running: ```shell @@ -147,8 +148,9 @@ values={[ ``` - Install meshtastic: ```shell - sudo pip3 install --upgrade meshtastic + sudo pip3 install --upgrade "meshtastic[cli]" ``` + (the `[cli]` suffix installs a few optional dependencies that match older versions of the CLI) @@ -183,8 +185,9 @@ When installing Python, make sure to select the option to "Add Python to PATH" o ``` - Install meshtastic: ```powershell - pip3 install --upgrade meshtastic + pip3 install --upgrade "meshtastic[cli]" ``` + (the `[cli]` suffix installs a few optional dependencies that match older versions of the CLI) @@ -206,8 +209,9 @@ When installing Python, make sure to select the option to "Add Python to PATH" o ``` - Upgrade pip and installed meshtastic and some of its dependencies ```shell - pip install --upgrade pip pygatt pytap2 wheel meshtastic + pip install --upgrade pip pygatt pytap2 wheel "meshtastic[cli]" ``` + (the `[cli]` suffix installs a few optional dependencies that match older versions of the CLI) :::note Be aware that the Meshtastic CLI is not able to control the nodes over USB through termux, but you can control devices over Wifi using the `--host x.x.x.x` option with the device IP address (ESP32 or Pico W only). Wifi connection is currently under development and may not be working properly just yet. If you would like to provide feedback or test this feature, please join our [Discord server](https://discord.gg/ktMAKGBnBs) for more information.