docs: describe the community edition after the move to mem0 and the unified build
AGENTS.md no longer describes memory as half-migrated or asks for build:packages before running the sidecar, lists the tsc -b build and the test typecheck among the checks, and drops the removed weaver package. ADR-0007 and ADR-0008 record that core no longer re-exports the legacy substrate and that sqlite-vec is gone.
This commit is contained in:
24
AGENTS.md
24
AGENTS.md
@@ -11,8 +11,9 @@
|
||||
## 0. Where We Are
|
||||
|
||||
This branch turns the commercial Waggle OS codebase into an open-source **community edition**.
|
||||
The conversion is in progress: the code still contains team mode and the hive-mind memory
|
||||
substrate. Work packages remove or replace them one by one.
|
||||
The conversion is in progress. Memory runs on local mem0 through the memory contract (P1.5);
|
||||
team mode stays in postponed packages, and the excluded memory packages remain in the
|
||||
repository, unbuilt, until P2.2. Work packages remove or replace the rest one by one.
|
||||
|
||||
Sources of truth, in order:
|
||||
1. The agreed scope ("Waggle OSS Agreed Scope Annex", held by the project owner).
|
||||
@@ -45,8 +46,8 @@ The community edition:
|
||||
| Web UI | React 19, TypeScript, Vite 6, Tailwind CSS 3.4, Radix UI primitives (`apps/web`) |
|
||||
| Sidecar | Fastify on Node.js, run with tsx in development (`packages/server`) |
|
||||
| Desktop shell | Tauri 2 (`app/src-tauri`), an optional wrapper around the sidecar and web UI |
|
||||
| Database | SQLite via better-sqlite3 and sqlite-vec |
|
||||
| Memory | `MemoryStore` from `@waggle/memory-contract`, implemented on local mem0 by `@waggle/memory-mem0` (ADR-0007). Existing callers still use the hive-mind substrate until P1.5 |
|
||||
| Database | SQLite via better-sqlite3: `waggle.db` for Waggle's own data, and mem0's store for memory |
|
||||
| Memory | `MemoryStore` from `@waggle/memory-contract`, implemented on local mem0 by `@waggle/memory-mem0` (ADR-0007) |
|
||||
| Local models | Waggle-managed Ollama runtime, or the user's own provider keys |
|
||||
| Tests | Vitest (unit), Playwright (e2e and visual) |
|
||||
|
||||
@@ -60,10 +61,10 @@ npm workspaces with the root `package-lock.json`. Node `^20.19.0 || >=22.12.0`.
|
||||
|---|---|
|
||||
| `apps/web` | Keep. The main UI; all React code lives here. |
|
||||
| `app/` | Keep. Tauri shell only (there is no `app/src/`). |
|
||||
| `packages/agent`, `core`, `server`, `shared`, `sdk`, `weaver`, `marketplace`, `cli`, `launcher` | Keep. |
|
||||
| `packages/agent`, `core`, `server`, `shared`, `sdk`, `marketplace`, `cli`, `launcher` | Keep. |
|
||||
| `packages/memory-contract`, `packages/memory-mem0` | Keep. The memory contract and its mem0 implementation (ADR-0007). |
|
||||
| `packages/team-server`, `packages/waggle-dance`, `packages/worker` | Postponed: team mode stays in the repo, is not built or shipped (ADR-0003). |
|
||||
| `packages/hive-mind-*`, `memory-mcp`, `wiki-compiler` | Excluded once P1.5 moves all memory access to the contract. |
|
||||
| `packages/hive-mind-*`, `memory-mcp`, `wiki-compiler` | Excluded. Nothing in scope imports them; they are not built or tested and leave in P2.2. |
|
||||
| `packages/admin-web`, `apps/www` | Excluded. |
|
||||
| `apps/browser-ext` | Not decided. Do not extend it. |
|
||||
| `docs/` | `docs/oss/` holds the community-edition records. The remaining guides, reference, architecture, getting-started and contributing pages predate this edition and are rewritten in P2.4. Internal history (`sidecar/`, `benchmarks/`, `judging/`, internal docs) was removed in P2.2. |
|
||||
@@ -140,11 +141,13 @@ Still to be removed, so do not build on it: `install-audit.ts` in core (P1.2).
|
||||
|
||||
```bash
|
||||
npm ci
|
||||
npm run build:packages # required: workspace packages export dist/, the sidecar fails without it
|
||||
npm run build # typechecks apps/web, builds it into the root dist/ (emptied first)
|
||||
npm run dev:server # sidecar on http://localhost:3333, serves the UI from the root dist/
|
||||
```
|
||||
|
||||
- Workspace packages export their TypeScript source under the `source` condition, which
|
||||
tsx, Vitest, Vite and the sidecar bundle resolve (P2.1). No `build:packages` is needed
|
||||
before running or testing; it builds the `dist/` entries for publishing.
|
||||
- The sidecar registers routes for the files in `dist/` when it starts (`@fastify/static`
|
||||
with `wildcard: false`), so assets from a later build return 404. Restart the sidecar after
|
||||
`npm run build`.
|
||||
@@ -154,13 +157,13 @@ npm run dev:server # sidecar on http://localhost:3333, serves the UI from
|
||||
### Verification (run these, do not claim "it compiles")
|
||||
|
||||
```bash
|
||||
npx tsc --noEmit --project packages/agent/tsconfig.json
|
||||
npx tsc --noEmit --project packages/server/tsconfig.json # the sidecar runs via tsx, so nothing else typechecks it
|
||||
npm run build:packages # tsc -b over tsconfig.build.json: every in-scope package
|
||||
npx tsc --noEmit --project app/tsconfig.json
|
||||
npm run typecheck:tests # test suites; advisory until the existing errors are fixed
|
||||
npm run test # root Vitest: packages, tests/, scripts/ (excludes apps/**)
|
||||
(cd apps/web && npx vitest run) # web UI tests use their own config
|
||||
npm run lint # root config; ignores apps/web
|
||||
(cd apps/web && npx eslint .) # web config; 49 errors pre-exist (docs/oss/baseline.md)
|
||||
(cd apps/web && npx eslint .) # web config; errors pre-exist (docs/oss/baseline.md)
|
||||
npm run check:deps # every imported package is declared in its package.json
|
||||
```
|
||||
|
||||
@@ -310,7 +313,6 @@ interface AgentPersona {
|
||||
| mem0 | Open-source memory library (`mem0ai`, Apache-2.0) behind the contract, run locally |
|
||||
| Hive DS | Waggle design system tokens (`waggle-theme.css`) |
|
||||
| BEHAVIORAL_SPEC | Core agent rules (`packages/agent/src/behavioral-spec.ts`) |
|
||||
| Weaver | Memory consolidation and session-skill extraction (`packages/weaver`) |
|
||||
| WaggleDance | Multi-agent team coordination (`packages/waggle-dance`), postponed |
|
||||
| Work package | A unit of the conversion plan: 0.x, P0.x, P1.x, P2.x |
|
||||
| UF-NNN | An entry in the upstream fixes log (`docs/oss/upstream-fixes.md`) |
|
||||
|
||||
@@ -96,8 +96,9 @@ shared with the commercial edition; each scope is copied once (recorded in `wagg
|
||||
table only while its target is empty.
|
||||
|
||||
The logger, injection scanner, external-memory ingress guard, `WorkspaceManager` and the
|
||||
embedders were copied from `@waggle/hive-mind-core` into `@waggle/core`, which now re-exports
|
||||
its own copies. The substrate keeps its copies until it is removed. Those files came from an
|
||||
embedders were copied from `@waggle/hive-mind-core` into `@waggle/core`, which exports its own
|
||||
copies. Since P1.5 `@waggle/core` no longer depends on or re-exports the substrate; the
|
||||
substrate keeps its copies until it is removed in P2.2. Those files came from an
|
||||
Apache-2.0 package into the MIT `core` package; both are Egzakta's code, and the licence of the
|
||||
copies is part of the licensing review.
|
||||
|
||||
|
||||
@@ -28,9 +28,9 @@ failure the audit found on clean machines.
|
||||
3. **No CUDA download.** `onnxruntime-node` downloads CUDA libraries on every Linux x64
|
||||
install unless `ONNXRUNTIME_NODE_INSTALL_CUDA=skip` is set. The installer script sets it;
|
||||
the embedding and reranking models run on CPU.
|
||||
4. **No sqlite-vec.** mem0 keeps its own vector store in SQLite and needs no extension. The
|
||||
package leaves with the legacy memory engine; the root `sqlite-vec-windows-x64`
|
||||
dependency is already gone.
|
||||
4. **No sqlite-vec.** mem0 keeps its own vector store in SQLite and needs no extension. It
|
||||
left with the legacy memory engine: the launcher no longer depends on it, the desktop
|
||||
build no longer copies `vec0` and the installer checks plain SQLite.
|
||||
5. **Local models on Linux.** The managed Ollama runtime now has pinned Linux x64 and arm64
|
||||
artifacts (`ollama-linux-*.tar.zst`, SHA-256 and size from the Ollama release).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user