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
Copy file name to clipboardExpand all lines: README.md
+11Lines changed: 11 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,9 +105,20 @@ comux works as a standalone tmux/worktree cockpit. It also speaks to Coven when
105
105
106
106
Coven is the harness substrate. comux is the cockpit. OpenMeow and OpenClaw can sit above them as intake and orchestration layers.
107
107
108
+
Demo loop:
109
+
110
+
1. Open a project in comux.
111
+
2. Launch a Coven-backed Codex or Claude Code session.
112
+
3. Watch it as a visible pane/session.
113
+
4. Inspect files and diffs.
114
+
5. Merge, create a PR, archive, or clean up explicitly.
115
+
116
+
See [comux + Coven demo loop](./docs/COVEN-DEMO-LOOP.md) and the [OpenCoven public roadmap](https://github.com/OpenCoven/coven/blob/main/docs/ROADMAP.md).
Install comux and Coven, then verify both from the same shell:
17
+
18
+
```bash
19
+
npm install -g comux
20
+
npx @opencoven/cli doctor
21
+
```
22
+
23
+
Coven is optional. comux still works as a standalone tmux/worktree cockpit when Coven is not installed or the daemon is stopped.
24
+
25
+
For the Coven-backed path, start the local daemon:
26
+
27
+
```bash
28
+
coven doctor
29
+
coven daemon start
30
+
coven daemon status
31
+
```
32
+
33
+
## Demo path
34
+
35
+
From the repository you want to work in:
36
+
37
+
```bash
38
+
cd /path/to/project
39
+
comux
40
+
```
41
+
42
+
Inside comux:
43
+
44
+
1. Press `n` to create a normal comux agent pane, or press `d` to launch the desktop-use Coven pane.
45
+
2. For a CLI-launched Coven session, run one of these in a terminal pane:
46
+
47
+
```bash
48
+
coven run codex "fix the failing tests" --title "Fix tests"
49
+
coven run claude "review this branch" --title "Review branch"
50
+
```
51
+
52
+
3. The side panel shows matching Coven sessions for the active project when the daemon API is reachable.
53
+
4. Use `j` to watch the pane, `f` to inspect files and diffs, and `m` to open the pane menu.
54
+
5. Finish with an explicit action: merge, create a GitHub PR, close/archive the session, or clean up the worktree.
55
+
56
+
## Current Coven contract verified by comux
57
+
58
+
comux talks to the local Coven daemon through `/api/v1`:
59
+
60
+
-`GET /api/v1/health`
61
+
-`GET /api/v1/sessions`
62
+
-`POST /api/v1/sessions`
63
+
-`GET /api/v1/sessions/:id`
64
+
-`GET /api/v1/events?sessionId=...`
65
+
-`POST /api/v1/sessions/:id/input`
66
+
67
+
The current stable daemon contract is `apiVersion: "coven.daemon.v1"`. Event reads use the paginated event envelope with `nextCursor.afterSeq`, and comux keeps polling from that sequence cursor instead of replaying the whole event log.
68
+
69
+
The older `coven sessions --json` adapter remains available only as an explicit legacy fallback for visibility-only compatibility. The default list, launch, open, and event paths use the local daemon API.
70
+
71
+
## Unavailable states
72
+
73
+
If Coven is missing or stopped, comux keeps running:
74
+
75
+
- the side panel shows a compact Coven unavailable state;
76
+
- desktop-use launch failures point at `coven daemon start`;
77
+
- ordinary comux panes, worktrees, file browsing, merge, PR, and cleanup flows still work.
Copy file name to clipboardExpand all lines: docs/COVEN-SESSIONS.md
+19-4Lines changed: 19 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,29 @@
1
1
# Coven session visibility
2
2
3
-
comux treats Coven as an optional local runtime. The first integration slice is deliberately thin: comux can render a read-only Coven sessions section in the side panel when a future `coven sessions --json` command is available.
3
+
comux treats Coven as an optional local runtime. comux stays useful on its own, and when a local Coven daemon is available it can show, launch, and attach Coven-managed sessions beside normal comux panes.
4
4
5
5
## Adapter boundary
6
6
7
-
The TUI calls:
7
+
The preferred bridge path is the local daemon API:
8
+
9
+
```text
10
+
GET /api/v1/health
11
+
GET /api/v1/sessions
12
+
POST /api/v1/sessions
13
+
GET /api/v1/sessions/:id
14
+
GET /api/v1/events?sessionId=...
15
+
POST /api/v1/sessions/:id/input
16
+
```
17
+
18
+
comux first checks `GET /api/v1/health` and accepts the current stable `apiVersion: "coven.daemon.v1"` contract. Event polling accepts the current paginated envelope and stores `nextCursor.afterSeq`-style sequence progress by reading event `seq` values.
19
+
20
+
The legacy visibility-only CLI fallback is still supported for tests and older local builds when explicitly configured:
8
21
9
22
```bash
10
23
coven sessions --json
11
24
```
12
25
13
-
If the command is missing, unsupported, invalid JSON, or too slow, comux keeps running and shows a compact unavailable state. No unpublished Coven APIs are imported.
26
+
If the daemon or command is missing, unsupported, invalid JSON, or too slow, comux keeps running and shows a compact unavailable state. No unpublished Coven APIs are imported.
14
27
15
28
## Proposed JSON contract
16
29
@@ -57,5 +70,7 @@ Required fields for comux visibility are `id` and `projectRoot`/`project_root`.
57
70
- Sessions whose project roots cannot be verified are hidden.
58
71
- The side panel renders a small `☾ Coven sessions` section under each project with matching sessions.
59
72
- Empty and unavailable states are non-fatal and stay inside the side panel.
73
+
- Desktop-use panes launch through the daemon API and attach with `coven attach <session-id>`.
74
+
- Socket/daemon failures are reported as action-oriented messages, such as starting Coven with `coven daemon start`.
60
75
61
-
Future slices can add selection, attach/open actions, and live event timelines without changing this adapter boundary.
76
+
See [comux + Coven demo loop](COVEN-DEMO-LOOP.md) for the end-to-end demo path and the [OpenCoven public roadmap](https://github.com/OpenCoven/coven/blob/main/docs/ROADMAP.md) for the upstream milestone.
0 commit comments