Skip to content

Commit ac92769

Browse files
committed
docs update
1 parent 723ec4d commit ac92769

2 files changed

Lines changed: 20 additions & 7 deletions

File tree

docs/getting-started/quick-start-consumers.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ The install command guides your agent through the setup process:
1313
npx @tanstack/intent@latest install
1414
```
1515

16+
Examples use `npx` for npm projects. In pnpm, Yarn, or Bun projects, use the matching runner: `pnpm dlx`, `yarn dlx`, or `bunx`.
17+
1618
This creates or updates an `intent-skills` guidance block. It:
1719

1820
1. Checks for existing `intent-skills` guidance in your config files (`AGENTS.md`, `CLAUDE.md`, `.cursorrules`, etc.)
@@ -30,13 +32,15 @@ Intent creates guidance like:
3032
## Skill Loading
3133

3234
Before substantial work:
33-
- Skill check: run `npx @tanstack/intent@latest list`, or use skills already listed in context.
34-
- Skill guidance: if one local skill clearly matches the task, run `npx @tanstack/intent@latest load <package>#<skill>` and follow the returned `SKILL.md`.
35+
- Skill check: run `pnpm dlx @tanstack/intent@latest list`, or use skills already listed in context.
36+
- Skill guidance: if one local skill clearly matches the task, run `pnpm dlx @tanstack/intent@latest load <package>#<skill>` and follow the returned `SKILL.md`.
3537
- Monorepos: when working across packages, run the skill check from the workspace root and prefer the local skill for the package being changed.
3638
- Multiple matches: prefer the most specific local skill for the package or concern you are changing; load additional skills only when the task spans multiple packages or concerns.
3739
<!-- intent-skills:end -->
3840
```
3941

42+
Intent detects the package manager when generating this block, so the runner may be `npx`, `pnpm dlx`, `yarn dlx`, or `bunx`.
43+
4044
## 2. Use skills in your workflow
4145

4246
When your agent works on a task that matches an available skill, it loads the matching `SKILL.md` into context.

docs/overview.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,20 @@ Intent provides tooling for two workflows:
2424

2525
## How it works
2626

27-
### Discovery and installation
28-
29-
```bash
30-
npx @tanstack/intent@latest list
31-
```
27+
### Discovery and installation
28+
29+
Examples use `npx` for npm projects. In pnpm, Yarn, or Bun projects, use the matching runner:
30+
31+
| Tool | Pattern |
32+
| ---- | -------------------------------------------- |
33+
| npm | `npx @tanstack/intent@latest <command>` |
34+
| pnpm | `pnpm dlx @tanstack/intent@latest <command>` |
35+
| Yarn | `yarn dlx @tanstack/intent@latest <command>` |
36+
| Bun | `bunx @tanstack/intent@latest <command>` |
37+
38+
```bash
39+
npx @tanstack/intent@latest list
40+
```
3241

3342
Scans the current project's installed dependencies for intent-enabled packages, including `node_modules`, workspace dependencies, and Yarn PnP projects without `node_modules`.
3443
Global package scanning is explicit; pass `--global` to include global packages or `--global-only` to ignore local packages.

0 commit comments

Comments
 (0)