TanStack Query Docs And Library Metadata
Use this skill to collect authoritative context before code generation or integration selection.
Setup
npx @tanstack/cli libraries --json
Core Patterns
Resolve valid library ids before doc fetch
npx @tanstack/cli libraries --json
Fetch a specific docs page with explicit version
# Syntax: tanstack doc <library-id> <path> [--docs-version <version>]
npx @tanstack/cli doc router framework/react/guide/routing
npx @tanstack/cli doc router framework/react/guide/routing --docs-version latest
Search docs for implementation targets
npx @tanstack/cli search-docs "server functions" --library start --json
Common Mistakes
HIGH Use invalid library id/version/path for doc fetch
Wrong:
# Wrong: --library and --version are not flags on doc; path must not include /docs/ prefix
npx @tanstack/cli doc --library router --version latest --path /docs/framework/react/guide/routing
Correct:
# Step 1: resolve a valid library id
npx @tanstack/cli libraries --json
# Step 2: fetch using positional args — library id then doc path (no /docs/ prefix)
npx @tanstack/cli doc router framework/react/guide/routing
doc takes <library> and <path> as positional arguments (not flags), and the path must not include a leading /docs/ segment. Use --docs-version (not --version) to pin a specific version.
Source: packages/cli/src/cli.ts:746
MEDIUM Rely on deprecated create alias for discovery
Wrong:
npx create-tsrouter-app --list-add-ons
Correct:
npx @tanstack/cli create --list-add-ons --json
Legacy alias workflows can produce confusing outputs that do not match current CLI discovery behavior. Fixed in newer versions, but agents trained on older examples may still generate this pattern.
Source: https://github.com/TanStack/cli/issues/93
HIGH Tension: Single-command convenience vs integration precision
This domain's patterns conflict with create-app-scaffold and choose-ecosystem-integrations. Skipping discovery to run one-shot scaffold commands tends to lock in plausible defaults that miss architecture constraints.
See also: create-app-scaffold/SKILL.md § Common Mistakes
References
- Discovery command output schemas