mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-24 21:24:44 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add the recommendation of installing the meshtastic python package with the CLI extras packages (#1637)
Some checks failed
CI / quality (push) Has been cancelled
Details
CI / build (push) Has been cancelled
Details

Browse source 
* Add the recommendation of installing the meshtastic python package with the CLI extras packages

* quote meshtastic[cli] since some shells treat square brackets specially
This commit is contained in:
Ian McEwen 2024-12-23 12:47:45 -07:00 committed by GitHub
parent b422689ab7
commit e76ba5c958
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/software/python-cli/installation.mdx
View file

@ -96,11 +96,12 @@ values={[
``` ```
- Install meshtastic: - Install meshtastic:
```shell ```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 - Using pipx as an alternative to pip3 if `externally-managed-environment` error is encountered
```shell ```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: - If using `pipx` it may be necessary to update `$PATH` by running:
```shell ```shell
@ -147,8 +148,9 @@ values={[
``` ```
- Install meshtastic: - Install meshtastic:
```shell ```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)
</TabItem> </TabItem>
<TabItem value="windows"> <TabItem value="windows">
@ -183,8 +185,9 @@ When installing Python, make sure to select the option to "Add Python to PATH" o
``` ```
- Install meshtastic: - Install meshtastic:
```powershell ```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)
</TabItem> </TabItem>
<TabItem value="termux"> <TabItem value="termux">
@ -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 - Upgrade pip and installed meshtastic and some of its dependencies
```shell ```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 :::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. 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.