Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/add-playbook-library-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/playbooks': patch
---

Add `playbook-library` end-user CLI for library consumers. Libraries wire it up via a generated shim (`playbook setup --shim`) to expose a `playbook` bin. Running `playbook list` recursively discovers skills across the library's dependency tree; `playbook install` prints an agent-driven prompt to map skills to project tasks in CLAUDE.md.
34 changes: 17 additions & 17 deletions .changeset/config.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"$schema": "https://unpkg.com/@changesets/config@3.1.2/schema.json",
"changelog": [
"@svitejs/changesets-changelog-github-compact",
{ "repo": "TanStack/playbooks" }
],
"commit": false,
"access": "public",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"fixed": [],
"linked": [],
"ignore": [],
"___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
"onlyUpdatePeerDependentsWhenOutOfRange": true
}
}
{
"$schema": "https://unpkg.com/@changesets/config@3.1.2/schema.json",
"changelog": [
"@svitejs/changesets-changelog-github-compact",
{ "repo": "TanStack/playbooks" }
],
"commit": false,
"access": "public",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"fixed": [],
"linked": [],
"ignore": [],
"___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
"onlyUpdatePeerDependentsWhenOutOfRange": true
}
}
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.github
**/.nx/
**/.nx/cache
**/.svelte-kit
Expand Down
132 changes: 66 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,66 @@
# @tanstack/playbooks
Ship compositional knowledge for AI coding agents alongside your npm packages.
Playbooks are npm packages of skills — encoding how tools work together, what patterns apply for which goals, and what to avoid. Skills travel with the tool via `npm update`, not the model's training cutoff.
`@tanstack/playbooks` is the toolkit for generating, discovering, and maintaining skills for your library.
## Install
```bash
pnpm add -D @tanstack/playbooks
```
## Quick Start
### For library consumers
Set up playbook discovery in your project's agent config files (CLAUDE.md, .cursorrules, etc.):
```bash
npx playbook init
```
List available skills from installed packages:
```bash
npx playbook list
```
### For library maintainers
Generate skills for your library using the guided scaffold workflow:
```bash
npx playbook scaffold
```
Validate your skill files:
```bash
npx playbook validate
```
Copy CI and Oz workflow templates into your repo:
```bash
npx playbook setup
```
## CLI Commands
| Command | Description |
|---------|-------------|
| `playbook init` | Inject playbook discovery into agent config files |
| `playbook list [--json]` | Discover playbook-enabled packages |
| `playbook meta` | List meta-skills for library maintainers |
| `playbook scaffold` | Print the guided skill generation prompt |
| `playbook validate [dir]` | Validate SKILL.md files |
| `playbook setup` | Copy CI/Oz workflow templates |
| `playbook stale [--json]` | Check skills for version drift |
| `playbook feedback` | Submit skill feedback |
## License
[MIT](./LICENSE)
# @tanstack/playbooks

Ship compositional knowledge for AI coding agents alongside your npm packages.

Playbooks are npm packages of skills — encoding how tools work together, what patterns apply for which goals, and what to avoid. Skills travel with the tool via `npm update`, not the model's training cutoff.

`@tanstack/playbooks` is the toolkit for generating, discovering, and maintaining skills for your library.

## Install

```bash
pnpm add -D @tanstack/playbooks
```

## Quick Start

### For library consumers

Set up playbook discovery in your project's agent config files (CLAUDE.md, .cursorrules, etc.):

```bash
npx playbook init
```

List available skills from installed packages:

```bash
npx playbook list
```

### For library maintainers

Generate skills for your library using the guided scaffold workflow:

```bash
npx playbook scaffold
```

Validate your skill files:

```bash
npx playbook validate
```

Copy CI and Oz workflow templates into your repo:

```bash
npx playbook setup
```

## CLI Commands

| Command | Description |
| ------------------------- | ------------------------------------------------- |
| `playbook init` | Inject playbook discovery into agent config files |
| `playbook list [--json]` | Discover playbook-enabled packages |
| `playbook meta` | List meta-skills for library maintainers |
| `playbook scaffold` | Print the guided skill generation prompt |
| `playbook validate [dir]` | Validate SKILL.md files |
| `playbook setup` | Copy CI/Oz workflow templates |
| `playbook stale [--json]` | Check skills for version drift |
| `playbook feedback` | Submit skill feedback |

