Skip to content

Commit e0eceab

Browse files
AegisAegis
authored andcommitted
docs: complete 0.8.0 release documentation
1 parent 6393717 commit e0eceab

3 files changed

Lines changed: 111 additions & 9 deletions

File tree

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ AEGIS is a framework for building **personal AI agents** that remember everythin
2323
- **Standalone** — Clone, configure, deploy. Full agent in minutes.
2424
- **As a dependency**`npm install @stackbilt/aegis-core` and extend with your own routes, scheduled tasks, executors, and MCP tools via `createAegisApp()`.
2525

26-
The production instance runs 26 scheduled tasks, has executed 236+ autonomous coding sessions, and costs $0/month to host (Cloudflare Workers free tier + Workers AI for inference).
26+
The reference deployment runs the same scheduled-task framework and is designed for $0/month hosting on the Cloudflare Workers free tier, with Workers AI as the base inference path.
2727

2828
Built on Cloudflare Workers for edge-native deployment. Zero cold starts. Global distribution. Pay-per-request economics.
2929

3030
### Core Capabilities
3131

32-
- **Cognitive Kernel**Multi-model dispatch (Claude, Groq, Workers AI) with procedural memory routing. The right model for the right task, automatically.
32+
- **Cognitive Kernel**Workers AI-first dispatch with optional Claude and Groq executors, plus procedural memory routing. The right model for the right task, automatically.
3333
- **Multi-Tier Memory** — Episodic (what happened), semantic (what matters), procedural (what works), narrative (the story arc). Memory consolidates, decays, and strengthens over time.
3434
- **Autonomous Goals** — Set goals with standing orders and let AEGIS pursue them on a schedule. Progress tracked, blockers surfaced, results reported.
3535
- **Dreaming Cycle** — Nightly self-reflection over conversation history. Discovers patterns, proposes improvements, proposes new tools, consolidates knowledge. PRISM synthesis finds cross-domain connections.
@@ -71,7 +71,7 @@ Talk to the same deployment from a terminal:
7171
AEGIS_HOST=your-worker.workers.dev AEGIS_TOKEN=your-token npx @stackbilt/aegis-core --quick
7272
```
7373

74-
Release proof: [AEGIS 0.8.0 Proof of Work](docs/proof-of-work-0.8.0.md).
74+
Release proof: [AEGIS 0.8.0 Proof of Work](docs/proof-of-work-0.8.0.md). Demo path: [AEGIS 0.8.0 Demo Script](docs/demo-script-0.8.0.md).
7575

7676
## Use as a Dependency
7777

@@ -110,7 +110,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md#using-as-a-dependency) for full documentat
110110
│ COGNITIVE KERNEL │
111111
│ │
112112
│ Classify → Route (procedural memory) → Execute │
113-
│ (intent) (learned patterns) (Claude/Groq/WAI)
113+
│ (intent) (learned patterns) (WAI + optional)
114114
│ │
115115
│ ┌──────────────────────────────────────────────────────┐ │
116116
│ │ MEMORY TIERS │ │
@@ -221,7 +221,8 @@ AEGIS runs 26 tasks on an hourly cron, split into heartbeat (always-run) and tim
221221

222222
- **Runtime**: Cloudflare Workers (V8 isolates, global edge)
223223
- **Database**: Cloudflare D1 (SQLite at the edge)
224-
- **AI Models**: Claude (Anthropic), Groq (Llama 3.3), Workers AI (free inference)
224+
- **Base Inference**: Cloudflare Workers AI
225+
- **Optional Executors**: Claude (Anthropic), Groq (Llama 3.3)
225226
- **Framework**: Hono (lightweight, edge-native HTTP)
226227
- **Language**: TypeScript (strict mode)
227228
- **Protocol**: MCP (Model Context Protocol)
@@ -247,6 +248,8 @@ AEGIS pairs with other Stackbilt open-source tools:
247248
- [Configuration](docs/configuration.md) — Full operator config reference
248249
- [Memory System](docs/memory-system.md) — Memory tiers, consolidation, and dreaming cycle
249250
- [Connecting MCP Clients](docs/connecting-mcp-clients.md) — OpenClaw, Claude Desktop, Claude Code, Cursor, and any MCP client
251+
- [AEGIS 0.8.0 Demo Script](docs/demo-script-0.8.0.md) — Browser console plus CLI proof path
252+
- [AEGIS 0.8.0 Proof of Work](docs/proof-of-work-0.8.0.md) — Release evidence and validation notes
250253
- [Publishing](docs/publishing.md) — Release workflow, npm trusted publishing, and token fallback
251254

252255
## Contributing

docs/architecture.md

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ Request → Auth → Cognitive Kernel → Response
1212
├── Execute (model dispatch)
1313
└── Learn (episode recording)
1414
15+
Browser console → ASSETS binding → /api/message/stream
16+
└── /chat/ws
17+
Voice console → Agents SDK → /agents/aegis-voice-adapter/operator
18+
1519
Cron (hourly) → Scheduled Tasks
1620
1721
├── Phase 1: Free (D1 only)
@@ -22,6 +26,32 @@ Cron (hourly) → Scheduled Tasks
2226
└── Goals, dreaming, curiosity
2327
```
2428

