Back to Electric

AGENTS.md

website/docs/agents.md

latest1.3 KB
Original Source

AGENTS.md

Load our AGENTS.md{target="_self"} file to use Electric with AI coding agents.

Using Electric with coding agents

Electric provides an AGENTS.md at https://electric-sql.com/AGENTS.md{target="_self"}.

AGENTS.md is a simple open format for guiding coding agents. It contains instructions for AI coding agents, formatted in a way they can easily digest.

Your coding agent or AI code editor may automatically read AGENTS.md. Or you can tell it to do so in your prompt, for example:

sh
claude "Read AGENTS.md. Build an app with Electric and TanStack DB."

File contents

Copy our AGENTS.md{target="_self"} file to the root of your repo or package. Edit it and / or combine with your other project-specific instructions, as you see fit.

<<< @/../AGENTS.md

More information

See the AGENTS.md website for more information. You may also be interested in our blog posts on: