Updated
AGENTS.md · TanStack Start

AGENTS.md and CLAUDE.md examples for TanStack Start

Of 38 actively developed open-source products built with TanStack Start, 32 (84%) keep instruction files for coding agents: AGENTS.md in 29, CLAUDE.md in 17. The typical file is 969 words, and most cover pointers to other docs (83%) and commands to build, run and test (73%).

Real files to read

From the best-known open-source TanStack Start products whose file is a real one (not a pointer to another), 200 to 4,000 words, covering at least three of the usual topics and naming TanStack Start. Each opens on GitHub.

ProjectFileStarsWordsCovers
openclaw/clawhubAGENTS.md9,5361,152CommandsTestingDoc pointersStructureCode styleGit
latitude-dev/latitude-llmAGENTS.md4,7381,892CommandsTestingDoc pointersCode style
haydenbleasel/files-sdkAGENTS.md1,6042,477CommandsTestingDoc pointersStructureCode styleGit
elmohq/elmoAGENTS.md5051,027CommandsTestingGit
bex-co/beancount-ioAGENTS.md3182,122CommandsDoc pointersGit
felipebarcelospro/igniter-jsAGENTS.md2403,426CommandsTestingDoc pointersStructureCode styleGit

What TanStack Start projects put in them

Share of the 30 files that cover each topic, against all 731 files we read.

Pointers to other docs83% vs 69%
Commands to build, run and test73% vs 79%
Testing70% vs 67%
Project structure47% vs 57%
Code style43% vs 49%
Git, commits and pull requests43% vs 46%

How they talk to the agent: 83% say “never” or “do not” somewhere (all files: 80%), 23% shout a rule in capitals like IMPORTANT or MUST (23%), and 37% tell it to ask before some changes (20%).

The tools they name

Package managerspnpm (10 files), bun (10 files), npm (3 files)

Tests and lintersVitest (10), ESLint (5), Biome (5), Playwright (4), Prettier (4), pytest (1)

Named more than in files generallyVitest (10), Bun (9), Cloudflare (6), PostgreSQL (6), Anything (5), Biome (5), Changesets (5), Make (5)

What they tell the agent

Instructions that recur across files, in our words; open one for the TanStack Start projects whose file says it.

About Vitest

  • Run Vitest non-interactively with run or --run, never in watch mode, especially in automation.1 files

About Bun

  • Use Bun for installs and scripts (bun install, bun run, bunx); don't use npm, pnpm, or yarn.1 files
  • Tests run on Bun's built-in runner (bun:test), with caveats about module mocks, timeouts, and per-package runs.1 files
  • Repo is a Bun workspaces monorepo, often orchestrated with Turborepo.1 files

About Cloudflare

About PostgreSQL

About Biome

  • Code style such as indentation, quotes, and semicolons is dictated by the Biome config, so follow it.1 files
  • Run Biome through package scripts such as lint, format, check, or fix, optionally with auto-fix.1 files

About Changesets

  • Do not bump versions or publish by hand; releases go through Changesets and CI, usually via a version PR.2 files
  • Add a changeset file with the changeset command to every PR that changes published packages, and commit it.1 files

A starting AGENTS.md for TanStack Start

The sections these files cover most, the package manager and checks TanStack Start projects name most, and the stack TanStack Start makers' products chose most often. Fill in the <placeholders>.

# AGENTS.md

<What this product does and who it is for, in a sentence or two.>

## Stack

- Frontend Framework: TanStack Start

## Commands

- Install: `pnpm install`
- Run locally: `<command>`
- Test: `pnpm exec vitest run`
- End-to-end tests: `pnpm exec playwright test`
- Lint: `pnpm exec eslint .`

## Testing

Run `pnpm exec vitest run` and `pnpm exec playwright test` before calling a change done, and add a test with each fix or feature.

## Project structure

- `<folder>/`: <what lives there>
- More in <docs/…>

## Conventions

- <Naming, patterns and style the code does not show>
- Commits and pull requests: <your rules>

## Boundaries

- Ask before: <changes you want to approve first>
- Never: <files or actions that are off-limits>

<!-- Started from https://howmakersbuild.com/agents-md/tanstack-start — point CLAUDE.md here with a line: @AGENTS.md -->
  • pnpm: named in 10 of 30 instruction files from open-source projects built with TanStack Start.
  • Vitest: named in 10 of 30 instruction files from open-source projects built with TanStack Start.
  • Playwright: named in 4 of 30 instruction files from open-source projects built with TanStack Start.
  • ESLint: named in 5 of 30 instruction files from open-source projects built with TanStack Start.

Make one for your own stack →

Questions

What should an AGENTS.md for a TanStack Start project include?

In 30 files from open-source TanStack Start products: pointers to other docs (83%), commands to build, run and test (73%), testing (70%), project structure (47%), code style (43%), git, commits and pull requests (43%). The package manager they name most is pnpm (10 files).

AGENTS.md or CLAUDE.md?

Among these TanStack Start products, 29 keep an AGENTS.md and 17 a CLAUDE.md. Across every product we checked, 354 keep both, and in 189 of those the CLAUDE.md only points to the AGENTS.md (a symlink or a line like @AGENTS.md), so there's one file to maintain. Codex, Cursor, Copilot and others read AGENTS.md; Claude Code reads CLAUDE.md.

How long is a typical TanStack Start AGENTS.md?

The median is 969 words in these 30 files; across all 731 files we read, half are between 444 and 1,727 words.

How this is counted: the GitHub repos of open-source products built with TanStack Start, pushed to in the 180 days before 2026-10-28. We read each repo's AGENTS.md, CLAUDE.md and other agent files; what's published here is counts and links, not their text. All files, by the numbers.