agentleFS
Sign inStart free
statelyaistatelyai/xstate/AGENTS.md

xstate

AGENTS.md30k starsChanged 21 months agoMITView on GitHub

This is a monorepo containing XState, @xstate/store, and related packages.

Trending

Less talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 0 mentionsMar 2026: 1 mentionApr 2026: 1 mentionMay 2026: 0 mentionsJun 2026: 2 mentionsJul 2026: 8 mentionsAug 2026: 1 mentionSep 2026: 4 mentionsOct 2026: 4 mentionsNov 2026: 1 mention
Dec 2025Jun 2026Nov 2026
Mentions a month of the statelyai/xstate repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about statelyai/xstate

The biggest 5 of 68 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 68

Talked about on GitHub, YouTube, Hacker News, Bluesky and Stack Overflow (68 times).

On GitHub · 38

33 more on GitHub

On YouTube · 24

19 more on YouTube

On Hacker News · 2

On Bluesky · 2

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,843 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repositoryOne other file it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

8 rules. About 0 are common, 1 is distinctive, and 7 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 7

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use pnpm to install dependencies

    line 5
  2. Very specific:

    Run pnpm test to run the tests in all packages, only for changes that affect mulitple packages.

    line 9
  3. Very specific:

    Run pnpm test:core to only run core XState tests.

    line 10
  4. Very specific:

    Run pnpm test:store to only run @xstate/store tests.

    line 11
  5. Very specific:

    Run pnpm lint and pnpm format:check to check linting and formatting.

    line 12
  6. Very specific:

    Run pnpm typecheck to make sure that there are no type errors.

    line 13
  7. Very specific:

    Before making a PR, run pnpm changeset to create a changeset with a short description of the changes, and a code example if applicable.

    line 14
  8. Very specific:

    When generated code reads an invoked actor's onDone.event.output, use s.createInvoke({ src, onDone }) or register the source in setup({ …

    line 20

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

This is a monorepo containing XState, @xstate/store, and related packages.

Dev environment

  • Use pnpm to install dependencies

PR instructions

  • Run pnpm test to run the tests in all packages, only for changes that affect mulitple packages.
  • Run pnpm test:core to only run core XState tests.
  • Run pnpm test:store to only run @xstate/store tests.
  • Run pnpm lint and pnpm format:check to check linting and formatting.
  • Run pnpm typecheck to make sure that there are no type errors.
  • Before making a PR, run pnpm changeset to create a changeset with a short description of the changes, and a code example if applicable. Do not include implementation details; only pertinent details for developers using the package.
  • For every new feature or behavior change, audit the relevant docs and READMEs and fix missing or inaccurate guidance in the same PR.

XState v6 (alpha)

  • v6 alpha syntax differs from v5 — do not assume v5 patterns (e.g. { onDone: { actions } } invoke config is wrong in v6). Verify against the current types/source in packages/core before writing machine configs.
  • When generated code reads an invoked actor's onDone.event.output, use s.createInvoke({ src, onDone }) or register the source in setup({ actors }). A bare inline invoke cannot correlate the source with its output and may require narrowing. See docs/invoke.md.
  • In Vue examples that hold a machine in reactive state, use shallowRef(machine) or markRaw(machine), especially before restoreActor(machine, persisted). See packages/xstate-vue/docs/input-and-snapshots.md.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free