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
docs: align public face with HITL and provider reality (#44)
* docs: align public face with HITL and provider reality
Correct overstated live-LLM, scenario, shared-mode, and G1–G6 claims;
add docs indexes and package repository metadata for the GitHub storefront.
* docs: clarify shared-mode console Bearer after r3 rebase
---------
Co-authored-by: Sage Hart <sagehart@MacBookAir.attlocal.net>
CorpOS shows how a firm operates when department agents do most work and **humans govern by exception** (Approve / Reject / Kill in the ops console). Autonomy is earned from evidence, not granted in prompts. Interop protocols (MCP) are transport; **community governance (G1–G6)** lives in the firm.
11
+
CorpOS shows how a firm operates when department agents do most work and **humans govern by exception** (Approve / Reject / Kill in the ops console). Autonomy is earned from evidence, not granted in prompts. Interop protocols (MCP) are transport; firm-side governance includes **G1 membership** and **G4 dissent** today, with a broader G1–G6 crosswalk in the docs.
12
12
13
13
> **Scope:** Reference architecture and runnable demo — **not** a production-hardened SaaS. See [SECURITY.md](SECURITY.md).
14
14
15
15
Default mode is **simulation** (`SimulationProvider`) for deterministic CI. Live LLM (`HttpLLMProvider`) drives company-day/orchestrator only when `CORPOS_ALLOW_LIVE=1` and `OPENROUTER_API_KEY` are set — `/api/health.mode` never lies. G1–G6 firm governance, orchestrator-driven day, TTL scheduler, console Bearer (shared mode), and live `/api/events` SSE are implemented.
16
16
17
-
Read the thesis: [`docs/future-of-the-firm.md`](docs/future-of-the-firm.md). Governance crosswalk: [`docs/governance-crosswalk.md`](docs/governance-crosswalk.md). AIBOM: [`docs/aibom.json`](docs/aibom.json).
@@ -35,7 +35,7 @@ Read the thesis: [`docs/future-of-the-firm.md`](docs/future-of-the-firm.md). Gov
35
35
-**Local demo:**`npm install && npm run build && npm run dev` → [http://localhost:3000](http://localhost:3000)
36
36
-**Regenerate GIF/PNGs:** start the console, then `npm run screenshots` — see [`docs/assets/README.md`](docs/assets/README.md)
37
37
38
-
Click **Run company day** to watch the agent activity timeline: support → finance → ops handoffs, an autonomous settle, an exception approval path, compensation, and trust unlock.
38
+
Click **Run company day** to watch the agent activity timeline: support → finance → ops handoffs, an autonomous settle, an exception approval path, compensation, and trust unlock. The console sends `autoApproveException: false` so the exception stays in the HITL queue for Approve/Reject.
39
39
40
40
---
41
41
@@ -47,13 +47,25 @@ npm run build
47
47
npm run dev # ops console on $PORT or 3000
48
48
```
49
49
50
+
Contributors and CI should use `npm ci --include=dev` (see [CONTRIBUTING.md](CONTRIBUTING.md)).
51
+
50
52
```bash
51
53
npm test
52
-
npm run scenario
54
+
npm run scenario# HITL default-off; exits non-zero when exception is not auto-settled
./scripts/harness/adversarial.sh # authorized local adversarial probes (CI also runs this)
58
+
```
59
+
60
+
### Container
61
+
62
+
```bash
63
+
docker build -t corpos .
64
+
docker run --rm -p 3000:3000 corpos
55
65
```
56
66
67
+
CI may publish images to `ghcr.io/safetymp/corpos` (tags: branch, sha, semver, `latest`). Optional Fly.io deploy runs from [`.github/workflows/deploy.yml`](.github/workflows/deploy.yml) on GitHub release when `FLY_API_TOKEN` is set — see [`fly.toml`](fly.toml).
68
+
57
69
## Architecture
58
70
59
71
| Layer | Package / app | Responsibility |
@@ -65,15 +77,15 @@ npm run audit:verify
65
77
66
78
Stack: Node ≥22 · TypeScript · npm workspaces · Hono · Drizzle + libsql · official MCP SDK · Preact. No Express, no `better-sqlite3`, no agent-framework lock-in.
67
79
68
-
Architecture decisions live in [`docs/adr/`](docs/adr/).
80
+
Architecture decisions live in [`docs/adr/README.md`](docs/adr/README.md).
69
81
70
82
## Security
71
83
72
-
Reference architecture — not production-hardened. Set `CORPOS_MODE=shared`and`DASHBOARD_API_TOKEN`before exposing approvals. See [SECURITY.md](SECURITY.md).
84
+
Reference architecture — not production-hardened. `CORPOS_MODE=shared`plus`DASHBOARD_API_TOKEN`enables a **Bearer token gate on the API** for approve/kill mutations. The ops console does not yet attach that token (shared-mode approvals return 401 until a Bearer-capable client is used). See [SECURITY.md](SECURITY.md).
73
85
74
86
## Community
75
87
76
-
[Contributing](CONTRIBUTING.md) · [Code of Conduct](CODE_OF_CONDUCT.md) · [Security](SECURITY.md) · [ADRs](docs/adr/)
88
+
[Contributing](CONTRIBUTING.md) · [Code of Conduct](CODE_OF_CONDUCT.md) · [Security](SECURITY.md) · [ADRs](docs/adr/README.md)
0 commit comments