Flutter Agent Kit

A tool-agnostic guidance kit for Flutter / Dart development.

中文

A tool-agnostic guidance kit for Flutter / Dart development. It ships one substantive guide — AGENTS.md — as the single source of truth, plus a CodeBuddy SKILL.md wrapper, reference docs under references/, and Dart helper scripts. The same AGENTS.md is consumed directly by non-CodeBuddy tools, so the content stays in one place.

✨ What's inside

File / folder	Purpose
AGENTS.md	Core guidance — architecture, conventions, dependencies, plugin pattern, verify commands. Single source of truth.
SKILL.md	CodeBuddy-only auto-load wrapper (thin forwarder, no duplicate content).
references/	Deeper docs: flutter_style.md, pubspec.md, architecture.md, platform_channel.md (Android / iOS / Linux / macOS / Windows / Web / OpenHarmony).
scripts/dart/	Helper scripts in Dart (*.dart).
scripts/python/	The same helper scripts in Python (*.py). Identical behavior & CLI: verify, create_feature, bump_version.
install.dart / install.py	Detects your AI tool and places/soft-links the right entry file. Pick the Dart or Python runtime.

🚀 Install (recommended)

Pick whichever runtime you have — the Dart SDK (any Flutter dev already has it) or just Python 3.

git clone https://github.com/zero-labsco/flutter-agent-kit.git
cd flutter-agent-kit
dart run install.dart      # Dart runtime
# or / 或
python install.py          # Python runtime

install.dart / install.py detects installed tools and wires up the kit:

Tool	What the installer does
CodeBuddy	Symlinks this kit into ~/.codebuddy/skills/flutter-agent-kit/ (auto-loads via SKILL.md).
Claude Code	Symlinks into ~/.claude/skills/flutter-agent-kit/ (also reads SKILL.md).
Cursor	Copies AGENTS.md content into the project's .cursorrules / Cursor rules.
GitHub Copilot (VS Code)	Copies AGENTS.md into the current project's .github/copilot-instructions.md.

Re-run the installer any time to update (idempotent).

Options

Flag	Meaning	Optional?
-p, --project <path>	Target project root for Cursor/Copilot entries.	Optional (defaults to auto-detect nearest Flutter project)
-t, --tool <tool>	Wire only one tool: codebuddy | claude | cursor | copilot.	Optional (omit = wire all detected tools)
-h, --help	Print usage and exit.	Optional

Works in cmd, PowerShell, bash, zsh — just quote paths that contain spaces, e.g. -p "D:\My Project\app".

支持 cmd、PowerShell、bash、zsh —— 路径含空格时加引号即可， 如 -p "D:\My Project\app"。

Target a specific project (non-intrusive)

Run the installer from the kit folder and pass a target project root with --project. Cursor / Copilot entries are written directly into that project instead of scanning upward from the kit — the kit folder itself is never modified.

dart run install.dart -p /path/to/my_project
# or / 或
python install.py -p /path/to/my_project

Since you always run the installer from the kit folder, -p (short for --project) is the simplest way to point at the target project. 由于安装脚本本就在 kit 目录运行，-p（--project 的简写）是指定目标项目最简洁的方式。 Omit it to fall back to auto-detecting the nearest Flutter project by walking up from the kit folder. 省略则回退到从 kit 目录向上查找最近的 Flutter 项目。

Limit to a single tool

Use -t <tool> (short for --tool) to wire only one tool. Valid values: codebuddy, claude, cursor, copilot. Without it, every detected tool is wired.

使用 -t <tool>（--tool 的简写）只接入某一个工具。合法取值： codebuddy、claude、cursor、copilot。不指定则接入所有已检测到的工具。

dart run install.dart -p /path/to/my_project -t cursor
# or / 或
python install.py -p /path/to/my_project --tool copilot

🛠 Helper scripts (Dart + Python)

The helpers ship twice — once in Dart under scripts/dart/ and once in Python under scripts/python/. Pick whichever runtime you have; the CLI and behavior are identical.

Script	Dart	Python	Purpose
Verify	dart run scripts/dart/verify.dart [--no-publish]	python scripts/python/verify.py [--no-publish]	Runs flutter analyze + flutter test + publish dry-run.
Create feature	dart run scripts/dart/create_feature.dart <name>	python scripts/python/create_feature.py <name>	Scaffolds lib/features/<name>/{data,domain,presentation}/.
Bump version	dart run scripts/dart/bump_version.dart <major|minor|patch>	python scripts/python/bump_version.py <major|minor|patch>	Bumps pubspec.yaml and prints the git tag command.

📦 Install (manual fallback)

If the script can't detect your environment, place the files yourself:

• CodeBuddy / Claude Code: copy this folder to ~/.codebuddy/skills/ or ~/.claude/skills/.
• Cursor: copy AGENTS.md into your project's .cursorrules.
• Copilot: copy AGENTS.md into your project's .github/copilot-instructions.md.

🔄 Updating

Pull latest and re-run dart run install.dart (or python install.py).

📄 License

Released under the MIT License.