https://github.com/lmatte7/meshtastic-go
CLI for Meshtastic Devices
https://github.com/lmatte7/meshtastic-go
meshtastic
Last synced: 5 months ago
JSON representation
CLI for Meshtastic Devices
- Host: GitHub
- URL: https://github.com/lmatte7/meshtastic-go
- Owner: lmatte7
- License: mit
- Created: 2021-04-13T18:02:45.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-11-19T18:46:16.000Z (7 months ago)
- Last Synced: 2025-11-19T20:23:12.703Z (7 months ago)
- Topics: meshtastic
- Language: Go
- Homepage: https://meshtastic.org/
- Size: 173 KB
- Stars: 57
- Watchers: 2
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-meshtastic - meshtastic-go by lmatte7 - A meshtastic CLI written in GoLang (Local Software / Regional)
README
# Meshtastic Go
Meshtastic Go is a CLI for meshtastic devices built in Go. This tool provides an easy interface for meshtastic devices that can be used on Windows, Linux or Mac. The only requirements for this tool are the ESP32 [drivers](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers) if not already installed. Executables for different operating systems can be downloaded on the [releases](https://github.com/lmatte7/meshtastic-go/releases) page or can be built as needed with the standard Go tooling.
## Command syntax
A full list of commands can be viewed by running `--help`. Each command also has its own `--help` flag that provides more information on its subcommands and flags.
Every command requires the `--port` flag to be set to the port the radio is attached to. This can be set to a serial port (like `/dev/cu.SLAB_USBtoUART`) or an IP address depending on which communication method should be used to communicate with the radio. The CLI will automatically determine if TCP or serial communications should be used depending on what value is provided to `--port`.
```
NAME:
meshtastic-go - Interface with meshtastic radios
USAGE:
meshtastic-go [global options] command [command options] [arguments...]
VERSION:
v0.2
AUTHOR:
Lucas Matte
COMMANDS:
info Show radio information
message Interact with radio messaging functionality
channel Update channel information
prefs Update user preferences
location Set location
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--port value, -p value specify a port
--help, -h show help (default: false)
--version, -v print the version (default: false)
```
## Subcommands
### `info`
The `info` command displays information about the radio. By default all informaiton is shown, but information can be restricted by using subcommands. It is also possible to chain together subcommands, for example `meshtastic-go info rc` to only display radio and channel information
```
NAME:
meshtastic-go info - Show radio information
USAGE:
meshtastic-go info command [command options] [arguments...]
DESCRIPTION:
Show node, preference and channel information for radio
COMMANDS:
radio, r Show radio information
channels, c Show all channel information
nodes, n Show all nodes on the mesh
position, p Show position settings
metrics, m Display node metrics
help, h Shows a list of commands or help for one command
OPTIONS:
--json Output data in JSON (default: false)
--help, -h show help (default: false)
```
### `message`
The `message` subcommand provides the ability to send messages and listen for new messages on the mesh. The `recv` subcommand won't show any previously received messages from the radio, but will wait and display new messages as they are received.
```
NAME:
meshtastic-go message - Interact with radio messaging functionality
USAGE:
meshtastic-go message command [command options] [arguments...]
DESCRIPTION:
Send messages to other radios or wait for new messages
COMMANDS:
send Send a text message
recv Wait for new messages
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show help (default: false)
```
### `config`
The `config` subcommand allows for different User Preferences (as defined in the [protobufs](https://github.com/lmatte7/goMesh/blob/6199a9555f0777b6f21456a1f5d1390bd324ba57/github.com/meshtastic/gomeshproto/radioconfig.pb.go#L422)) the be set and changed.
```
NAME:
meshtastic-go config - Update radio config
USAGE:
meshtastic-go config command [command options] [arguments...]
DESCRIPTION:
Update radio config
COMMANDS:
set Set a user preference
owner Set the radio owner
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show help (default: false)
```
### `location`
The `location` subcommand allows for the location to be manually set on the radio.
```
meshtastic-go location --help
NAME:
meshtastic-go location - Set location
USAGE:
meshtastic-go location command [command options] [arguments...]
DESCRIPTION:
Manually set the GPS coordinates for the radio
COMMANDS:
set Set a location
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show help (default: false)
```
### `channel`
```
NAME:
meshtastic-go channel - Update channel information
USAGE:
meshtastic-go channel command [command options] [arguments...]
DESCRIPTION:
Add, delete and update channel settings
COMMANDS:
url Change settings with a url
add Adds a channel
delete Deletes a channel
set Set a channel parameter
options Show channel options
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show help (default: false)
```
### `reset`
```
NAME:
meshtastic-go reset - Factory reset the radio
USAGE:
reset - Factory reset the radio
DESCRIPTION:
Reset the radio to default settings
OPTIONS:
--help, -h show help (default: false)
```
## Examples
Add a channel
```
meshtastic-go channel add --port=/dev/cu.SLAB_USBtoUART -i 2 -name test2
```
Update the Region
```
meshtastic-go config set -p /dev/cu.SLAB_USBtoUART -k Region -v 1
```
Set the radio location
```
meshtastic-go -p "192.168.0.42" location set --lat 310481775 --long -815817755 --alt 20
```
Send a message to all radios on the mesh
```
meshtastic-go --port "192.168.42.1" message send -m "test"
```
## Run smoke tests
To run the smoke tests, plug in a device, and run the following:
```
go build
cd smoke
go build
./smoke
```
## Feedback
This tool is still under development. Any issues or feedback can be submitted to the [issues](https://github.com/lmatte7/meshtastic-go/issues) page.