Agent and CLI for operating a Seeed Studio reTerminal edge device — provisioning, display, and I/O for the LCD/CM industrial terminal.
Project description
reterminal
Agent and CLI for operating a Seeed Studio reTerminal edge device — provisioning, display, and I/O for the LCD/CM industrial terminal.
What you get
- Device operation — map devices to serial ports, query and flash SenseCraft firmware, render to the e-paper display, and sound the buzzer, all from the CLI.
- An agent-first CLI cited from teken
(
afi-cli) — every command also speaks--json, and the runtime package has no third-party dependencies. - A mesh identity —
culture.yaml(suffix+backend) and the matching prompt file (CLAUDE.mdforbackend: claude). - The canonical guildmaster skill kit (11 skills) under
.claude/skills/, vendored cite-don't-import. Seedocs/skill-sources.md. - A build + deploy baseline — pytest, lint, the agent-first rubric gate, and PyPI Trusted Publishing wired into GitHub Actions.
Quickstart
uv sync
uv run reterminal learn # what the tool does + the command map (add --json)
uv run reterminal devices list # local: device→serial-port mappings on this machine
uv run reterminal display set "hello" # needs a reachable reTerminal E (ESPHome firmware)
uv run reterminal whoami # identity from culture.yaml
uv run pytest -n auto # run the test suite
devices is local; firmware, display, and speaker act on a connected
reTerminal E (USB-serial for firmware flash, the ESPHome HTTP API for
display / speaker).
CLI
Operate the reTerminal E:
| Command | What it does |
|---|---|
devices: record / list |
Record and list device→serial-port mappings (per-machine). |
firmware: list / flash |
Query the SenseCraft firmware catalog and flash a reTerminal E. |
display: set / show / image / card / cloud / svg |
Render text or graphics to the e-paper display (partial refresh — in place, no clear-flash; full clear every Nth update). |
speaker: beep |
Sound the buzzer. |
Introspection and identity:
| Command | What it does |
|---|---|
whoami |
Report this agent's nick, version, backend, and model from culture.yaml. |
learn |
Print a structured self-teaching prompt. |
explain <path> |
Markdown docs for any noun/verb path. |
overview |
Read-only descriptive snapshot of the agent. |
doctor |
Check the agent-identity invariants (prompt-file-present, backend-consistency). |
cli overview |
Describe the CLI surface itself. |
Every command supports --json. Each noun group has its own overview
(reterminal display overview). Results go to stdout, errors/diagnostics to
stderr (never mixed). Exit codes: 0 success, 1 user error, 2 environment
error, 3+ reserved.
Fork it for another agent
reterminal began as the culture-agent-template scaffold, so it doubles as a
starting point for a new AgentCulture mesh agent. To repurpose it:
- Rename the package
reterminal/and thereterminalCLI/dist name throughoutpyproject.toml, the package,tests/,sonar-project.properties, and thisREADME.md. The name is hard-coded in ~100 places, so list every occurrence first — see thegit grepdiscovery command inCLAUDE.md, the authoritative rename procedure. - Edit
culture.yamlwith yoursuffixandbackend. - Rewrite
CLAUDE.mdfor your agent and run/init. - Re-vendor only the skills you need from guildmaster (see
docs/skill-sources.md).
See CLAUDE.md for the full conventions (version-bump-every-PR,
the cicd PR lane, deploy setup).
License
MIT — see LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file reterminal_cli-0.10.0.tar.gz.
File metadata
- Download URL: reterminal_cli-0.10.0.tar.gz
- Upload date:
- Size: 196.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cf3441270295ad163fc6d55fb6982c0d7ef1d2be59d9ca13abd3a7febfb0f0e0
|
|
| MD5 |
b309ec950a298c34da66755e003f8da8
|
|
| BLAKE2b-256 |
0749c07b86fb5cc8e22f74a2a64e34dadc10a402ab995f8188c40f6b2680c150
|
File details
Details for the file reterminal_cli-0.10.0-py3-none-any.whl.
File metadata
- Download URL: reterminal_cli-0.10.0-py3-none-any.whl
- Upload date:
- Size: 53.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d1a44a0825a98beb1b63d1b2031da7d6330e48a52d6013974c95f1aabc6e1e06
|
|
| MD5 |
07f45ef996a39147942a080ffee34b79
|
|
| BLAKE2b-256 |
f4f0f6e02c8d10b62ff2010a5277c2bfec3e176dde5202ddbec9d3cb2c727012
|