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
Copy file name to clipboardExpand all lines: README.md
+7-10Lines changed: 7 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,18 +14,15 @@ Service C ──┘ (fire & forget) └── ~/.agentcrumbs/crum
14
14
15
15
```bash
16
16
npm install agentcrumbs
17
-
npx @tanstack/intent install
18
17
```
19
18
20
-
Then tell your agent: **"Run the agentcrumbs/init skill."**
19
+
Then tell your agent: **"Run `npx @tanstack/intent@latest install` to set up agentcrumbs skills, then run the agentcrumbs/init skill."**
21
20
22
-
The init skill scans your repo, discovers services and modules, and builds a **namespace catalog** that gets written to your agent config (CLAUDE.md, .cursorrules, etc.). Without the catalog, every agent invents its own namespace names: `auth`, `auth-service`, `authService`, `authentication`, all pointing at the same thing. The catalog locks it down. Every agent, every session, same names.
23
-
24
-
After init, the agent knows which namespaces to use and how to drop crumbs correctly.
21
+
The agent will wire the skills into your agent config (CLAUDE.md, .cursorrules, etc.), then scan your repo to build a namespace catalog so all agents use consistent names.
25
22
26
23
## Agent skills
27
24
28
-
agentcrumbs ships with [@tanstack/intent](https://tanstack.com/blog/from-docs-to-agents) skills inside the npm package. Running `npx @tanstack/intent install` wires them into your agent config so the agent learns correct usage patterns, common mistakes to avoid, and the namespace catalog for your project.
25
+
agentcrumbs ships with [@tanstack/intent](https://tanstack.com/blog/from-docs-to-agents) skills inside the npm package. When your agent runs `npx @tanstack/intent install`, it sets up skill-to-task mappings in your agent config so it knows when to load agentcrumbs patterns.
29
26
30
27
| Skill | What it teaches |
31
28
| --- | --- |
@@ -87,7 +84,7 @@ The only cost is the function call itself, which V8 will likely inline after war
87
84
88
85
## API overview
89
86
90
-
All methods are documented in detail at [docs.agentcrumbs.dev/api](https://docs.agentcrumbs.dev/api).
87
+
All methods are documented in detail at [agentcrumbs.dev/docs/api](https://agentcrumbs.dev/docs/api).
91
88
92
89
| Method | Purpose |
93
90
| --- | --- |
@@ -103,7 +100,7 @@ All methods are documented in detail at [docs.agentcrumbs.dev/api](https://docs.
103
100
104
101
## Crumb markers
105
102
106
-
Mark crumb lines with `// @crumbs` (single line) or `// #region @crumbs` / `// #endregion @crumbs` (block) so they can be stripped before merge. See the [markers docs](https://docs.agentcrumbs.dev/markers) for details and examples.
103
+
Mark crumb lines with `// @crumbs` (single line) or `// #region @crumbs` / `// #endregion @crumbs` (block) so they can be stripped before merge. See the [markers docs](https://agentcrumbs.dev/docs/markers) for details and examples.
All services write to the same collector. `agentcrumbs tail` shows interleaved output with namespace-colored labels. See the [multi-service docs](https://docs.agentcrumbs.dev/multi-service) for setup patterns.
154
+
All services write to the same collector. `agentcrumbs tail` shows interleaved output with namespace-colored labels. See the [multi-service docs](https://agentcrumbs.dev/docs/multi-service) for setup patterns.
158
155
159
156
## Cross-language compatibility
160
157
@@ -174,7 +171,7 @@ Verified compatible with **Node.js 18+** and **Bun**.
174
171
175
172
## Docs
176
173
177
-
Full documentation at [docs.agentcrumbs.dev](https://docs.agentcrumbs.dev).
174
+
Full documentation at [agentcrumbs.dev/docs](https://agentcrumbs.dev/docs).
Copy file name to clipboardExpand all lines: docs/content/docs/index.mdx
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,20 +31,17 @@ Service C ──┘ (fire & forget) └── ~/.agentcrumbs/crum
31
31
-**Strip before merge.**`agentcrumbs strip` removes all `// @crumbs` lines and `#region @crumbs` blocks. Clean diffs, no debug code on main.
32
32
-**HTTP collector.**`agentcrumbs collect` receives crumbs from all services via fire-and-forget HTTP. Tail, query, and replay from the CLI.
33
33
-**Works with any agent.** Claude Code, Cursor, Copilot, Aider, custom agents. If the agent can write code, it can write crumbs.
34
-
-**Ships with agent skills.** Built on [@tanstack/intent](https://tanstack.com/blog/from-docs-to-agents). Install the package, run `npx @tanstack/intent install`, and the agent learns how to use crumbs from the package itself. No stale training data.
34
+
-**Ships with agent skills.** Built on [@tanstack/intent](https://tanstack.com/blog/from-docs-to-agents). Install the package, tell your agent to run `npx @tanstack/intent install`, and it learns how to use crumbs from the package itself. No stale training data.
35
35
36
36
## Install
37
37
38
38
```bash
39
39
npm install agentcrumbs
40
-
npx @tanstack/intent install
41
40
```
42
41
43
-
Then tell your agent: **"Run the agentcrumbs/init skill."**
42
+
Then tell your agent: **"Run `npx @tanstack/intent@latest install` to set up agentcrumbs skills, then run the agentcrumbs/init skill."**
44
43
45
-
This is the critical step. The [init skill](/skills#the-init-skill) scans your repo, discovers services and modules, and builds a namespace catalog that gets written to your agent config (CLAUDE.md, .cursorrules, etc.). Without the catalog, every agent invents its own namespace names. With it, every agent, every session, same names.
46
-
47
-
See the [quickstart](/quickstart) for the full setup.
44
+
The agent wires skills into your agent config (CLAUDE.md, .cursorrules, etc.) and scans your repo to build a namespace catalog. See the [quickstart](/quickstart) for the full setup.
Copy file name to clipboardExpand all lines: docs/content/docs/quickstart.mdx
+7-14Lines changed: 7 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,25 +9,18 @@ description: "Install agentcrumbs and set up your agent in 2 minutes"
9
9
npm install agentcrumbs
10
10
```
11
11
12
-
## Wire the skills
12
+
## Set up skills
13
13
14
-
```bash
15
-
npx @tanstack/intent install
16
-
```
17
-
18
-
This pulls agentcrumbs' [@tanstack/intent](https://tanstack.com/blog/from-docs-to-agents) skills into your agent config (CLAUDE.md, .cursorrules, etc.).
19
-
20
-
## Run the init skill
21
-
22
-
This is the most important step. Tell your agent:
14
+
Tell your agent:
23
15
24
-
> "Run the agentcrumbs/init skill to set up debug tracing in this project."
16
+
> "Run `npx @tanstack/intent@latest install` to set up agentcrumbs skills, then run the agentcrumbs/init skill."
25
17
26
-
The agent scans your repo, discovers services and modules, and proposes a **namespace catalog**: a table of every service name and what it maps to. You confirm or adjust, and the agent writes it to your config file.
18
+
The agent will:
27
19
28
-
Why this matters: without the catalog, every agent invents its own names. One session uses `auth`, another uses `auth-service`, another uses `authentication`. Crumbs become impossible to query across sessions. The catalog locks down the names so every agent, every time, uses the same ones.
20
+
1. Run `npx @tanstack/intent install` which gives it a prompt to wire skill-to-task mappings into your agent config (CLAUDE.md, .cursorrules, etc.)
21
+
2. Run the [init skill](/skills#the-init-skill) to scan your repo, discover services and modules, and write a namespace catalog to your config
29
22
30
-
After init, the agent knows which namespaces to use and how to drop crumbs correctly. See [Skills](/skills#the-init-skill) for the full details.
23
+
The namespace catalog is a table of service names your agents should use. It keeps naming consistent across sessions. See [Skills](/skills#the-init-skill) for details.
Copy file name to clipboardExpand all lines: docs/content/docs/skills.mdx
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: "Agent skills"
3
3
description: "How agents learn to use agentcrumbs via @tanstack/intent"
4
4
---
5
5
6
-
agentcrumbs ships with agent skills inside the npm package, built on the [@tanstack/intent](https://tanstack.com/blog/from-docs-to-agents) standard. When you install the package and run `npx @tanstack/intent install`, your agent automatically learns how to use crumbs correctly.
6
+
agentcrumbs ships with agent skills inside the npm package, built on the [@tanstack/intent](https://tanstack.com/blog/from-docs-to-agents) standard. Tell your agent to run `npx @tanstack/intent install` and it will set up skill-to-task mappings in your agent config so it knows when to load agentcrumbs patterns.
7
7
8
8
Skills travel with the package version. The agent always has docs matching the installed code, not stale training data from 6 months ago.
9
9
@@ -13,10 +13,9 @@ The fastest way to set up agentcrumbs in a project is to let the agent do it:
13
13
14
14
```bash
15
15
npm install agentcrumbs
16
-
npx @tanstack/intent install
17
16
```
18
17
19
-
This scans `node_modules` for intent-enabled packages and wires the skills into your agent config file (CLAUDE.md, .cursorrules, etc.). Then tell your agent:
18
+
Then tell your agent:
20
19
21
20
> "Run the agentcrumbs/init skill to set up debug tracing in this project."
Copy file name to clipboardExpand all lines: packages/agentcrumbs/README.md
+7-10Lines changed: 7 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,18 +14,15 @@ Service C ──┘ (fire & forget) └── ~/.agentcrumbs/crum
14
14
15
15
```bash
16
16
npm install agentcrumbs
17
-
npx @tanstack/intent install
18
17
```
19
18
20
-
Then tell your agent: **"Run the agentcrumbs/init skill."**
19
+
Then tell your agent: **"Run `npx @tanstack/intent@latest install` to set up agentcrumbs skills, then run the agentcrumbs/init skill."**
21
20
22
-
The init skill scans your repo, discovers services and modules, and builds a **namespace catalog** that gets written to your agent config (CLAUDE.md, .cursorrules, etc.). Without the catalog, every agent invents its own namespace names: `auth`, `auth-service`, `authService`, `authentication`, all pointing at the same thing. The catalog locks it down. Every agent, every session, same names.
23
-
24
-
After init, the agent knows which namespaces to use and how to drop crumbs correctly.
21
+
The agent will wire the skills into your agent config (CLAUDE.md, .cursorrules, etc.), then scan your repo to build a namespace catalog so all agents use consistent names.
25
22
26
23
## Agent skills
27
24
28
-
agentcrumbs ships with [@tanstack/intent](https://tanstack.com/blog/from-docs-to-agents) skills inside the npm package. Running `npx @tanstack/intent install` wires them into your agent config so the agent learns correct usage patterns, common mistakes to avoid, and the namespace catalog for your project.
25
+
agentcrumbs ships with [@tanstack/intent](https://tanstack.com/blog/from-docs-to-agents) skills inside the npm package. When your agent runs `npx @tanstack/intent install`, it sets up skill-to-task mappings in your agent config so it knows when to load agentcrumbs patterns.
29
26
30
27
| Skill | What it teaches |
31
28
| --- | --- |
@@ -87,7 +84,7 @@ The only cost is the function call itself, which V8 will likely inline after war
87
84
88
85
## API overview
89
86
90
-
All methods are documented in detail at [docs.agentcrumbs.dev/api](https://docs.agentcrumbs.dev/api).
87
+
All methods are documented in detail at [agentcrumbs.dev/docs/api](https://agentcrumbs.dev/docs/api).
91
88
92
89
| Method | Purpose |
93
90
| --- | --- |
@@ -103,7 +100,7 @@ All methods are documented in detail at [docs.agentcrumbs.dev/api](https://docs.
103
100
104
101
## Crumb markers
105
102
106
-
Mark crumb lines with `// @crumbs` (single line) or `// #region @crumbs` / `// #endregion @crumbs` (block) so they can be stripped before merge. See the [markers docs](https://docs.agentcrumbs.dev/markers) for details and examples.
103
+
Mark crumb lines with `// @crumbs` (single line) or `// #region @crumbs` / `// #endregion @crumbs` (block) so they can be stripped before merge. See the [markers docs](https://agentcrumbs.dev/docs/markers) for details and examples.
All services write to the same collector. `agentcrumbs tail` shows interleaved output with namespace-colored labels. See the [multi-service docs](https://docs.agentcrumbs.dev/multi-service) for setup patterns.
154
+
All services write to the same collector. `agentcrumbs tail` shows interleaved output with namespace-colored labels. See the [multi-service docs](https://agentcrumbs.dev/docs/multi-service) for setup patterns.
158
155
159
156
## Cross-language compatibility
160
157
@@ -174,7 +171,7 @@ Verified compatible with **Node.js 18+** and **Bun**.
174
171
175
172
## Docs
176
173
177
-
Full documentation at [docs.agentcrumbs.dev](https://docs.agentcrumbs.dev).
174
+
Full documentation at [agentcrumbs.dev/docs](https://agentcrumbs.dev/docs).
0 commit comments