Skip to main content

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 identityculture.yaml (suffix + backend) and the matching prompt file (CLAUDE.md for backend: claude).
  • The canonical guildmaster skill kit (11 skills) under .claude/skills/, vendored cite-don't-import. See docs/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:

  1. Rename the package reterminal/ and the reterminal CLI/dist name throughout pyproject.toml, the package, tests/, sonar-project.properties, and this README.md. The name is hard-coded in ~100 places, so list every occurrence first — see the git grep discovery command in CLAUDE.md, the authoritative rename procedure.
  2. Edit culture.yaml with your suffix and backend.
  3. Rewrite CLAUDE.md for your agent and run /init.
  4. 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reterminal_cli-0.8.1.tar.gz (183.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reterminal_cli-0.8.1-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

Details for the file reterminal_cli-0.8.1.tar.gz.

File metadata

  • Download URL: reterminal_cli-0.8.1.tar.gz
  • Upload date:
  • Size: 183.7 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

Hashes for reterminal_cli-0.8.1.tar.gz
Algorithm Hash digest
SHA256 3cb614a5d590883e4eff5c7e742bf140b76e6d93d6380462b5cf074c2e00596b
MD5 d6abd8099d481e130096775306561bca
BLAKE2b-256 8281e8ee03094c4089f00e3fbf3db94df872d74a9fd0980cc6469dcc3a4811b2

See more details on using hashes here.

File details

Details for the file reterminal_cli-0.8.1-py3-none-any.whl.

File metadata

  • Download URL: reterminal_cli-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 47.8 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

Hashes for reterminal_cli-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6cefab22cb74aa3d74856b7da666e808180e035311805b69a18b43ff8f0c290e
MD5 992536be2bbea10b664182bdb8dc4028
BLAKE2b-256 4b8b1f7ccd24c6841dafff0bdc384a238682f934a4f0214946d9e335638aa50e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page