FlutterKit AGENTS.md

Project instructions for FlutterKit, a cross-platform Flutter application template for Android, iOS, desktop, and web.

In plain words
What is it for?
Use them when building or modifying Flutter pages, layouts, themes, network features, storage, navigation, tests, or reusable modules.
Why use it?
They explain the project’s architecture, design system, data and networking patterns, documentation priorities, and rules for checking APIs before making changes.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/joker-x-dev/flutterkit/agents-md
Clone the repo
git clone --depth 1 https://github.com/Joker-x-dev/FlutterKit

Made for: Codex, OpenCode.

Per session 2,531 This file is loaded in full into every session.
When invoked 2,531 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.02531 $0.02531
Opus 5 $0.01265 $0.01265
Sonnet 5 $0.00506 $0.00506
Haiku 4.5 $0.00253 $0.00253

Measured 2d ago against content hash d280e5fa4a39, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

FlutterKit AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 106 lines

How it starts

The opening of the file, as written. The whole thing — 106 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Repository Guidelines

项目概览与技术栈

FlutterKit 是面向 Android、iOS、macOS、Linux、Windows 和 Web 的 Flutter 跨平台项目脚手架,采用模块化目录与 GetX 页面分层,内置常用基础能力和可运行 Demo。

领域 技术与用途
语言与框架 Dart、Flutter
架构与状态 GetX,采用 View、Logic、State、Binding 分层及全局 Service
UI 与设计系统 TDesign Flutter、AppTheme、语义化尺寸/形状、Widget 与动画链式扩展
网络与模型 Dio、Retrofit、json_serializableRequestHelper
数据持久化 Repository + DataSource、sqflite、shared_preferences
适配与交互 flutter_screenutil、easy_refresh、animations、bot_toast
开发与质量 build_runner、FlutterGen、Widget Preview、flutter_lints、flutter_test

执行原则与资料优先级

修改前必须先阅读任务对应文档,再核对源码、调用方和测试,禁止根据类型名、其他平台实现或记忆猜测 Flutter/TDesign API。

资料优先级如下:

  1. 用户当前任务与本文件的项目级强约束。
  2. FlutterKit 框架文档TDesign Flutter 文档
  3. 当前源码、同类实现、调用关系和测试用例。
  4. 依赖包当前版本的源码与官方文档。

文档与代码不一致时,以可运行实现和测试结果为依据,并同步更新项目文档。不得复制过时示例或创造项目不存在的 API。

按任务读取文档

任务 必读文档
项目架构、模块拆分 项目架构与职责模块化设计
Feature 目录与页面分层 Feature 概览目录与命名页面模板
View、Logic、State、Binding ViewLogicStateBinding
基础页面、网络、列表、刷新、Tab、Dialog 基础父类 及对应 base-*.md 专题
UI、布局、主题、深色、扩展 完整布局规范与扩展扩展统一导出文件Widget 扩展设计系统主题系统深色模式
TDesign 组件参数 TDesign 组件索引 与具体组件页面
数据、模型、网络、结果处理 数据层数据模型网络请求结果处理
数据库、本地存储、全局状态 数据库本地存储状态管理
路由、参数、结果、守卫 导航文档 及对应专题
适配、预览、图标与启动页 扩展文档 及对应专题

Read the full file on GitHub · 106 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 106 lines · 2,531 tokens per session scan A d280e5fa4a39

Subscribe to this mod's changes

FlutterKit AGENTS.md is an instructions file published in the GitHub repository Joker-x-dev/FlutterKit (110 stars, last pushed 1mo ago), licensed MIT. It adds 2,531 tokens to every session, about $0.0127 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.