FLUTTER AGENTS.MD

A cross-platform Flutter app written in Dart. The rules keep widgets small and const where possible, keep state management consistent, and make flutter analyze and the test suite the definition of done.

Zero retention: everything you type stays in this browser. Verify it yourself in DevTools.
AGENTS.mdFor Codex, Cursor, Copilot, Jules, Windsurf and more
# AGENTS.md

Project: flutter_app. A cross-platform Flutter app in Dart for iOS and Android.

This file is the single source of truth for every coding agent working in this repository. The tool-specific files (CLAUDE.md, GEMINI.md, .github/copilot-instructions.md and .cursor/rules/project.mdc) point here. Edit this file, not those.

## Stack

- Language: Dart
- Framework: Flutter
- Database: Firebase / Firestore
- Hosting: App Store and Google Play
- Tests: flutter test
- Package manager: pub (Dart)

## Commands

Run these from the repository root.

- Install dependencies: `flutter pub get`
- Run locally: `flutter run`
- Build: `flutter build apk --debug`
- Run all tests: `flutter test`
- Run one test file: `flutter test test/widgets/cart_test.dart`
- Lint: `flutter analyze`
- Format: `dart format .`

## Project layout

- `lib/`: Application code
- `lib/features/`: Feature folders: screens, widgets, state
- `lib/core/`: Shared services, theme and routing
- `test/`: Unit and widget tests
- `pubspec.yaml`: Dependencies and assets

## Code style

- Indent with 2 spaces. Never tabs.
- Match the style and patterns of the surrounding code, even where you would personally choose differently.
- Prefer small pure functions and immutable data; keep side effects at the edges (handlers, jobs, I/O modules).
- Never swallow an error. Handle it where you can act on it, or rethrow it with context about what failed.
- Every new UI control works with a keyboard, has a visible focus state and an accessible name.

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Do not hand-edit generated files or lockfiles; change the source and regenerate.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.

## Product constraints

- Design and test every screen at phone width first, then scale up.

## Project-specific notes

- `flutter analyze` must report no issues, and code must be `dart format` clean.
- Use `const` constructors wherever possible.
- Split a widget when its `build` method grows beyond what fits on one screen; prefer small `StatelessWidget` classes over helper methods that return widgets.
- Use the state management approach the project already uses everywhere; do not introduce a second one.
- Never use `BuildContext` across an `await` without checking `context.mounted` first.
- Do not edit generated files (`*.g.dart`, `*.freezed.dart`); run `dart run build_runner build --delete-conflicting-outputs`.
- Add dependencies with `flutter pub add <pkg>` and ask before adding any.

## Project phase

This project is in active development. Follow the patterns that already exist; consistency beats novelty.
CLAUDE.mdFor Claude Code
# CLAUDE.md

@AGENTS.md

## Claude Code

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file, so every agent stays in sync.
- Put Claude-only preferences below this line. Personal, uncommitted notes belong in CLAUDE.local.md.
GEMINI.mdFor Gemini CLI
# GEMINI.md

@./AGENTS.md

## Gemini CLI

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file.
- Alternative: delete this file and set "context": { "fileName": ["AGENTS.md"] } in .gemini/settings.json so Gemini CLI reads AGENTS.md directly.
.github/copilot-instructions.mdFor GitHub Copilot
# Copilot instructions

Project: flutter_app. A cross-platform Flutter app in Dart for iOS and Android.

The full instructions are in AGENTS.md at the repository root. Read it before you change code; if anything here disagrees with it, AGENTS.md wins. The essentials are repeated below for Copilot surfaces that only read this file.

## Stack

- Language: Dart
- Framework: Flutter
- Database: Firebase / Firestore
- Hosting: App Store and Google Play
- Tests: flutter test
- Package manager: pub (Dart)

## Commands

- Install dependencies: `flutter pub get`
- Run locally: `flutter run`
- Build: `flutter build apk --debug`
- Run all tests: `flutter test`
- Run one test file: `flutter test test/widgets/cart_test.dart`
- Lint: `flutter analyze`
- Format: `dart format .`

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Do not hand-edit generated files or lockfiles; change the source and regenerate.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.
.cursor/rules/project.mdcFor Cursor
---
description: Project instructions for every task (mirrors AGENTS.md)
globs:
alwaysApply: true
---

# Project rules

The project instructions live in @AGENTS.md at the repository root, which Cursor loads automatically. They are not repeated here, so they cost context only once. Edit AGENTS.md, not this rule.

Before you change code, check the Commands and Working rules sections of AGENTS.md, and run its test and lint commands before you say a task is done.

Put Cursor-only rules below, or add scoped rules as more .mdc files with `globs` (for example `src/components/**/*.tsx`).