29+
## Standalone deployment surface
30+
31+
As of 0.8.0, the public package ships as a self-sufficient Cloudflare Worker app, not just a kernel library. A fresh checkout can build and deploy the browser console, text chat, voice adapter, scheduled tasks, MCP server, and core API routes without private Stackbilt UI code.
32+
33+
The standalone Worker uses these bindings:
34+
35+
| Binding | Type | Purpose |
36+
|---------|------|---------|
37+
| `ASSETS` | Workers static assets | Serves the Vite-built web console from `web/public/` |
38+
| `DB` | D1 database | Stores conversations, memory, goals, agenda, tools, and task state |
39+
| `AI` | Workers AI | Base chat, voice, classification fallback, and low-cost summarization |
40+
| `CHAT_SESSION` | Durable Object | Maintains ordered terminal/browser chat sessions for `/chat/ws` |
41+
| `AegisVoiceAdapter` | Durable Object | Hosts the Cloudflare Voice/Agents SDK adapter |
42+
43+
The deployment path is intentionally small:
44+
45+
1. `npm run build:ui` builds `web/src/ui/` into `web/public/`.
46+
2. `wrangler.toml.example` wires `ASSETS`, `DB`, `AI`, `CHAT_SESSION`, and `AegisVoiceAdapter`.
47+
3. `npm run deploy` builds the UI and runs `wrangler deploy`.
48+
4. Visiting the Worker root serves the embedded console through `ASSETS`.
49+
5. `/api/*`, `/health`, `/chat/ws`, and `/agents/*` run through the Worker before static asset fallback.
50+
51+
All interactive routes use the same `AEGIS_TOKEN` bearer-token boundary. The browser voice route also accepts the token through the voice call query path so the Agents SDK adapter can authenticate the session before model routing.
52+
53+
Package consumers can still import `createAegisApp()` and compose their own routes, scheduled tasks, executors, and MCP tools. The standalone app is the reference assembly; the package exports the primitives needed to build variants.
54+
2555
## The dispatch cycle
2656

2757
Every user message follows the same path through the kernel:
@@ -53,10 +83,10 @@ AEGIS supports multiple AI backends, selected per-request based on intent and le
5383

5484
| Executor | Model | Use case |
5585
|----------|-------|----------|
56-
| `claude` | Claude Sonnet | Complex reasoning, code, analysis |
57-
| `claude-opus` | Claude Opus | Highest capability tasks |
58-
| `groq` | Llama 3.3 70B | Fast responses, classification |
59-
| `workers-ai` | Workers AI models | Free inference, summarization |
86+
| `workers-ai` | Workers AI models | Base chat path, voice, classification fallback, free inference, summarization |
87+
| `claude` | Claude Sonnet | Optional complex reasoning, code, analysis |
88+
| `claude-opus` | Claude Opus | Optional highest capability tasks |
89+
| `groq` | Llama 3.3 70B | Optional fast responses and classification |
6090
| `composite` | Multi-model | Complex queries requiring multiple perspectives |
6191
| `direct` | None (D1 only) | Memory lookups, agenda management |
6292
| `tarotscript` | Symbolic engine | Deterministic computation (optional) |

docs/demo-script-0.8.0.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# AEGIS 0.8.0 Demo Script
2+
3+
This script is the launch-safe path for recording or presenting AEGIS 0.8.0. It demonstrates the two public surfaces that now work from a standalone checkout: the embedded browser console and the package CLI.
4+
5+
## Goal
6+
7+
Show that a developer can install AEGIS, deploy a self-contained Cloudflare Worker, use the browser console, and talk to the same agent from a terminal without private Stackbilt infrastructure.
8+
9+
## Preflight
10+
11+
Run these from `web/` before recording:
12+
13+
```bash
14+
npm install
15+
npm run build:ui
16+
npm run typecheck
17+
cp wrangler.toml.example wrangler.toml
18+
npx wrangler deploy --dry-run
19+
```
20+
21+
The dry run should show the `ASSETS`, `DB`, `AI`, `CHAT_SESSION`, and `AegisVoiceAdapter` bindings.
22+
23+
For the published package smoke:
24+
25+
```bash
26+
npm pack @stackbilt/aegis-core@0.8.0
27+
node package/cli/aegis.mjs --help
28+
```
29+
30+
## Recording Flow
31+
32+
1. Open the Worker root and authenticate with `AEGIS_TOKEN`.
33+
2. Show the health summary in the embedded console.
34+
3. Send one grounded prompt:
35+
36+
```text
37+
What runtime and bindings are you using for this session?
38+
```
39+
40+
4. Send one continuity prompt:
41+
42+
```text
43+
Summarize what changed in AEGIS 0.8.0 using only release metadata or health data you can access.
44+
```
45+
46+
5. Open the voice panel and establish a call through `/agents/aegis-voice-adapter/operator`.
47+
6. Switch to a terminal and run:
48+
49+
```bash
50+
AEGIS_HOST=your-worker.workers.dev AEGIS_TOKEN=your-token npx @stackbilt/aegis-core --quick
51+
```
52+
53+
7. Ask the same release-summary prompt from the terminal to show that the browser and CLI are talking to the same deployed agent.
54+
8. End by showing [proof-of-work-0.8.0.md](proof-of-work-0.8.0.md).
55+
56+
## Trust Guardrails
57+
58+
- Keep the demo to health, release, configuration, memory, agenda, and directly available deployment facts.
59+
- Do not ask for live GitHub, npm, analytics, or production metrics unless the integration is configured and the response includes the tool/source path.
60+
- Treat Claude and Groq as optional upgrades. The base demo should work with `AEGIS_TOKEN`, D1, Workers AI, Durable Objects, and static assets.
61+
- If the agent cannot verify a fact from its configured surfaces, the correct answer is a clarification or limitation, not a guess.
62+
63+
## Success Criteria
64+
65+
- Browser console loads from the Worker root.
66+
- Text chat reaches `/api/message/stream`.
67+
- Voice call reaches `/agents/aegis-voice-adapter/operator`.
68+
- CLI connects with `AEGIS_HOST` and `AEGIS_TOKEN`.
69+
- The agent describes only facts available through release docs, health, memory, or configured tools.

0 commit comments

Comments
 (0)