Metadata-Version: 2.4
Name: reterminal-cli
Version: 0.8.1
Summary: Agent and CLI for operating a Seeed Studio reTerminal edge device — provisioning, display, and I/O for the LCD/CM industrial terminal.
Project-URL: Homepage, https://github.com/agentculture/reterminal
Project-URL: Issues, https://github.com/agentculture/reterminal/issues
Author: AgentCulture
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development
Requires-Python: >=3.12
Provides-Extra: graphics
Requires-Dist: cairosvg>=2.7; extra == 'graphics'
Requires-Dist: pillow>=10.1; extra == 'graphics'
Description-Content-Type: text/markdown

# 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](https://github.com/agentculture/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.md` for `backend: claude`).
- **The canonical guildmaster skill kit** (11 skills) under `.claude/skills/`,
  vendored cite-don't-import. See [`docs/skill-sources.md`](docs/skill-sources.md).
- **A build + deploy baseline** — pytest, lint, the agent-first rubric gate, and
  PyPI Trusted Publishing wired into GitHub Actions.

## Quickstart

```bash
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`](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`](docs/skill-sources.md)).

See [`CLAUDE.md`](CLAUDE.md) for the full conventions (version-bump-every-PR,
the `cicd` PR lane, deploy setup).

## License

MIT — see [`LICENSE`](LICENSE).
