@davidbalzan/groundwork-console 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +40 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Groundwork Console
|
|
2
|
+
|
|
3
|
+
The cockpit for [Groundwork Kit](https://github.com/davidbalzan/groundwork-kit) fleets — the board (WORKSTREAMS/QUEUE/DONE/FACTS), the agent bus, live tmux panes, docs with change marks, roadmap actions, and ops — in one local web app. Single user, token auth, loopback by default.
|
|
4
|
+
|
|
5
|
+
## Install & run
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm i -g agent-coord-mcp @davidbalzan/groundwork agent-coordination # the kit (once)
|
|
9
|
+
npx @davidbalzan/groundwork-console # or: npm i -g … && groundwork-console (alias: gwc)
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
First run creates `~/.groundwork-console/config.json` (add projects from Home → **Add project**) and `~/.groundwork-console/token`, prints the URL and a sign-in link, and opens the browser already signed in. Everything runs on one port (`:8790`).
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
groundwork-console [start] [--port 8790] [--host 127.0.0.1] [--no-open] [--no-auth] [--config <file>]
|
|
16
|
+
groundwork-console doctor # kit requires + which bins/paths were resolved
|
|
17
|
+
groundwork-console token # print the token
|
|
18
|
+
groundwork-console config # print the config path
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Requires on the host: Node ≥ 22, tmux (pane monitor / spawn), and either the three kit bins above on PATH or a kit checkout at `kitPath` in the config. `doctor` tells you which it found. Console requires: seam `^0.1.0` · agent-coord-mcp `^0.23.0` · groundwork `^0.3.0` · agent-coordination `^0.5.0`.
|
|
22
|
+
|
|
23
|
+
## What it does
|
|
24
|
+
|
|
25
|
+
- **Home** — what needs you (DAVID_DECISION packets with age), fleet presence per project, roadmap strips.
|
|
26
|
+
- **Board** — active streams, queue, done, facts, phases with Plan / Kick off / Audit (DMs to the aide/coordinator), project doctor with Fix → agent.
|
|
27
|
+
- **Bus** — rooms, inbox, status stream, prefix chips, decision packets; replies mark packets answered.
|
|
28
|
+
- **Monitor** — live read-only tmux panes per agent, role colours, the "Now" widget (phase · streams → owners), pop-out with the phase task list.
|
|
29
|
+
- **Docs** — project docs and the global knowledge repo (ADRs, notes) with git change marks; edit non-seam docs in place.
|
|
30
|
+
- **Summon** — bottom-right avatar: DM any agent from any page with the page/doc as context, paste images.
|
|
31
|
+
- **Ops** — fleets (spawn / unregister / prune / decommission), skills, release, runs, events.
|
|
32
|
+
|
|
33
|
+
Writes are behind two one-click header switches (bus writes · seam & docs writes); with both off the console cannot change disk or bus. Seam files are only ever written through the seam (byte-identical round-trip); the console never types into panes — messages go through the bus and each agent's own pusher.
|
|
34
|
+
|
|
35
|
+
## Config & env
|
|
36
|
+
|
|
37
|
+
`~/.groundwork-console/config.json`: `{ "kitPath": "~/workspace/groundwork-kit", "coordDir": "~/agent-coord", "projects": [{ "name", "path", "room" }] }`.
|
|
38
|
+
Env: `GROUNDWORK_CONSOLE_HOST` (bind; default `127.0.0.1` — put the token auth in front before exposing), `GROUNDWORK_CONSOLE_TOKEN`, `GROUNDWORK_CONSOLE_AUTH=off`, `GROUNDWORK_CONSOLE_CONFIG`, `GROUNDWORK_CONSOLE_RULES`, `AGENT_COORD_DIR`, `PORT`. (`KIT_CONSOLE_*` from the pre-rename days is still honoured.)
|
|
39
|
+
|
|
40
|
+
Source, issues, design notes: <https://github.com/davidbalzan/groundwork-console>. MIT.
|