ACL CLI Commands

Learn how to manage MeshCore Access Control Lists (ACLs) using CLI commands to control node permissions, manage authorised administrators, and configure access to your mesh network. This guide explains how to manage access securely and maintain control over who can administer your MeshCore node.

Updated 29 October 2026

1. Add, Update or Remove Companion Permissions

Manage the permissions assigned to a companion device using its public key.

Command:

setperm <pubkey> <permissions>

Parameters:

Parameter	Description
`pubkey`	The companion's public key.
`permissions`	The permission level to assign to the companion.

Permission levels:

Value	Permission	Description
`0`	Guest	Guest-level access.
`1`	Read-only	Read-only access.
`2`	Read-write	Read and write access.
`3`	Admin	Administrator access.

Note: Omitting the permissions parameter removes the companion's entry from the ACL.

2. View the Current Access Control List (ACL)

Display the current Access Control List (ACL), showing the permissions configured for companion devices.

Command:

get acl

Availability: Serial only.

3. View or Change the Room Server's Read-Only Setting

View or configure whether the Room Server operates in read-only mode.

Commands:

get allow.read.only
set allow.read.only <state>

Parameters:

Parameter	Description
`state`	Set to `on` to enable read-only mode or `off` to disable it.

Default: off

Examples:

Enable read-only mode:

set allow.read.only on

Disable read-only mode:

set allow.read.only off