Skip to main content

Full Command Reference

AllMeshCore commandshas aretwo enteredcommand atsurfaces. theThe device-side serial CLI (canonical reference: docs.meshcore.io/cli_commands) uses bare get/set verbs and is used to configure repeaters and room servers over USB serial. The host tool meshcore-cli (invoked as meshcore-cli/meshcli) promptconnects after establishingto a connection.companion radio over BLE, TCP, or Serial; commands can be passed on the command line or entered in interactive chat mode. The tables below note which surface each command belongs to.

Device Information & Status

CommandPurpose
infoinfos (alias i)Devicemeshcore-cli: details,print node info (public key, TX power, radio params, name, location). For firmware version,version batteryuse levelver; for battery/telemetry use self_telemetry / req_status.
statusstats-radio / stats-core / stats-packetsRadioSerial stateCLI: radio stats (noise floor, RSSI/SNR, airtime), core stats (battery, uptime, queue), and statisticspacket counters. There is no bare status command.
nodescontacts / list (alias lc)Listmeshcore-cli: alllist discoveredknown contacts (nodes you have received adverts from). Use node_discover <filter> (nd) to discover nodes inby rangetype, or neighbors on a repeater's serial CLI.
configget get<param>Read alla currentsetting settings(e.g. get radio, get name, get tx). Run get help for the parameter list. There is no config get command.

Configuration

CommandPurpose
config set name "MyNode"<name>Set the node name
(no config set tx_power 20Set TX power in dBm
config resetRestore factory defaultsprefix). set nametx NAME<dbm>Set repeater/roomLoRa servertransmit namepower in dBm (valid 1–22 for SX1262). Choose a value that keeps EIRP within your region's limit — 36 dBm EIRP in the US per FCC Part 15.247. Setting too high may violate local law. eraseRestore factory defaults. Serial-only and destructive. There is no config reset command. set lat LAT<degrees>Set latitude coordinatein degrees. set lon LON<degrees>Set longitude coordinatein degrees. password NEWPW<new_password>Set the admin password. Any node presenting this password is added to the admin ACL.

Messaging

CommandPurpose
msg <name> <message> (alias m)meshcore-cli: send a direct message to a contact by name.
public <nodemessage> or chan <nb> <message>Directmeshcore-cli: messagesend to athe specificpublic nodechannel (0) or to channel number <nb>. Channel messages flood to subscribers. There is no broadcast command. broadcastmsgs_subscribe <message>(alias ms)Messagemeshcore-cli: display messages as they arrive. Use recv (r) / wait_msg (wm) to allread nodesthem, (floods)or chat mode. There is no listenMonitor all incoming messages in real timecommand.

Network & Routing

CommandPurpose
advertTrigger immediate advertisement broadcast (flood). Use advert.zerohop for a zero-hop advert.
set flood.advert.interval 6<hours>Set floodFlood advert interval in hours (valid 3–168; default 12).
set path.hash.mode 1<0|1|2>PathAdvert path hash mode:size (0=1-byte, 1=2-byte, 2=3-bytebyte; default 0). Affects only this node's own adverts, not forwarding or routing-table behaviour; requires firmware ≥ 1.14.
region put us<name> [parent]AddCreate USa region. Names are user-defined (e.g. region scopeput #USA) — there are no predefined US/state scopes. Flooding must be enabled separately.
region put us-co<child> us<parent>AddCreate Coloradoa sub-nested region under USa parent (e.g. region put #Colorado #USA). Names are user-defined, not ISO/region codes.
region saveSave region configurationconfiguration.

Repeater & Room Server

CommandPurpose
set agc.reset.interval 4<seconds>Reset AGC everyreset Ninterval minutesin seconds (fixrounded down to a multiple of 4; 0 disables). Helps with receiver deafness)desensitization.
set repeat on<on|off>EnableEnable/disable packet repeatrepeating (on a repeater or room server firmware)(default on).

Firmware & Maintenance

CommandPurpose
rebootRestart the devicedevice.
flashstart otaUpdateInitiate an over-the-air firmware update (nRF52). Otherwise flash via the MeshCore web flasher or esptool/UF2. There is no flash command.