moving
This commit is contained in:
75
README.md
75
README.md
@@ -1,6 +1,58 @@
|
||||
# Waggle OS
|
||||
|
||||
Workspace-native AI agent platform with persistent memory, model-agnostic orchestration, and skill-extensible capabilities. It ships as a Tauri 2.0 desktop binary (Windows/macOS) with a Vite-bundled web app and a Node.js sidecar.
|
||||
Workspace-native AI agent platform with persistent memory, model-agnostic orchestration, and skill-extensible capabilities. The current desktop release scope is Windows-first: a Tauri 2.0 app with a Vite-bundled web UI and bundled Node.js sidecar; macOS packaging and certification remain roadmap work.
|
||||
|
||||
## Current Release Scope
|
||||
|
||||
The active launch gate is **Windows Solo**. Its in-scope external-agent release cohort is **Claude Code, Codex, and Hermes**. Each tool uses the user's own installation and authentication; Waggle does not redistribute provider credentials or bypass provider terms.
|
||||
|
||||
- **Cursor and OpenClaw are roadmap integrations.** They remain registered for detection and future development, but the production launcher, hooks, Fleet/task path, and direct run API do not offer them.
|
||||
- Claude Desktop, Codex Desktop, and Hermes Desktop may appear as detected convenience launch surfaces; they are not separate memory-hook or agent-acceptance targets in this release gate.
|
||||
- **ChatGPT/OpenAI is a model and memory-import surface**, not a separate local coding-agent launcher.
|
||||
- The Windows Solo launch contract requires an exact-revision Windows installer qualification receipt to prove its bundled Node sidecar, no-Python OpenAI-compatible proxy, Waggle-managed local runtime/model, default in-process embedding path, and freedom from developer Node, Docker, Python, an external LiteLLM service, or a separately installed Ollama. A separate revision-bound router receipt must prove the smart-router primary, compact-tool-context, budget, and fallback paths. Router, persona, and authentication receipts may cover a later candidate only through an independently reviewed bounded no-impact attestation proving that no covered runtime surface changed; otherwise they must be rerun. A user-installed Ollama remains optional.
|
||||
- Docker/LiteLLM deployment files remain optional server and team deployment choices; they are not desktop prerequisites.
|
||||
|
||||
Release status, revision-bound receipts, and any bounded carry-forward attestations are governed only by the current [launch recommendation](docs/production-readiness/09-LAUNCH_RECOMMENDATION.md). If it does not say **GO**, do not describe Waggle as production-ready or reuse historical scores or receipts as current release evidence.
|
||||
|
||||
### Current Windows Solo internal RC evidence — 2026-08-27
|
||||
|
||||
The current runtime candidate is private `main` commit
|
||||
`23ad3fa5f99bddce648b84750a41365299aeb0da`. Its internal-pilot NSIS installer
|
||||
(102,923,936 bytes; SHA-256
|
||||
`7BFA9F9B13633A51CD3336B42E3EF904B7F7A568C6DEE4F6CED967CBD4F40A59`)
|
||||
passed **64/64** clean-profile checks. The receipt proves bundled sidecar and offline
|
||||
npm, FREE/Solo first boot, in-process embeddings, the Waggle-managed local runtime and
|
||||
`qwen2.5:0.5b`, local-model chat, proxy restart, repair, relaunch, data preservation,
|
||||
Exit/cleanup, and uninstall. Docker, Python, developer Node.js, external LiteLLM, and a
|
||||
separately installed Ollama were not prerequisites.
|
||||
|
||||
- Private PR #66 merged as `23ad3fa5` after every blocking check passed: primary CI,
|
||||
Playwright smoke and full E2E, Windows and both macOS Tauri verification targets, and
|
||||
Hive Mind install/smoke on Windows, Ubuntu, and macOS. The tested PR head and merged
|
||||
source have the same tree.
|
||||
- Exact-current full and production dependency audits contain **0 Critical and 0 High**
|
||||
findings. Lower-severity maintenance remains documented.
|
||||
- The historical persona collection at `4c712ff6` still records all ten personas x3 at
|
||||
or above 95/100 after documented independent adjudication, but it is not relabeled as
|
||||
an exact-current seal. PR #66 changed memory behavior, so public release qualification
|
||||
requires a fresh receipt or an explicit bounded semantic-impact attestation.
|
||||
- Smart-router primary, compact-tool-context, durable-budget and fallback evidence, plus
|
||||
the Claude Code, Codex, and Hermes official-user-auth canaries, remain historical
|
||||
scoped evidence. No later change touched provider credential handling; the auth
|
||||
harness read or copied no credential files.
|
||||
- The curated Hive Mind mirror is hardened through private-to-maintainer PR #53, merged
|
||||
on public `master` as `3410327800db3ea23f875d547a0c7f4d08826b7e`; Windows, macOS,
|
||||
Ubuntu, and Ubuntu first-run smoke were green. The immutable drift baseline still
|
||||
reports reviewed release blockers, so the next OSS package release remains a separate
|
||||
maintainer-curated operation and is not implied by this Windows Solo RC.
|
||||
|
||||
Detailed local receipt paths, hashes, limitations, and integration gates are recorded in
|
||||
the current [launch recommendation](docs/production-readiness/09-LAUNCH_RECOMMENDATION.md).
|
||||
The internal signer (`CN=Egzakta Internal Pilot`) and DigiCert timestamp prove the pilot
|
||||
pipeline but are not publicly trusted Authenticode. Public release is **not yet approved**:
|
||||
a protected hosted build with a publicly trusted signer, an exact-candidate sealed
|
||||
managed Deep Security report, current persona qualification, and either fresh or
|
||||
explicitly attested smart-router and official-auth qualification remain mandatory.
|
||||
|
||||
## Architecture
|
||||
|
||||
@@ -57,12 +109,21 @@ The monorepo has **28 packages** under `packages/`. They split into two groups.
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Self-host in one line (Linux / macOS)
|
||||
### Windows Solo desktop
|
||||
|
||||
Use only the signed Windows installer and SHA-256 identified by a **GO** [launch recommendation](docs/production-readiness/09-LAUNCH_RECOMMENDATION.md). If that recommendation is not GO, no packaged desktop artifact is release-approved; use the source-development instructions below.
|
||||
|
||||
### Self-host from the private repository (Linux / macOS)
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/marolinik/waggle-os/main/install.sh | bash
|
||||
gh repo clone marolinik/waggle-os
|
||||
cd waggle-os
|
||||
bash install.sh
|
||||
```
|
||||
|
||||
This path is for maintainers with authenticated access to the private repository.
|
||||
Do not publish an anonymous raw-file installer until the source/licensing decision is explicit.
|
||||
|
||||
Best for a VPS or homelab — this runs a headless Waggle server (no desktop shell):
|
||||
|
||||
- **Checks prerequisites, clones, builds, and starts** the Node.js sidecar, then prints the URL (`http://127.0.0.1:3333`). A 5-question wizard — install dir, port, data dir, build web UI, start now — is all Enter-defaulted; pass `--yes` to accept every default non-interactively.
|
||||
@@ -74,7 +135,7 @@ Manage the running server with the installed wrapper: `scripts/waggle-server.sh
|
||||
### Run from source (development)
|
||||
|
||||
```bash
|
||||
# Prerequisites: Node.js >= 20, npm
|
||||
# Prerequisites: Node.js ^20.19.0 or >=22.12.0, npm
|
||||
npm install
|
||||
|
||||
# (Optional) copy the env template. Provider API keys are normally set in-app
|
||||
@@ -91,6 +152,10 @@ npm run dev:web
|
||||
# Open http://localhost:8080
|
||||
```
|
||||
|
||||
The source tree follows the root `package.json` Node engine above. The packaged
|
||||
Windows Solo desktop carries its own pinned Node.js 22.23.2 runtime, so an
|
||||
installed user does not need a separate Node.js installation.
|
||||
|
||||
`npm run dev:server` runs the Fastify sidecar via `tsx` (equivalent to
|
||||
`cd packages/server && npx tsx src/local/start.ts`). `npm run dev:web` runs the
|
||||
Vite dev server for `apps/web`.
|
||||
@@ -115,7 +180,7 @@ run. See [`.env.example`](./.env.example) for the full contract.
|
||||
| `ANTHROPIC_API_KEY` | Recommended | Claude API key. Optional in `.env` — can be set in-app instead (vault). |
|
||||
| `OPENAI_API_KEY` | No | Enables OpenAI models and optional OpenAI embeddings. |
|
||||
| `EMBEDDING_PROVIDER` | No | `auto` (default) · `inprocess` · `ollama` · `voyage` · `openai` · `mock`. `auto` tries in-process → Ollama → API → mock. |
|
||||
| `LITELLM_BASE_URL` | No | LiteLLM proxy URL for multi-model routing (default `http://localhost:4000`). |
|
||||
| `LITELLM_BASE_URL` | No | Optional external LiteLLM-compatible proxy URL. The Windows Solo desktop uses its bundled no-Python proxy unless explicitly configured otherwise. |
|
||||
| `DATABASE_URL` | Team only | PostgreSQL connection string. |
|
||||
| `REDIS_URL` | Team only | Redis for the background job queue. |
|
||||
|
||||
|
||||
Reference in New Issue
Block a user