@vectorize-io/self-driving-agents 0.0.6 → 0.0.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.
Files changed (6) hide show
  1. package/README.md +108 -32
  2. package/dist/cli.js +614 -26
  3. package/dist/tests/cli.test.d.ts +1 -0
  4. package/dist/tests/cli.test.js +529 -0
  5. package/package.json +6 -7
  6. /package/{skill → dist/skill}/SKILL.md +0 -0
package/README.md CHANGED
@@ -1,52 +1,128 @@
1
- # @vectorize-io/self-driving-agents
1
+ # Self-Driving Agents
2
2
 
3
- Install self-driving agents with portable memory on any harness.
3
+ Agents that learn from every conversation and get better over time.
4
+
5
+ No retraining, no manual updates — just use them and they improve. Powered by [Hindsight](https://github.com/vectorize-io/hindsight), so agent memory is portable across harnesses.
6
+
7
+ 📖 **Docs:** <https://vectorize-io.github.io/self-driving-agents/>
8
+
9
+ ## Quick start
10
+
11
+ ### Claude Chat / Cowork
4
12
 
5
13
  ```bash
6
- npx @vectorize-io/self-driving-agents install ./my-agent --harness openclaw
14
+ npx @vectorize-io/self-driving-agents install marketing/seo --harness claude
7
15
  ```
8
16
 
9
- ## What it does
17
+ The CLI prompts for your Hindsight connection (Cloud or self-hosted), creates a skill zip, and tells you how to upload it. Then type `/<agent-name>` in any conversation to activate the agent.
10
18
 
11
- 1. Reads `bank-template.json` from the agent directory (knowledge pages, missions, directives)
12
- 2. Reads `content/` directory for reference docs to ingest
13
- 3. Resolves the Hindsight bank from the harness config
14
- 4. Imports the template and ingests content
15
- 5. Creates the harness agent, installs the skill, patches startup
19
+ ### OpenClaw
16
20
 
17
- ## Agent directory layout
21
+ ```bash
22
+ npx @vectorize-io/self-driving-agents install marketing/seo --harness openclaw
23
+ ```
24
+
25
+ ### NemoClaw
18
26
 
27
+ ```bash
28
+ npx @vectorize-io/self-driving-agents install marketing/seo --harness nemoclaw
19
29
  ```
20
- my-agent/
21
- bank-template.json # optional: bank config + knowledge pages
22
- content/ # optional: reference docs (.md, .txt, .html, etc.)
30
+
31
+ That's it. The CLI fetches the agent from this repo, sets up its memory bank, ingests the seed knowledge, and registers it with your harness. Follow the on-screen instructions to start chatting.
32
+
33
+ You can also point at a local directory or any GitHub repo:
34
+
35
+ ```bash
36
+ npx @vectorize-io/self-driving-agents install ./my-agent --harness claude
37
+ npx @vectorize-io/self-driving-agents install my-org/my-repo/my-agent --harness openclaw
23
38
  ```
24
39
 
25
- Agent name defaults to the directory name. Override with `--agent <name>`.
40
+ ## How it works
41
+
42
+ 1. You chat with the agent
43
+ 2. Conversations are automatically retained into memory
44
+ 3. The agent builds knowledge pages that update themselves after each conversation
45
+ 4. Next session, the agent reads its updated pages — it remembers what works and what you prefer
46
+
47
+ You never tell it to "save" or "remember." It decides what matters and keeps itself current.
48
+
49
+ ## Available agents
50
+
51
+ ### [marketing/](marketing/)
52
+
53
+ Full marketing team — install the whole department or pick a specialty.
26
54
 
27
- ## Options
55
+ | Install | What you get |
56
+ |---------|-------------|
57
+ | `marketing` | Generalist — all 30 agent knowledge files across every specialty |
58
+ | `marketing/seo` | SEO specialist, search optimizer, citation strategist |
59
+ | `marketing/social-media` | Platform strategists for TikTok, Instagram, LinkedIn, X, Reddit |
60
+ | `marketing/content` | Content creator, growth hacker, book co-author |
61
+ | `marketing/ecommerce` | Cross-border commerce, livestream selling |
62
+ | `marketing/china-market` | WeChat, Douyin, Xiaohongshu, Baidu, Bilibili |
63
+
64
+ ## Create your own
65
+
66
+ An agent is just a directory:
28
67
 
29
68
  ```
30
- npx @vectorize-io/self-driving-agents install <dir> --harness <harness> [options]
69
+ my-agent/
70
+ bank-template.json # optional — configures memory bank and knowledge pages
71
+ seo-playbook.md # any .md/.txt files become seed knowledge
72
+ advanced-tips.md
73
+ ```
74
+
75
+ Nest directories for multi-level agents:
31
76
 
32
- --harness <h> Required. openclaw | hermes | claude-code
33
- --agent <name> Agent name (defaults to directory name)
34
- --api-url <url> Override Hindsight API URL
35
- --api-token <t> Override API token
77
+ ```
78
+ my-team/
79
+ bank-template.json # install my-team → everything below
80
+ specialist-a/
81
+ bank-template.json # install my-team/specialist-a → just this
82
+ reference.md
83
+ specialist-b/
84
+ bank-template.json
85
+ guide.md
36
86
  ```
37
87
 
38
- ## Example
88
+ Content files are discovered recursively. Each level can have its own `bank-template.json` with a tailored mission and knowledge pages.
39
89
 
40
- ```bash
41
- # Clone an agent repo
42
- git clone https://github.com/vectorize-io/self-driving-agents
43
- cd self-driving-agents
90
+ ## What `install` does
44
91
 
45
- # Install the SEO blog writer
46
- npx @vectorize-io/self-driving-agents install ./marketing-seo-blog-posts --harness openclaw
92
+ The CLI is a single setup command — no manual steps required. Here's what happens:
47
93
 
48
- # Create and start the agent
49
- openclaw agents add marketing-seo-blog-posts --workspace ~/.hindsight-agents/openclaw/marketing-seo-blog-posts --non-interactive
50
- openclaw gateway restart
51
- openclaw tui --session agent:marketing-seo-blog-posts:main:session1
52
- ```
94
+ 1. **Fetches the agent** — downloads the directory from GitHub (or uses a local path)
95
+ 2. **Configures connection** — prompts for Hindsight Cloud or self-hosted API URL and token
96
+ 3. **Connects to Hindsight** and imports the `bank-template.json` (memory bank config, knowledge pages, directives)
97
+ 4. **Ingests all content files** (`.md`, `.txt`, etc.) found recursively as seed knowledge
98
+ 5. **Generates the agent** — creates a skill (Claude) or workspace (OpenClaw/NemoClaw) with the knowledge tools baked in
99
+
100
+ ### Claude harness
101
+
102
+ For Claude Chat and Cowork, the CLI generates a self-contained skill zip:
103
+
104
+ - The agent's Hindsight API URL, bank ID, and token are baked directly into the skill
105
+ - No external dependencies — uses `curl` to call the Hindsight REST API
106
+ - The skill instructs Claude to load knowledge pages at startup, retain user feedback during conversations, and manage pages
107
+ - Upload the zip via **Customize → Skills → Upload** in Claude Chat or Cowork
108
+ - After upload, allowlist the API host in **Settings → Capabilities**
109
+ - Type `/<agent-name>` in any conversation to activate
110
+
111
+ ### OpenClaw / NemoClaw harness
112
+
113
+ For OpenClaw and NemoClaw, the CLI installs the Hindsight plugin, creates a workspace, and registers the agent with the harness. Restart the gateway and start chatting.
114
+
115
+ ## Supported harnesses
116
+
117
+ | Harness | Flag | Status |
118
+ |---------|------|--------|
119
+ | [Claude Chat](https://claude.ai) | `--harness claude` | Supported |
120
+ | [Claude Cowork](https://claude.ai) | `--harness claude` | Supported |
121
+ | [OpenClaw](https://openclaw.dev) | `--harness openclaw` | Supported |
122
+ | [NemoClaw](https://github.com/NVIDIA/NeMo-Agent) | `--harness nemoclaw` | Supported |
123
+
124
+ ## Requirements
125
+
126
+ - A supported harness
127
+ - A Hindsight account ([Cloud](https://hindsight.vectorize.io) or self-hosted)
128
+ - Everything else is handled by the CLI