@statewavedev/statewave 0.4.7 → 0.4.8
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 +61 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# @statewavedev/statewave
|
|
2
|
+
|
|
3
|
+
Production-grade memory layer for AI agents — one command to install, configure, and run.
|
|
4
|
+
|
|
5
|
+
> `npx @statewavedev/statewave` is the fastest way to get Statewave running locally. It boots the API, admin console, and database via Docker Compose, wires MCP into your coding assistants, and seeds your repo — self-hosted, offline, no account required.
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx @statewavedev/statewave
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
That's it. The quickstart:
|
|
14
|
+
|
|
15
|
+
1. Detects your MCP clients (Claude Code, Claude Desktop, Cursor, VS Code Copilot, Codex CLI, and more)
|
|
16
|
+
2. Starts the Statewave stack via Docker Compose (API on `:8100`, admin on `:8080`)
|
|
17
|
+
3. Optionally connects an LLM provider for richer memory compilation
|
|
18
|
+
4. Seeds the current repo into memory
|
|
19
|
+
|
|
20
|
+
**Tear down:**
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npx @statewavedev/statewave --down
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
**Point at an existing server:**
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npx @statewavedev/statewave --statewave-url http://your-server:8100
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
All flags are forwarded to the underlying [`@statewavedev/connectors-cli`](https://www.npmjs.com/package/@statewavedev/connectors-cli) `quickstart` command.
|
|
33
|
+
|
|
34
|
+
## What Statewave is
|
|
35
|
+
|
|
36
|
+
Statewave is a memory backend for AI agents with governance built in from day one:
|
|
37
|
+
|
|
38
|
+
- **Sensitivity labels** — classify memories at ingest; enforce in retrieval
|
|
39
|
+
- **Declarative policies** — define what can be stored, accessed, and for how long
|
|
40
|
+
- **Tamper-evident audit receipts** — every write produces a verifiable provenance record
|
|
41
|
+
- **Multi-tenant isolation** — subjects are fully isolated at the storage layer
|
|
42
|
+
- **GDPR erasure** — delete a subject and its compiled memories in one call
|
|
43
|
+
- **State-assembly receipts** — every context response traces to its source episodes
|
|
44
|
+
|
|
45
|
+
Memory is not just retrieval. Statewave ships the governance layer most teams build too late.
|
|
46
|
+
|
|
47
|
+
## Requirements
|
|
48
|
+
|
|
49
|
+
- Node.js ≥ 20
|
|
50
|
+
- Docker (for the quickstart stack)
|
|
51
|
+
|
|
52
|
+
## Links
|
|
53
|
+
|
|
54
|
+
- [statewave.ai](https://statewave.ai)
|
|
55
|
+
- [Documentation](https://github.com/smaramwbc/statewave-docs)
|
|
56
|
+
- [GitHub](https://github.com/smaramwbc/statewave)
|
|
57
|
+
- [Release notes](https://github.com/smaramwbc/statewave-connectors/blob/main/RELEASE_NOTES.md)
|
|
58
|
+
|
|
59
|
+
## License
|
|
60
|
+
|
|
61
|
+
Apache-2.0
|