## License

[MIT](./LICENSE)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"lint:fix:all": "nx run-many --targets=lint --fix",
"test": "pnpm run test:ci",
"test:ci": "nx run-many --targets=test:eslint,test:sherif,test:knip,test:docs,test:lib,test:types,build",
"generate-docs": "node scripts/generate-docs.ts",
"test:docs": "node scripts/verify-links.ts",
"test:eslint": "nx affected --target=test:eslint --exclude=examples/**",
"test:knip": "knip",
Expand Down Expand Up @@ -63,7 +64,6 @@
},
"overrides": {},
"dependencies": {
"-": "^0.0.1",
"@tanstack/typedoc-config": "^0.3.3"
}
}
132 changes: 66 additions & 66 deletions packages/playbooks/README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,66 @@
# @tanstack/playbooks
Ship compositional knowledge for AI coding agents alongside your npm packages.
Playbooks are npm packages of skills — encoding how tools work together, what patterns apply for which goals, and what to avoid. Skills travel with the tool via `npm update`, not the model's training cutoff.
`@tanstack/playbooks` is the toolkit for generating, discovering, and maintaining skills for your library.
## Install
```bash
pnpm add -D @tanstack/playbooks
```
## Quick Start
### For library consumers
Set up playbook discovery in your project's agent config files (CLAUDE.md, .cursorrules, etc.):
```bash
npx playbook init
```
List available skills from installed packages:
```bash
npx playbook list
```
### For library maintainers
Generate skills for your library using the guided scaffold workflow:
```bash
npx playbook scaffold
```
Validate your skill files:
```bash
npx playbook validate
```
Copy CI and Oz workflow templates into your repo:
```bash
npx playbook setup
```
## CLI Commands
| Command | Description |
|---------|-------------|
| `playbook init` | Inject playbook discovery into agent config files |
| `playbook list [--json]` | Discover playbook-enabled packages |
| `playbook meta` | List meta-skills for library maintainers |
| `playbook scaffold` | Print the guided skill generation prompt |
| `playbook validate [dir]` | Validate SKILL.md files |
| `playbook setup` | Copy CI/Oz workflow templates |
| `playbook stale [--json]` | Check skills for version drift |
| `playbook feedback` | Submit skill feedback |
## License
[MIT](./LICENSE)
# @tanstack/playbooks

Ship compositional knowledge for AI coding agents alongside your npm packages.

Playbooks are npm packages of skills — encoding how tools work together, what patterns apply for which goals, and what to avoid. Skills travel with the tool via `npm update`, not the model's training cutoff.

`@tanstack/playbooks` is the toolkit for generating, discovering, and maintaining skills for your library.

## Install

```bash
pnpm add -D @tanstack/playbooks
```

## Quick Start

### For library consumers

Set up playbook discovery in your project's agent config files (CLAUDE.md, .cursorrules, etc.):

```bash
npx playbook init
```

List available skills from installed packages:

```bash
npx playbook list
```

### For library maintainers

Generate skills for your library using the guided scaffold workflow:

```bash
npx playbook scaffold
```

Validate your skill files:

```bash
npx playbook validate
```

Copy CI and Oz workflow templates into your repo:

```bash
npx playbook setup
```

## CLI Commands

| Command | Description |
| ------------------------- | ------------------------------------------------- |
| `playbook init` | Inject playbook discovery into agent config files |
| `playbook list [--json]` | Discover playbook-enabled packages |
| `playbook meta` | List meta-skills for library maintainers |
| `playbook scaffold` | Print the guided skill generation prompt |
| `playbook validate [dir]` | Validate SKILL.md files |
| `playbook setup` | Copy CI/Oz workflow templates |
| `playbook stale [--json]` | Check skills for version drift |
| `playbook feedback` | Submit skill feedback |

## License

[MIT](./LICENSE)
Loading
Loading