Search the site

GETTING STARTED

APP

DATA

BACKEND

OPERATIONS

SHIPPING

REFERENCE

REFERENCE

Coding agents

Every coding agent you open the project in gets the same rules, from one generated block.

dartvel dev keeps that block matched to the Dartvel version you have installed, and never touches the text around it.

ON THIS PAGE

What gets written

The block, and what it will not touch

Matched to your version

Your own rules, and the project's own reference

Status

What gets written

dartvel create my_app     # writes the agent files
dartvel init              # same, for a project you already had
dartvel dev               # refreshes them

Copy code to clipboard

One file per tool, so no agent is left guessing:

AGENTS.md

Read by: Codex, OpenCode, Devin, ChatGPT, and anything that reads AGENTS.md

CLAUDE.md

Read by: Claude Code

GEMINI.md

Read by: Gemini CLI

.cursor/rules/dartvel.mdc

Read by: Cursor, with alwaysApply

.cursorrules

Read by: Cursor's project rules file

.windsurfrules

Read by: Windsurf

.clinerules

Read by: Cline

.kiro/steering/dartvel.md

Read by: Kiro

.github/copilot-instructions.md

Read by: GitHub Copilot and ChatGPT in a repository

CONVENTIONS.md

Read by: aider, and tools that read a conventions file

AGENT.md

Read by: agents that read the singular name

.aider.conf.yml

Read by: aider, told which files to read

Codex, OpenCode and Devin get no file of their own

They read AGENTS.md from the project root. Four more copies would be four more files that can disagree, so AGENTS.md says which tools it serves instead.

The block, and what it will not touch

<!-- dartvel:begin agents -->
... the rules, the version, where to read more
<!-- dartvel:end agents -->

Copy code to clipboard

Everything inside the markers is Dartvel's and is replaced on a refresh.

Everything outside them is yours. A rule you wrote above the block is still there after the next dartvel dev.

A file that had no block gains one below its existing text, so a CLAUDE.md you wrote before Dartvel is not overwritten.

A file you deleted by hand comes back, because create set the agent up.

Nothing is printed when a refresh changed nothing. A line on every start is a line people learn to ignore.

A refresh happens on every dartvel dev, whichever mode it runs in. A command whose arguments it rejects writes nothing at all.

Matched to your version

The block names the Dartvel you are running and points at the documentation shipped with that exact version, so an agent reads the API as this version has it. The newest website describes whatever version is newest.

When the documentation is not beside the installed package, the block says so and names dartvel docs instead. It never prints a path that does not exist.

dartvel upgrade --plan
dartvel dev

Copy code to clipboard

After an upgrade, the next dartvel dev refreshes the block. Nothing else to run.

Your own rules, and the project's own reference

Put the house rules outside the block, at the top of AGENTS.md. They survive every refresh.

dartvel docs builds a reference from this project's graph: its routes, data models, backend functions, jobs, policies and modules. It is more accurate than anything written for every project, because it is about this one.

dartvel mcp serves the same graph to a coding agent, read-only.

Status

Partial

Spec section: Coding Agent Documentation

Planned work and implementation limits

Per-module SKILL.md generation is planned; project architecture reference documents are already generated by create and dev.

No SKILL.md files shipped per module, and no dartvel agent skills sync.

No dartvel agent command: nothing starts the app, screenshots it or stops it.

No llms.txt or llms-full.txt for web builds.

The block points at one rules document. It does not enumerate the project's own pages, models or API.

FSL-1.1-MIT licensed. Built with Dartvel.

Dartvel is made by

To the bottom