Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

@tanstack/db-playbook

A playbook of skills for AI agents building with TanStack DB.

What is a Playbook?

A playbook is the collection of skills, patterns, and tools someone uses in a vibe-coding context — analogous to "stack" but for the less deliberate, more aesthetic-driven way people assemble their setup now.

This package provides structured documentation designed for AI coding assistants (Claude Code, Cursor, Copilot, etc.) to help them build TanStack DB applications effectively.

Skills are distilled, task-focused patterns that agents can quickly consume and apply — unlike large documentation that often exceeds context limits.

Installation

npm install @tanstack/db-playbook

CLI Usage

# List all available skills
npx @tanstack/db-playbook list

# Show a specific skill
npx @tanstack/db-playbook show tanstack-db
npx @tanstack/db-playbook show tanstack-db/live-queries
npx @tanstack/db-playbook show tanstack-db/mutations

Skills Structure

Skill Purpose
tanstack-db Router/entry point with routing table
tanstack-db/live-queries Reactive queries, joins, aggregations
tanstack-db/mutations Optimistic updates, transactions, paced mutations
tanstack-db/collections QueryCollection, ElectricCollection, sync modes
tanstack-db/schemas Validation, transformations, TInput/TOutput
tanstack-db/electric ElectricSQL integration, txid matching

Each skill includes:

  • SKILL.md - Common patterns and routing table
  • references/ - Deep-dive documentation for specialized topics

For AI Agents

Point your agent to the skills directory or use the CLI to fetch specific skills:

# Get the main routing skill
npx @tanstack/db-playbook show tanstack-db

# Get specific domain skills
npx @tanstack/db-playbook show tanstack-db/live-queries

The router skill (tanstack-db) contains a routing table that helps agents find the right sub-skill for any task.

Learn More