AI Agent Support

Every project generated by Archipelago includes AI agent configuration out of the box. There is nothing to set up — the configs are generated alongside your code and contain accurate information about your specific project structure.

Overview

The flutter_modular_monorepo brick generates dedicated config files for every major AI coding assistant. Each file is pre-populated with your project's workspace layout, architecture patterns, key commands, and conventions — so agents can start helping immediately without requiring manual context.

File	Tool	Generated When
CLAUDE.md	Claude Code	Always
AGENTS.md	OpenAI Codex and generic agents	Always
.cursorrules	Cursor IDE	Always
.github/copilot-instructions.md	GitHub Copilot	When isGitHub is true
.claude/commands/	Claude Code slash commands	Always

Project Context Files

CLAUDE.md — Claude Code

Located at the project root, CLAUDE.md gives Claude Code a complete picture of your workspace before any conversation begins. It covers:

• Workspace directory layout (apps/, features/, infrastructure/, shared/, etc.)
• Architecture patterns: API/Impl split, Impl + Noop, Dual-GetIt, FeatureSDK self-registration, two-phase init
• Common melos commands for building, testing, formatting, and build_prepare swaps
• Dart and commit conventions used across the monorepo

AGENTS.md — Generic Agent Support

AGENTS.md provides the same project context in a vendor-agnostic format, compatible with OpenAI Codex and any agent that looks for a top-level AGENTS.md file.

.cursorrules — Cursor IDE

.cursorrules delivers the architecture and convention reference in Cursor's expected format, making Cursor's inline completions and chat context-aware from the first file you open.

.github/copilot-instructions.md — GitHub Copilot

When you generate a project with isGitHub: true, Archipelago also creates .github/copilot-instructions.md. GitHub Copilot reads this file automatically and applies the instructions to all suggestions and chat responses in the repository.

TIP

If you start with a non-GitHub project and later move to GitHub, you can add this file manually by copying the content from AGENTS.md into .github/copilot-instructions.md.

Claude Code Slash Commands

Claude Code users get 7 domain-specific slash commands generated into .claude/commands/. Each command is a focused guide that Claude Code follows as a step-by-step task — far more reliable than asking in free-form chat.

Command	What it does
/workspace-health	Checks that all packages resolve, analyze cleanly, and tests pass
/add-feature	Scaffolds a new feature module following FeatureSDK conventions
/add-infrastructure	Adds an infrastructure SDK with the correct API/Impl split
/architecture-guide	Returns a reference for architecture decisions and package boundaries
/build-prepare	Guides you through swapping debug/release dependencies via build_prepare
/manage-flavors	Walks through adding or updating app flavors
/deploy	Covers the Fastlane + CI/CD deployment flow

Run any command from within your project in Claude Code:

/workspace-health
/add-feature profile
/add-infrastructure analytics

How It Works

All agent config files are plain Markdown. They are written as part of the flutter_modular_monorepo brick template, so they are generated at the same time as your project scaffolding. Because they come from the same source as the rest of the brick, the instructions always match the actual code structure.

The generated files are yours to modify. As your project evolves — new packages, different conventions, updated commands — you can update CLAUDE.md and the slash commands to reflect the current state of the codebase.

Keep them in version control

Commit all agent config files. When teammates clone the repo, they get the same AI context immediately. CI agents (such as GitHub Actions workflows that use Claude or Copilot) also benefit from these files being present.

Supported Tools at a Glance

Tool	File	Notes
Claude Code	CLAUDE.md + .claude/commands/	Slash commands for monorepo tasks
Cursor	.cursorrules	Auto-loaded by Cursor on open
GitHub Copilot	.github/copilot-instructions.md	Requires isGitHub: true
OpenAI Codex	AGENTS.md	Standard agent instructions file
Any agent supporting AGENTS.md	AGENTS.md	Vendor-agnostic fallback