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: clarify yaad is a library embedded in hawk, not a standalone binary
Rewrites the README to reflect that yaad ships no CLI — it is the
memory engine consumed by hawk. Adds Library API section, adjusts
gitignore for bin/ dist/ build artifacts.
Now your agent remembers everything — across sessions, across models, across projects.
36
-
37
-
---
38
-
39
-
## 30-Second Setup
40
-
41
-
```bash
42
-
# Install
43
-
go install github.com/GrayCodeAI/yaad/cmd/yaad@latest
44
-
45
-
# Add to your project
46
-
cd your-project && yaad init
47
-
48
-
# Connect your agent (generates .mcp.json + hooks)
49
-
yaad setup
50
-
```
51
-
52
-
**That's it.** Your agent now has persistent, graph-native memory.
29
+
Yaad is the **memory engine** behind the [`hawk`](https://github.com/GrayCodeAI/hawk)
30
+
coding agent. Run `hawk` and your agent gets persistent, graph-native memory — across
31
+
sessions, across models, across projects — with no separate install or daemon to manage.
32
+
33
+
> **Yaad is a Go library, not a standalone binary.** It ships no `yaad` command of its
34
+
> own; its memory features are surfaced through the host agent (hawk). To embed Yaad in
35
+
> your own Go program, import it directly:
36
+
>
37
+
> ```go
38
+
> import (
39
+
> yaad "github.com/GrayCodeAI/yaad/engine"
40
+
> "github.com/GrayCodeAI/yaad/storage"
41
+
> )
42
+
> ```
53
43
54
44
---
55
45
@@ -240,7 +230,7 @@ Zep-style `valid_at` / `invalid_at` intervals on edges let recall filter to fact
240
230
<details>
241
231
<summary><b>Versions & Rollback</b></summary>
242
232
243
-
Every edit is versioned. Inspect history with `yaad versions <node-id>`and restore a prior state with `yaad rollback <node-id> <version>` — the rollback itself is recorded as a new version.
233
+
Every edit is versioned. The engine can list a node's version history and restore a prior state — the rollback itself is recorded as a new version.
244
234
</details>
245
235
246
236
<details>
@@ -269,9 +259,10 @@ Detects topic boundaries in a session to segment memories into coherent units be
269
259
270
260
---
271
261
272
-
## MCP Tools (23 tools)
262
+
## Memory Tools (23 tools)
273
263
274
-
Your agent gets these tools automatically via `yaad mcp`:
264
+
When Yaad is embedded in a host agent (such as hawk), it exposes these operations to the
265
+
agent. Yaad implements the logic; the host surfaces them (e.g. as MCP tools):
275
266
276
267
| Tool | What it does |
277
268
|---|---|
@@ -318,34 +309,35 @@ Your agent gets these tools automatically via `yaad mcp`:
0 commit comments