This document provides an overview of CLI commands that can be sent to MeshCore Repeaters, Room Servers and Sensors.
Usage:
reboot
Note: No reply is sent.
Usage:
poweroff, orshutdown
Note: No reply is sent.
Usage:
clkreboot
Note: No reply is sent.
Usage:
clock sync
Usage:
clock
Usage:
time <epoch_seconds>
Parameters:
epoch_seconds: Unix epoch time
Usage:
advert
Usage:
advert.zerohop
Usage:
start ota
Usage:
erase
Serial Only: Yes
Warning: This is destructive!
Usage:
neighbors
Note: The output of this command is limited to the 8 most recent adverts.
Note: Each line is encoded as {pubkey-prefix}:{timestamp}:{snr*4}
Usage:
neighbor.remove <pubkey_prefix>
Parameters:
pubkey_prefix: The public key of the node to remove from the neighbors list. This can be a short prefix or the full key. All neighbors matching the provided prefix will be removed.
Note: You can remove all neighbors by sending a space character as the prefix. The space indicates an empty prefix, which matches all existing neighbors.
Usage:
discover.neighbors
Usage: clear stats
Usage:
stats-core
Serial Only: Yes
Usage: stats-radio
Serial Only: Yes
Usage: stats-packets
Serial Only: Yes
Usage: log start
Usage: log stop
Usage: log erase
Usage: log
Serial Only: Yes
Usage: ver
Usage: board
Usage:
get radioset radio <freq>,<bw>,<sf>,<cr>
Parameters:
freq: Frequency in MHzbw: Bandwidth in kHzsf: Spreading factor (5-12)cr: Coding rate (5-8)
Set by build flag: LORA_FREQ, LORA_BW, LORA_SF, LORA_CR
Default: 869.525,250,11,5
Note: Requires reboot to apply
Usage:
get txset tx <dbm>
Parameters:
dbm: Power level in dBm (1-22)
Set by build flag: LORA_TX_POWER
Default: Varies by board
Notes: This setting only controls the power level of the LoRa chip. Some nodes have an additional power amplifier stage which increases the total output. Refer to the node's manual for the correct setting to use. Setting a value too high may violate the laws in your country.
Usage:
tempradio <freq>,<bw>,<sf>,<cr>,<timeout_mins>
Parameters:
freq: Frequency in MHz (300-2500)bw: Bandwidth in kHz (7.8-500)sf: Spreading factor (5-12)cr: Coding rate (5-8)timeout_mins: Duration in minutes (must be > 0)
Note: This is not saved to preferences and will clear on reboot
Usage:
get freqset freq <frequency>
Parameters:
frequency: Frequency in MHz
Default: 869.525
Note: Requires reboot to apply
Serial Only: set freq <frequency>
Usage:
get radio.rxgainset radio.rxgain <state>
Parameters:
state:on|off
Default: on
Temporary Note: If you upgraded from an older version to 1.14.1 without erasing flash, this setting is off because of #2118
Usage:
get nameset name <name>
Parameters:
name: Node name
Set by build flag: ADVERT_NAME
Default: Varies by board
Note: Max length varies. If a location is set, the max length is 24 bytes; 32 otherwise. Emoji and unicode characters may take more than one byte.
Usage:
get latset lat <degrees>
Set by build flag: ADVERT_LAT
Default: 0
Parameters:
degrees: Latitude in degrees
Usage:
get lonset lon <degrees>
Set by build flag: ADVERT_LON
Default: 0
Parameters:
degrees: Longitude in degrees
Usage:
get prv.keyset prv.key <private_key>
Parameters:
private_key: Private key in hex format (64 hex characters)
Serial Only:
get prv.key: Yesset prv.key: No
Note: Requires reboot to take effect after setting
Usage:
password <new_password>
Parameters:
new_password: New admin password
Set by build flag: ADMIN_PASSWORD
Default: password
Note: Command reply echoes the updated password for confirmation.
Note: Any node using this password will be added to the admin ACL list.
Usage:
get guest.passwordset guest.password <password>
Parameters:
password: Guest password
Set by build flag: ROOM_PASSWORD (Room Server only)
Default: <blank>
Usage:
get owner.infoset owner.info <text>
Parameters:
text: Owner information text
Default: <blank>
Note: | characters are translated to newlines
Note: Requires firmware 1.12+
Usage:
get adc.multiplierset adc.multiplier <value>
Parameters:
value: ADC multiplier (0.0-10.0)
Default: 0.0 (value defined by board)
Note: Returns "Error: unsupported by this board" if hardware doesn't support it
Usage: get public.key
Usage: ver
Usage: get role
Usage:
powersavingpowersaving onpowersaving off
Parameters:
on: enable power savingoff: disable power saving
Default: off
Note: When enabled, device enters sleep mode between radio transmissions
Usage:
get repeatset repeat <state>
Parameters:
state:on|off
Default: on
Usage:
get path.hash.modeset path.hash.mode <value>
Parameters:
value: Path hash size (0-2)0: 1 Byte hash size (256 unique ids)[64 max flood]1: 2 Byte hash size (65,536 unique ids)[32 max flood]2: 3 Byte hash size (16,777,216 unique ids)[21 max flood]3: DO NOT USE (Reserved)
Default: 0
Note: the 'path.hash.mode' sets the low-level ID/hash encoding size used when the repeater adverts. This setting has no impact on what packet ID/hash size this repeater forwards, all sizes should be forwarded on firmware >= 1.14. This feature was added in firmware 1.14
Temporary Note: adverts with ID/hash sizes of 2 or 3 bytes may have limited flood propagation in your network while this feature is new as v1.13.0 firmware and older will drop packets with multibyte path ID/hashes as only 1-byte hashes are supported. Consider your install base of firmware >=1.14 has reached a criticality for effective network flooding before implementing higher ID/hash sizes.
Usage:
get loop.detectset loop.detect <state>
Parameters:
state:off: no loop detection is performedminimal: packets are dropped if repeater's ID/hash appears 4 or more times (1-byte), 2 or more (2-byte), 1 or more (3-byte)moderate: packets are dropped if repeater's ID/hash appears 2 or more times (1-byte), 1 or more (2-byte), 1 or more (3-byte)strict: packets are dropped if repeater's ID/hash appears 1 or more times (1-byte), 1 or more (2-byte), 1 or more (3-byte)
Default: off
Note: When it is enabled, repeaters will now reject flood packets which look like they are in a loop. This has been happening recently in some meshes when there is just a single 'bad' repeater firmware out there (probably some forked or custom firmware). If the payload is messed with, then forwarded, the same packet ends up causing a packet storm, repeated up to the max 64 hops. This feature was added in firmware 1.14
Example: If preference is loop.detect minimal, and a 1-byte path size packet is received, the repeater will see if its own ID/hash is already in the path. If it's already encoded 4 times, it will reject the packet. If the packet uses 2-byte path size, and repeater's own ID/hash is already encoded 2 times, it rejects. If the packet uses 3-byte path size, and the repeater's own ID/hash is already encoded 1 time, it rejects.
Usage:
get txdelayset txdelay <value>
Parameters:
value: Transmit delay factor (0-2)
Default: 0.5
Note: When multiple nearby repeaters all hear the same flood packet, each waits a random amount of time before retransmitting to avoid simultaneous collisions. This factor scales the size of that random window. Higher values reduce collision risk at the cost of added latency. 0 disables the window entirely.
Usage:
get direct.txdelayset direct.txdelay <value>
Parameters:
value: Direct transmit delay factor (0-2)
Default: 0.2
Note: Same collision-avoidance random window as txdelay, but applied to direct (non-flood, routed) traffic. The default is lower because direct packets are addressed to a specific next hop, so far fewer nodes compete to retransmit them.
Usage:
get rxdelayset rxdelay <value>
Parameters:
value: Receive delay base (0-20)
Default: 0.0
Note: When enabled, repeaters that received a flood packet with a weak signal are held in a delay queue before processing, while those that received it with a strong signal process it immediately. This gives strong-signal paths forwarding priority. By the time weak-signal nodes process their copy, the packet may have already propagated and will be suppressed as a duplicate, reducing redundant retransmissions.
Usage:
get dutycycleset dutycycle <value>
Parameters:
value: Duty cycle percentage (1-100)
Default: 50% (equivalent to airtime factor 1.0)
Examples:
set dutycycle 100— no duty cycle limitset dutycycle 50— 50% duty cycle (default)set dutycycle 10— 10% duty cycleset dutycycle 1— 1% duty cycle (strictest EU requirement)
Note: Added in firmware v1.15.0
Deprecated as of firmware v1.15.0. Use
get/set dutycycleinstead.
Usage:
get afset af <value>
Parameters:
value: Airtime factor (0-9). After each transmission, the repeater enforces a silent period of approximately the on-air transmission time multiplied by the value. This results in a long-term duty cycle of roughly 1 divided by (1 plus the value). For example:af = 1→ ~50% dutyaf = 2→ ~33% dutyaf = 3→ ~25% dutyaf = 9→ ~10% duty You are responsible for choosing a value that is appropriate for your jurisdiction and channel plan (for example EU 868 Mhz 10% duty cycle regulation).
Default: 1.0
Usage:
get int.threshset int.thresh <value>
Parameters:
value: Interference threshold value
Default: 0.0
Usage:
get agc.reset.intervalset agc.reset.interval <value>
Parameters:
value: Interval in seconds rounded down to a multiple of 4 (17 becomes 16). 0 to disable.
Default: 0.0
Usage:
get multi.acksset multi.acks <state>
Parameters:
state:0(disable) or1(enable)
Default: 0
Usage:
get flood.advert.intervalset flood.advert.interval <hours>
Parameters:
hours: Interval in hours (3-168)
Default: 12 (Repeater) - 0 (Sensor)
Usage:
get advert.intervalset advert.interval <minutes>
Parameters:
minutes: Interval in minutes rounded down to the nearest multiple of 2 (61 becomes 60) (60-240)
Default: 0
Usage:
get flood.maxset flood.max <value>
Parameters:
value: Maximum flood hop count (0-64)
Default: 64
Usage:
get flood.max.unscopedset flood.max.unscoped <value>
Parameters:
value: Maximum flood hop count (0-64) for a packet without a scope (no region set)
Default: 64 - (0xFF indicates it hasn't been set, will track flood.max until it is.)
Note: An alternative to region denyf *, setting flood.max.unscoped to a lower value such as 3 would allow for local unscoped messages to propagate, while preventing noisy neighbors from flooding a local region.
Usage:
get flood.max.advertset flood.max.advert <value>
Parameters:
value: Maximum flood hop count (0-64) for an advert packet
Default: 8
Usage:
setperm <pubkey> <permissions>
Parameters:
pubkey: Companion public keypermissions:0: Guest1: Read-only2: Read-write3: Admin
Note: Removes the entry when permissions is omitted
Usage:
get acl
Serial Only: Yes
Usage:
get allow.read.onlyset allow.read.only <state>
Parameters:
state:on(enable) oroff(disable)
Default: off
Usage:
region loadregion load <name> [flood_flag]
Parameters:
name: A name of a region.*represents the wildcard region
Note: flood_flag: Optional F to allow flooding
Note: Indentation creates parent-child relationships (max 8 levels)
Note: region load with an empty name will not work remotely (it's interactive)
Usage:
region save
Usage:
region allowf <name>
Parameters:
name: Region name (or*for wildcard)
Note: Setting on wildcard * allows packets without region transport codes
Usage:
region denyf <name>
Parameters:
name: Region name (or*for wildcard)
Note: Setting on wildcard * drops packets without region transport codes
Usage:
region get <name>
Parameters:
name: Region name (or*for wildcard)
Usage:
region homeregion home <name>
Parameters:
name: Region name
Usage:
region defaultregion default {name|<null>}
Parameters:
name: Region name, or to reset/clear
Usage:
region put <name> [parent_name]
Parameters:
name: Region nameparent_name: Parent region name (optional, defaults to wildcard)
Usage:
region def <token> [<token> ...]
Parameters (tokens): Space-separated. A logical cursor starts at the wildcard *.
name— Createnameas a child of the current cursor (equivalent toregion put namewith the cursor as parent). Cursor moves toname.name|jump(orname,jump) — Createnameas a child of the current cursor, then move the cursor tojump(must already exist on the node, or have been created earlier in this command).jumpis not the parent ofname; use this form to pop back up and start another branch.
Behavior: Each created region defaults to flood-allowed (same as region put). The reply is the resulting region tree (same format as bare region); review it before running region save to persist. On error, the reply is Err - ... and any regions placed before the failure remain on the node, just like a partial chain of region put.
Existing regions: region def does not clear the existing tree — if a name already exists, its parent is updated to the current cursor; otherwise a new region is created. To start from scratch, region remove the unwanted regions first.
Limits: Repeater serial accepts one line up to 160 characters. For larger trees, split across multiple region def commands; the cursor resets to * between commands, so lead the next command with child|ancestor to reposition. Each token splits at most once on | — region def a|b|c|d is not a flat-list shorthand; see the flat-list example below.
Example — linear chain (each token becomes a child of the previous):
region def a b c d e
region save
Example — branched tree (equivalent to region put a, region put b a, region put c b, region put d c, region put e b, region put f e):
region def a b c d|b e f
region save
Example — error and partial state:
region def a b c|nope d
The reply is Err - unknown jump: nope. a, b, and c were placed before the failure; d was not. Run region to inspect, then re-run with a corrected jump or repair with region remove / region put.
Example — flat list (each region a child of *). Use |* after each token to pop the cursor back to the root before the next token:
region def a|* b|* c|* d|* e|* f
region save
Usage:
region remove <name>
Parameters:
name: Region name
Note: Must remove all child regions before the region can be removed
Usage:
region list <filter>
Serial Only: Yes
Parameters:
filter:allowed|denied
Note: Requires firmware 1.12+
Usage:
region
Serial Only: For firmware older than 1.12.0
Example 1: Using F Flag with Named Public Region
region load
#Europe F
<blank line to end region load>
region save
Explanation:
- Creates a region named
#Europewith flooding enabled - Packets from this region will be flooded to other nodes
Example 2: Using Wildcard with F Flag
region load
* F
<blank line to end region load>
region save
Explanation:
- Creates a wildcard region
*with flooding enabled - Enables flooding for all regions automatically
- Applies only to packets without transport codes
Example 3: Using Wildcard Without F Flag
region load
*
<blank line to end region load>
region save
Explanation:
- Creates a wildcard region
*without flooding - This region exists but doesn't affect packet distribution
- Used as a default/empty region
Example 4: Nested Public Region with F Flag
region load
#Europe F
#UK
#London
#Manchester
#France
#Paris
#Lyon
<blank line to end region load>
region save
Explanation:
- Creates
#Europeregion with flooding enabled - Adds nested child regions (
#UK,#France) - All nested regions inherit the flooding flag from parent
Example 5: Wildcard with Nested Public Regions
region load
* F
#NorthAmerica
#USA
#NewYork
#California
#Canada
#Ontario
#Quebec
<blank line to end region load>
region save
Explanation:
- Creates wildcard region
*with flooding enabled - Adds nested
#NorthAmericahierarchy - Enables flooding for all child regions automatically
- Useful for global networks with specific regional rules
Usage:
gpsgps <state>
Parameters:
state:on|off
Default: off
Note: Output format:
offwhen the GPS hardware is disabledon, {active|deactivated}, {fix|no fix}, {sat count} satswhen the GPS hardware is enabled
Usage:
gps sync
Usage:
gps setloc
Usage:
gps advertgps advert <policy>
Parameters:
policy:none|share|prefsnone: don't include location in advertsshare: share gps location (from SensorManager)prefs: location stored in node's lat and lon settings
Default: prefs
Usage: sensor list [start]
Parameters:
start: Optional starting index (defaults to 0)
Note: Output format: <var_name>=<value>\n
Usage:
sensor get <key>sensor set <key> <value>
Parameters:
key: Sensor setting namevalue: The value to set the sensor to
Usage: get bridge.type
Usage:
get bridge.enabledset bridge.enabled <state>
Parameters:
state:on|off
Default: off
Usage:
get bridge.delayset bridge.delay <ms>
Parameters:
ms: Delay in milliseconds (0-10000)
Default: 500
Usage:
get bridge.sourceset bridge.source <source>
Parameters:
source:logRx: bridges received packetslogTx: bridges transmitted packets
Default: logTx
Usage:
get bridge.baudset bridge.baud <rate>
Parameters:
rate: Baud rate (9600,19200,38400,57600, or115200)
Default: 115200
Usage:
get bridge.channelset bridge.channel <channel>
Parameters:
channel: Channel number (1-14)
Usage:
get bridge.secretset bridge.secret <secret>
Parameters:
secret: ESP-NOW bridge secret, up to 15 characters
Default: Varies by board
Usage: get bootloader.ver
Usage: get pwrmgt.support
Usage: get pwrmgt.source
Note: Returns an error on boards without power management support.
Usage: get pwrmgt.bootreason
Note: Returns an error on boards without power management support.
Usage: get pwrmgt.bootmv
Note: Returns an error on boards without power management support.