Skip to main content
Pitch In Subscribe

Terminal Chat CLI Commands

Terminal Chat CLI

Below are the commands you can enter into the Terminal Chat clients:client (the companion/serial chat client). These are the Terminal Chat client commands, which differ from the repeater serial-console commands used elsewhere in this book. They are entered bare, with no host-tool prefix. Other pages that show meshcli ... are referring to a separate host-side tool with its own syntax - do not mix the two. For the on-device repeater serial CLI, see the canonical command reference at docs.meshcore.io/cli_commands.

set freq {frequency}

Set the LoRa frequency. Example: set freq 915.8

set tx {tx-power-dbm}

Sets LoRa transmit power in dBm.

set name {name}

Sets your advertisement name.

set lat {latitude}

Sets your advertisement map latitude. (decimal degrees)

set lon {longitude}

Sets your advertisement map longitude. (decimal degrees)

set dutycycle {percent}

Sets the transmit duty cycle limit (1-100%). Example: set dutycycle 10 for 10%. Note: duty-cycle limiting is a regulatory requirement in the EU 868 MHz band (ETSI), not in the US 902-928 MHz band, where 47 CFR 15.247 uses frequency-hopping / digital-modulation rules instead. US operators are not subject to a duty-cycle cap, but courteous airtime limits still help network health.

set af {air-time-factor}

Sets the transmit air-time-factor. Deprecated - use set dutycycle instead.

time {epoch-secs}

Set the device clock using UNIX epoch seconds. Example: time 1738242833

advert

Sends an advertisement packet

clock

Displays current time per device's clock.

ver

Shows the device version and firmware build date.

card

Displays your 'business card', for other to manually _import_

import {card}

Imports the given card to your contacts.

list {n}

List all contacts by most recent. (optional {n}, is the last n by advertisement date)

to

Shows the name of current recipient contact. (for subsequent 'send' commands)

to {name-prefix}

Sets the recipient to the _first_ matching contact (in 'list') by the name prefix. (ie. you don't have to type whole name)

send {text}

Sends the text message (as DM) to current recipient.

reset path

Resets the path to current recipient, for new path discovery.

public {text}

Sends the text message to the built-in 'public' group channel

Back to top