Skip to content

Commit 8b63ead

Browse files
authored
Merge pull request #12 from triggerdotdev/docs/intent-install-copy
docs: clarify that intent install is agent-facing
2 parents 61bdf00 + 6b72313 commit 8b63ead

9 files changed

Lines changed: 42 additions & 56 deletions

File tree

.changeset/fix-docs-urls.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"agentcrumbs": patch
3+
---
4+
5+
Fix docs URLs from docs.agentcrumbs.dev to agentcrumbs.dev/docs

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,15 @@ Service C ──┘ (fire & forget) └── ~/.agentcrumbs/crum
1414

1515
```bash
1616
npm install agentcrumbs
17-
npx @tanstack/intent install
1817
```
1918

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."**
2120

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.
2522

2623
## Agent skills
2724

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.
2926

3027
| Skill | What it teaches |
3128
| --- | --- |
@@ -87,7 +84,7 @@ The only cost is the function call itself, which V8 will likely inline after war
8784

8885
## API overview
8986

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).
9188

9289
| Method | Purpose |
9390
| --- | --- |
@@ -103,7 +100,7 @@ All methods are documented in detail at [docs.agentcrumbs.dev/api](https://docs.
103100

104101
## Crumb markers
105102

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.
107104

108105
## Environment variable
109106

@@ -154,7 +151,7 @@ Time units: `s` (seconds), `m` (minutes), `h` (hours), `d` (days).
154151

155152
## Multi-service architecture
156153

157-
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.
158155

159156
## Cross-language compatibility
160157

@@ -174,7 +171,7 @@ Verified compatible with **Node.js 18+** and **Bun**.
174171

175172
## Docs
176173

177-
Full documentation at [docs.agentcrumbs.dev](https://docs.agentcrumbs.dev).
174+
Full documentation at [agentcrumbs.dev/docs](https://agentcrumbs.dev/docs).
178175

179176
## License
180177

docs/content/docs/index.mdx

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,20 +31,17 @@ Service C ──┘ (fire & forget) └── ~/.agentcrumbs/crum
3131
- **Strip before merge.** `agentcrumbs strip` removes all `// @crumbs` lines and `#region @crumbs` blocks. Clean diffs, no debug code on main.
3232
- **HTTP collector.** `agentcrumbs collect` receives crumbs from all services via fire-and-forget HTTP. Tail, query, and replay from the CLI.
3333
- **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.
3535

3636
## Install
3737

3838
```bash
3939
npm install agentcrumbs
40-
npx @tanstack/intent install
4140
```
4241

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."**
4443

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.
4845

4946
## How it works
5047

docs/content/docs/quickstart.mdx

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,18 @@ description: "Install agentcrumbs and set up your agent in 2 minutes"
99
npm install agentcrumbs
1010
```
1111

12-
## Wire the skills
12+
## Set up skills
1313

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:
2315

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."
2517
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:
2719

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
2922

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.
3124

3225
## Manual setup
3326

docs/content/docs/skills.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Agent skills"
33
description: "How agents learn to use agentcrumbs via @tanstack/intent"
44
---
55

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.
77

88
Skills travel with the package version. The agent always has docs matching the installed code, not stale training data from 6 months ago.
99

@@ -13,10 +13,9 @@ The fastest way to set up agentcrumbs in a project is to let the agent do it:
1313

1414
```bash
1515
npm install agentcrumbs
16-
npx @tanstack/intent install
1716
```
1817

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:
2019

2120
> "Run the agentcrumbs/init skill to set up debug tracing in this project."
2221
@@ -76,4 +75,4 @@ node_modules/agentcrumbs/skills/agentcrumbs/SKILL.md
7675
node_modules/agentcrumbs/skills/agentcrumbs/init/SKILL.md
7776
```
7877

79-
Or add a reference in your agent config file manually. But `npx @tanstack/intent install` handles all of this automatically.
78+
Or add a reference in your agent config file manually. But telling your agent to run `npx @tanstack/intent install` handles all of this automatically.

docs/src/app/home.css

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,17 @@
7575

7676
/* INSTALL */
7777
.hp-install-section { padding: 32px 0 64px; }
78-
.hp-install-steps { display: flex; flex-direction: column; gap: 12px; max-width: 520px; margin: 0 auto; }
78+
.hp-install-steps { display: flex; flex-direction: column; gap: 12px; max-width: 600px; margin: 0 auto; }
7979
.hp-install-step { display: flex; align-items: center; gap: 12px; }
8080
.hp-install-step-num { font-family: var(--hp-mono); font-size: 12px; color: var(--hp-accent); width: 20px; text-align: center; flex-shrink: 0; }
8181
.hp-install-step-text { font-family: var(--hp-mono); font-size: 14px; color: var(--hp-text-dim); padding: 14px 0; }
82-
.hp-install-bar { display: flex; align-items: center; background: var(--hp-bg-raised); border: 1px solid var(--hp-border-bright); border-radius: 8px; padding: 14px 20px; gap: 16px; font-family: var(--hp-mono); font-size: 15px; transition: border-color 0.15s; }
82+
.hp-install-bar { display: flex; align-items: center; background: var(--hp-bg-raised); border: 1px solid var(--hp-border-bright); border-radius: 8px; padding: 14px 20px; gap: 12px; font-family: var(--hp-mono); font-size: 15px; transition: border-color 0.15s; flex: 1; }
8383
.hp-install-bar:hover { border-color: #333; }
84-
.hp-prompt-sign { color: var(--hp-accent); user-select: none; }
84+
.hp-prompt-sign { color: var(--hp-accent); user-select: none; width: 44px; text-align: right; flex-shrink: 0; }
8585
.hp-install-bar code { color: var(--hp-text); white-space: nowrap; background: transparent !important; padding: 0 !important; font-size: inherit; }
86+
.hp-install-bar-agent { font-size: 14px; }
87+
.hp-install-bar-agent code { white-space: normal; color: var(--hp-text-dim); }
88+
.hp-agent-label { color: var(--hp-accent); user-select: none; font-size: 12px; text-transform: uppercase; letter-spacing: 0.05em; width: 44px; text-align: right; flex-shrink: 0; }
8689
.hp-copy-btn { background: none; border: 1px solid var(--hp-border-bright); border-radius: 4px; color: var(--hp-text-dim); font-family: var(--hp-mono); font-size: 12px; padding: 4px 10px; cursor: pointer; transition: all 0.15s; white-space: nowrap; }
8790
.hp-copy-btn:hover { color: var(--hp-text); border-color: #444; }
8891

docs/src/app/page.tsx

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -155,16 +155,11 @@ export default function HomePage() {
155155
</div>
156156
<div className="hp-install-step">
157157
<div className="hp-install-step-num">2</div>
158-
<div className="hp-install-bar">
159-
<span className="hp-prompt-sign">$</span>
160-
<code id="intent-cmd">npx @tanstack/intent install</code>
161-
<button className="hp-copy-btn" onClick={(e) => copyCmd('intent-cmd', e.currentTarget)}>copy</button>
158+
<div className="hp-install-bar hp-install-bar-agent">
159+
<span className="hp-agent-label">agent</span>
160+
<code>Run npx @tanstack/intent install, then run the agentcrumbs/init skill</code>
162161
</div>
163162
</div>
164-
<div className="hp-install-step">
165-
<div className="hp-install-step-num">3</div>
166-
<div className="hp-install-step-text">Tell your agent: <span style={{ color: 'var(--hp-text)' }}>&quot;Run the agentcrumbs/init skill&quot;</span></div>
167-
</div>
168163
</div>
169164
</div>
170165
</section>

packages/agentcrumbs/README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,15 @@ Service C ──┘ (fire & forget) └── ~/.agentcrumbs/crum
1414

1515
```bash
1616
npm install agentcrumbs
17-
npx @tanstack/intent install
1817
```
1918

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."**
2120

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.
2522

2623
## Agent skills
2724

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.
2926

3027
| Skill | What it teaches |
3128
| --- | --- |
@@ -87,7 +84,7 @@ The only cost is the function call itself, which V8 will likely inline after war
8784

8885
## API overview
8986

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).
9188

9289
| Method | Purpose |
9390
| --- | --- |
@@ -103,7 +100,7 @@ All methods are documented in detail at [docs.agentcrumbs.dev/api](https://docs.
103100

104101
## Crumb markers
105102

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.
107104

108105
## Environment variable
109106

@@ -154,7 +151,7 @@ Time units: `s` (seconds), `m` (minutes), `h` (hours), `d` (days).
154151

155152
## Multi-service architecture
156153

157-
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.
158155

159156
## Cross-language compatibility
160157

@@ -174,7 +171,7 @@ Verified compatible with **Node.js 18+** and **Bun**.
174171

175172
## Docs
176173

177-
Full documentation at [docs.agentcrumbs.dev](https://docs.agentcrumbs.dev).
174+
Full documentation at [agentcrumbs.dev/docs](https://agentcrumbs.dev/docs).
178175

179176
## License
180177

packages/agentcrumbs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
"intent": {
3838
"version": 1,
3939
"repo": "triggerdotdev/agentcrumbs",
40-
"docs": "https://docs.agentcrumbs.dev"
40+
"docs": "https://agentcrumbs.dev/docs"
4141
},
4242
"scripts": {
4343
"build": "tsc",

0 commit comments

Comments
 (0)