You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- GitHub Actions uses `mise` as the canonical entrypoint for tool setup and quality gates.
14
-
- The committed workflow in `.github/workflows/ci.yml` is hand-curated. `mise generate github-action` is useful as a scaffold, but the checked-in file is the maintained source of truth because it includes repo-specific triggers, bootstrap behavior, and step-level logs.
15
-
- CI uses `mise run bootstrap-ci` for deterministic `npm ci` installs, then explicitly runs `npx playwright install chromium` so renderer smoke coverage is exercised on GitHub Actions.
16
-
- For v1, CI intentionally follows the major-version tool pins declared in `mise.toml` (`node = "24"`, `python = "3"`). This repo does not commit a `mise.lock` yet.
21
+
## Feature highlights
22
+
23
+
- Full session lifecycle management: create, inspect, list, wait, destroy, and garbage-collect.
24
+
- Semantic snapshots for structured or text inspection, including optional scrollback capture.
25
+
- Renderer-backed screenshots and replay exports for reviewable visual evidence.
26
+
- Recording export to asciicast (`.cast`) or WebM for artifact bundles.
27
+
- Failure recovery via reconciliation, stale-session cleanup, and retained manifests/artifacts.
28
+
29
+
## CLI-wide flags
30
+
31
+
-`--home <path>`: override the agent-terminal home directory.
32
+
-`--timeout-ms <n>`: apply a shared CLI timeout budget in milliseconds.
33
+
-`--no-color`: disable ANSI color in human-readable output.
34
+
-`--json`: available on user-facing commands to emit structured command envelopes.
35
+
36
+
## Commands
37
+
38
+
-`version`: print the CLI version.
39
+
-`doctor`: validate local environment requirements.
40
+
-`create [command...]`: create a session and launch the requested command or shell.
41
+
-`list`: list sessions, optionally including exited ones.
42
+
-`inspect <session-id>`: inspect manifest state and artifact metadata for a session.
43
+
-`destroy <session-id>`: tear down a session, with optional forced shutdown.
44
+
-`gc`: remove stale or old sessions.
45
+
-`type <session-id> [text]`: type text into a session.
46
+
-`paste <session-id> [text]`: paste text into a session.
47
+
-`mark <session-id> <label>`: add a marker event to a session timeline.
48
+
-`send-keys <session-id> <keys...>`: send key sequences such as `Enter` or `Ctrl+C`.
49
+
-`resize <session-id>`: resize the PTY dimensions.
50
+
-`signal <session-id> <signal>`: send a POSIX signal to the session child process.
51
+
-`snapshot <session-id>`: capture a semantic snapshot of terminal contents.
52
+
-`screenshot <session-id>`: capture a rendered PNG screenshot.
53
+
-`record export <session-id>`: export replay artifacts as asciicast or WebM.
54
+
-`wait <session-id>`: wait for exit, idleness, text, regex, cursor, or stable-screen conditions.
55
+
56
+
## Development setup
57
+
58
+
```bash
59
+
mise install
60
+
npm ci
61
+
npx playwright install chromium
62
+
```
63
+
64
+
Useful shortcuts:
65
+
66
+
-`mise run bootstrap`: install npm dependencies and Chromium in one step.
67
+
-`npm run cli -- --help`: inspect the CLI locally without building.
68
+
69
+
## Verification
70
+
71
+
```bash
72
+
npm run verify
73
+
```
74
+
75
+
That runs formatting, linting, typechecking, unit/e2e tests, and the production build.
76
+
77
+
## Design docs
78
+
79
+
Design and implementation notes live under `design/`, especially `design/20260319_agent-terminal-v1/`.
80
+
81
+
## Repository notes
82
+
83
+
- CI uses `mise` for tool provisioning and quality-gate entrypoints.
84
+
- Chromium is required locally for screenshot and replay export coverage.
85
+
- Dogfood proof bundles and validation notes live under `dogfood/` and `design/`.
0 commit comments