Meshtastic.Cli 2.0.7

dotnet tool install --global Meshtastic.Cli --version 2.0.7
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local Meshtastic.Cli --version 2.0.7
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Meshtastic.Cli&version=2.0.7
                    
nuke :add-package Meshtastic.Cli --version 2.0.7
                    

Meshtastic C#

GitHub release downloads Coverage Status CI CLA assistant Fiscal Contributors Vercel

Overview

A cross-platform C# / .NET 8 based command line interface for Meshtastic.

Stats

Alt

Installation & Usage

Description:
  Meshtastic.Cli

Usage:
  Meshtastic.Cli [command] [options]

Options:
  --port <port>                                                    Target serial port for meshtastic device
  --host <host>                                                    Target host ip or name for meshtastic device
  --output <Json|PrettyConsole>                                    Type of output format for the command
  -l, --log <Critical|Debug|Error|Information|None|Trace|Warning>  Logging level for command events [default: Information]
  --dest <dest>                                                    Destination node address for command
  -sd, --select-dest                                               Interactively select a destination from device's node list [default: False]
  --version                                                        Show version information
  -?, -h, --help                                                   Show help and usage information

Commands:
  list                                   List available serial ports
  monitor                                Serial monitor for the device
  live                                   Show a live dashboard for the device
  info                                   Dump info about the device
  get                                    Display one or more settings from the device
  set                                    Save one or more settings onto the device
  channel <Add|Disable|Enable|Save>      Enable, Disable, Add, Save channels on the device
  url <Get|Set> <url>                    Get or set shared channel url []
  reboot <seconds>                       Reboot the device [default: 5]
  metadata                               Get device metadata from the device
  factory-reset                          Factory reset configuration of the device
  fixed-position <lat> <lon> <altitude>  Set the device to a fixed position [default: 0]
  text <message>                         Send a text message from the device
  remove-node <nodenum>                  Remove single node by nodenum from node db of the device
  reset-nodedb                           Reset the node db of the device
  trace-route                            Trace the sequence of nodes routing to the destination
  waypoint <lat> <lon>                   Send a waypoint from the device
  file <path>                            Get or send a file from the device
  waypoint <lat> <lon>                   Send a waypoint from the device
  file <path>                            Get or send a file from the device
  update                                 Update the firmware of the serial connected device
  export                                 Export the profile of the connected device as yaml
  import                                 Import the profile export from a yaml file and set the connected device
  mqtt-proxy                             Proxy to the MQTT server referenced in the MQTT module config of the connected device
  request-telemetry                      Request a telemetry packet from a repeater by nodenum
  capture                                Capture all of the FromRadio messages for the device and store in MongoDB instance

PS C:\Users\bmeadors\Documents\GitHub\c-sharp> dotnet run --project ./Meshtastic.Cli/Meshtastic.Cli.csproj --port COM5
Required command was not provided.

Description:
  Meshtastic.Cli

Usage:
  Meshtastic.Cli [command] [options]

Options:
  --port <port>                                          Target serial port for meshtastic device
  --host <host>                                          Target host ip or name for meshtastic device
  --output <Json|PrettyConsole>                          Type of output format for the command
  -l, --log                                              Logging level for command events [default: Information]
  <Critical|Debug|Error|Information|None|Trace|Warning>
  --dest <dest>                                          Destination node address for command
  -sd, --select-dest                                     Interactively select a destination from device's node list       
                                                         [default: False]
  --version                                              Show version information
  -?, -h, --help                                         Show help and usage information

Commands:
  list                                   List available serial ports
  monitor                                Serial monitor for the device
  live                                   Show a live dashboard for the device
  info                                   Dump info about the device
  get                                    Display one or more settings from the device
  set                                    Save one or more settings onto the device
  channel <Add|Disable|Enable|Save>      Enable, Disable, Add, Save channels on the device
  url <Get|Set> <url>                    Get or set shared channel url []
  reboot <seconds>                       Reboot the device [default: 5]
  metadata                               Get device metadata from the device
  factory-reset                          Factory reset configuration of the device
  fixed-position <lat> <lon> <altitude>  Set the device to a fixed position [default: 0]
  text <message>                         Send a text message from the device
  remove-node <nodenum>                  Remove single node by nodenum from node db of the device
  reset-nodedb                           Reset the node db of the device
  trace-route                            Trace the sequence of nodes routing to the destination
  canned-messages <Get|Set> <messages>   Get or set the collection of canned messages on the device [operation: Get, ]    
  waypoint <lat> <lon>                   Send a waypoint from the device
  file <path>                            Get or send a file from the device
  update                                 Update the firmware of the serial connected device
  export                                 Export the profile of the connected device as yaml
  import                                 Import the profile export from a yaml file and set the connected device
  mqtt-proxy                             Proxy to the MQTT server referenced in the MQTT module config of the connected   
                                         device
  request-telemetry                      Request a telemetry packet from a repeater by nodenum

Example of Meshtastic.Cli info output with default console output level

image

Installation (dotnet cli / tool method)

  • Install the latest dotnet 8 sdk for your platform
  • Install the Meshtastic.Cli nuget package as a dotnet tool via dotnet tool install --global Meshtastic.Cli in your terminal of choice

Installation (standalone executable)

  • Navigate to the Releases page in this github repsitory
  • Download and extract the zip archive with the standalone executable for your platform

image

  • Execute it in the terminal of your choice (this may require security allowances or display warnings on some platforms)

Updating via dotnet cli

  • Execute dotnet tool update Meshtastic.Cli -g in your terminal of choice
Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated
2.0.7 135 12/12/2025
2.0.6 591 7/21/2025
2.0.5 230 6/14/2025
2.0.4 232 6/14/2025
2.0.3 347 6/13/2025
2.0.2 303 5/13/2025
2.0.1 275 4/16/2025
2.0.0 215 2/9/2025
1.0.48 215 10/30/2024
1.0.47 171 10/23/2024
1.0.46 184 10/11/2024
1.0.45 224 9/15/2024
1.0.44 190 9/5/2024
1.0.43 191 7/14/2024
1.0.42 206 6/21/2024
1.0.41 179 6/1/2024
1.0.40 208 5/4/2024
1.0.39 261 3/26/2024
1.0.38 316 1/11/2024
1.0.37 293 12/27/2023
1.0.36 247 12/21/2023
1.0.35 338 11/21/2023
1.0.34 244 11/19/2023
1.0.33 294 11/19/2023
1.0.32 701 8/18/2023
1.0.31 638 8/8/2023
1.0.30 745 8/7/2023
1.0.29 536 7/9/2023
1.0.28 540 6/16/2023
1.0.27 606 4/9/2023
1.0.26 616 4/9/2023
1.0.25 594 4/1/2023
1.0.24 700 4/1/2023
1.0.23 655 3/29/2023
1.0.22 809 2/11/2023
1.0.21 671 1/30/2023
1.0.20 748 1/28/2023
1.0.19 788 1/24/2023
1.0.18 667 1/20/2023
1.0.17 750 1/20/2023
1.0.16 693 1/20/2023
1.0.15 853 1/12/2023
1.0.14 741 1/9/2023
1.0.13 769 1/6/2023
1.0.12 758 1/4/2023
1.0.11 763 1/1/2023
1.0.10 729 1/1/2023
1.0.9 779 1/1/2023
1.0.8 679 12/31/2022
1.0.7 649 12/30/2022
1.0.6 732 12/28/2022
1.0.5 800 12/27/2022
1.0.4 850 12/22/2022
1.0.3 815 12/21/2022
1.0.2 677 12/21/2022
1.0.1 808 12/15/2022
1.0.0 693 12/14/2022