These are the exact files the generator writes for this preset. Change any command or rule in the generator and download your own set.

About the Flutter preset

What Is in the Flutter AGENTS.md?

The preset describes a a cross-platform Flutter app in Dart for iOS and Android. Its AGENTS.md is 49 non-empty lines with 7 exact commands, 5 key directories, and 7 stack-specific rules on top of the shared working rules.

  • Commands: flutter pub get, flutter run, flutter build apk --debug, flutter test, flutter test test/widgets/cart_test.dart, flutter analyze, dart format ..
  • Layout: lib/, lib/features/, lib/core/, test/, pubspec.yaml.
  • Wrappers: CLAUDE.md and GEMINI.md import AGENTS.md; the Copilot file repeats the essentials; the Cursor rule points to AGENTS.md.

Why These Rules for Flutter?

Widget methods versus widget classes

Agents extract parts of a build method into helper functions returning widgets. Separate widget classes rebuild independently and can be const, which matters for performance and readability.

Context after await

Using BuildContext after an async gap can reference a widget that has been disposed, causing crashes. The analyzer flags it and agents often suppress the lint.

One state management library

Flutter has many options. Agents pick whichever their examples used, and a codebase can end up with three. Naming the rule keeps the app consistent.

Generated code

Code generation output is overwritten on every build_runner run, so manual fixes do not survive.

Which Stack Rules Does the File Add?

  • flutter analyze must report no issues, and code must be dart format clean.
  • Use const constructors wherever possible.
  • Split a widget when its build method grows beyond what fits on one screen; prefer small StatelessWidget classes over helper methods that return widgets.
  • Use the state management approach the project already uses everywhere; do not introduce a second one.
  • Never use BuildContext across an await without checking context.mounted first.
  • Do not edit generated files (*.g.dart, *.freezed.dart); run dart run build_runner build --delete-conflicting-outputs.
  • Add dependencies with flutter pub add <pkg> and ask before adding any.

How Do You Add These Files to a Flutter Repository?

  1. Download the zip above. It is laid out exactly as the files go into the repository.
  2. Unzip it at the repository root. AGENTS.md, CLAUDE.md and GEMINI.md go next to your README; the Copilot file goes in .github/ and the Cursor rule in .cursor/rules/.
  3. Open AGENTS.md and check every command against your package scripts or Makefile.
  4. Delete wrappers for tools your team does not use, and any old .cursorrules or .windsurfrules file.
  5. Commit, then run the linter on AGENTS.md whenever you change it.

Want different commands or rules? Load this preset into the generator, change anything, and download your own set.

Which Agents Will Read These Files?

AGENTS.md is read directly by Codex, Cursor, Windsurf, Cline, Zed and Jules, and by GitHub Copilot's cloud agent, code review and CLI. Claude Code reads it through the generated CLAUDE.md, and Gemini CLI through GEMINI.md. See the compatibility table for details, last verified 2026-11-13.

Where Are the Other Stacks?

All presets are on the stacks page.

Frequently Asked Questions

Which state management does this template assume?

None in particular; it asks the agent to use what the project already uses. Name it in the notes, for example Riverpod or Bloc, so the agent knows.

Why is there no type-check command?

flutter analyze performs Dart static analysis, including type checking, so it covers both lint and types.

Does it work for Flutter web or desktop?

Yes, the rules are platform-neutral. Change the build command and hosting choice in the generator.

Are these Flutter files free to use?

Yes. Copy them into any project, commercial or not, without attribution. They are a starting point: adjust the commands and rules to match your repository.

How Can You Verify That Nothing Leaves This Browser?

You do not have to take our word for it. Developer tools show every request a page makes, so you can watch this page work and confirm that nothing you type is sent. The check takes under a minute.

  1. Open your browser developer tools with F12, or Cmd+Option+I on a Mac, and select the Network tab.
  2. Reload the page and let it finish. You will see the page's own files, its web fonts, and one anonymous page-view request. Nothing has been typed yet, so none of them can contain your input.
  3. Click the clear icon in the Network tab so that the log is empty.
  4. Switch between the file tabs, copy a file and download the zip.
  5. Look at the Network tab again. It is still empty. Downloads are built in the page as Blob URLs, so even the zip never touches a server. For extra proof, turn on offline mode after the page loads: everything keeps working.

Only the feedback form can add a line to that log, and it sends only the vote and comment you type into it. 2prompt has no server code at all: no API, no model and no database of your files. The production site also sends a Content-Security-Policy header that tells your browser to refuse connections to anywhere except this site, the fonts and the anonymous analytics endpoint.

Was this helpful?