Skip to content
Docs

Console usage

Connect the board over USB, use idf.py monitor, minicom, or the web flasher Console to reach the edge_agent prompt (default app> ).

Session and Q&A

Section titled “Session and Q&A”

Switch session

Section titled “Switch session”

Each session uses its own history file (see Memory). Long-term memory data is managed in the shared memory/ directory.

session demo
session

Chat with the LLM

Section titled “Chat with the LLM”

ask starts a multi-turn chat with history. Add --once for a single turn that does not use session history.

ask list what you can do for me
ask --once one-off question, do not use history

cap

Section titled “cap”

List capabilities

Section titled “List capabilities”
cap list

Invoke a capability

Section titled “Invoke a capability”

The second argument must be valid JSON (mind quoting/escaping).

cap call get_current_time '{}'
cap call list_dir '{"keyword":"scripts"}'

Inspect capability groups

Section titled “Inspect capability groups”

A capability may expose many tools, which are organized into groups.

cap groups

File listing

Section titled “File listing”

ls recursively lists files under the DATA and SYSTEM roots. Its optional argument filters paths by keyword.

ls
ls scripts

skill

Section titled “skill”

skill lists the current Skill catalog. Add --reload to rescan the directories first.

skill
skill --reload

router

Section titled “router”
router --reload
router --rules
router --last
Dataflow and automation More commands and details in this doc

Hardware resources: hwmap

Section titled “Hardware resources: hwmap”

hwmap shows registered resources and their users; hwmap query <key> selects one resource. EXCLUSIVE permits at most one claim, while SHARED permits multiple claims. USERS is the current usage count and CLAIM is the usage credential ID. Registered idle resources show (free); an unregistered key returns an error.

hwmap
hwmap query gpio:1
hwmap query bus:i2c0
hwmap query device:display_lcd

Resources are registered at startup and claimed when Board Manager actually initializes each driver. Successful driver deinitialization releases its claim. Flash, PSRAM and console resources are outside this registry’s protection scope. Shared access reuses an existing hardware object and does not guarantee that arbitrary concurrent operations are safe.

Other registered commands

Section titled “Other registered commands”

Depending on the build configuration, edge_agent can also register lua, scheduler, router, skill, hwmap, and wifi. Type help in the Console for the full list.

System configuration

Section titled “System configuration”

For runtime Wi‑Fi / LLM edits, Web is often easier:

Web configuration Change settings and files from the LAN
Configuration NVS keys and how values apply