AI代码编辑器 - AI代码框架 - AIDevFlow - 使用手册

GIT地址: [e-mail]:havealready/ai-dev-flow.git

当你安装完这个框架,你只需要在IDE中输入"提交代码",就会自动提交代码,之后就可以手动Push了
可以的话顺便留个言并下载试一试.

安装完后可以设置这个框架为单独的git项目不随上游项目提交,避免与你的项目合并

本人手打介绍框架

• 下载这个框架到你的项目中,执行初始化脚本,根据命令行的交互进行设置框架参数;
• 本框架95%都是使用trae编辑器进行开发的,使用的模型包括了gpt4/gpt5/claude4/deepseek/grok4,经过本人一个多月的磨合可以勉强发出来供大家参考
• 模型的不同执行的方式/结果也会有所不同,根本原因是模型的思考模式/推理模式不同,以及AIIDE设置的参数不同导致的(每家都会有自己的决策方向).
• 本框架会根据你自己的开发习惯自我演化,当然了本框架必须是在AIIDE中执行,自我优化/演化/修改会产生一个文档,如果你有兴趣可以把文档中的内容留言到仓库评论区
• 我自己在一个项目中使用,边用边让trae更新框架到一个空框架中(就是git地址指向的项目)
• 本框架目前只在trae中运行使用,其他的IDE没有测试,毕竟要花钱的.

AIDevflow 操作手册（快速落地）

面向工程师与 AI/CI 使用者，提供从零到可用的实操步骤与校验方法。命令路径以 AIDevFlow/scripts/... 为准。

环境准备

• 操作系统：macOS（默认），需安装 bash、git。
• 工作目录：在项目根目录运行所有命令。
• 数据库（可选）：仅在测试或私人项目调试时配置本地数据库；时间字段为 datetime，格式 YYYY-MM-DD HH:MM:SS。不提供默认值，避免隐私泄露。

快速上手

• 交互式初始化：
  • bash AIDevFlow/scripts/custom_init.sh --langs=java,python --style=mimic --interactive
• 非交互试跑（干跑）：
  • bash AIDevFlow/scripts/custom_init.sh --langs=python --style=ddd --non-interactive --evolve=verify
• 验证结果：
  • 打开 AIDevFlow/config/rules.env，确认键值：
    • PROJECT_NAME、LANGUAGES、ARCHITECTURE_STYLE、STYLE_<LANG>
    • 数据库相关键（如 DATABASE、DB_USER、DB_PASSWORD）为可选，仅在需要时手动添加。

模式选择与设置

• 查看帮助：
  • bash AIDevFlow/scripts/setup-framework-mode.sh --help
• 非交互设置（示例：子模块）：
  • bash AIDevFlow/scripts/setup-framework-mode.sh --mode=submodule --remote=https://github.com/org/AIDevflow.git --branch=main
• 交互式设置（未提供 remote/branch 时会提示输入）：
  • bash AIDevFlow/scripts/setup-framework-mode.sh --interactive
• 模式简介：
  • submodule：跟随上游更新，保持独立历史
  • subtree：便于合并与回推
  • vendor：复制依赖到仓库，独立维护
  • ignored：忽略目录，适合快速试用

渲染与钩子

• 渲染规则与文档：
  • bash AIDevFlow/scripts/render-rules.sh
• Git 标准与钩子：
  • bash AIDevFlow/scripts/setup-git-standards.sh
  • bash AIDevFlow/scripts/install-git-hooks.sh
  • bash AIDevFlow/scripts/pre-commit-check.sh

校验与联动

• 规则链接校验：
  • bash AIDevFlow/scripts/verify_rule_linkages.sh
• 文档同步检查：
  • bash AIDevFlow/scripts/check-doc-sync.sh
• 模板一致性检查：
  • bash AIDevFlow/scripts/check-templates.sh
• 接口关系与映射：
  • bash AIDevFlow/scripts/list-interface-relations.sh
  • bash AIDevFlow/scripts/gen-mapping-doc.sh

演进与干跑

• 干跑或应用演进：
  • bash AIDevFlow/scripts/framework_evolve.sh verify|apply
• 配合选项：
  • --no-config：不写入或同步 config/，适合建模演练

数据库与时间

• 写入配置：初始化后，rules.env 可选包含数据库键（如 DATABASE、DB_USER、DB_PASSWORD），仅用于测试/私人调试。请勿在开源框架中硬编码隐私信息。
• 时间格式：本地时间生成命令：date '+%Y-%m-%d %H:%M:%S'（与 datetime 字段一致）。

CI/AI 无人值守

• 关闭交互：在所有命令添加 --non-interactive。
• 典型流水线片段：
  • 初始化：bash AIDevFlow/scripts/custom_init.sh --langs=java,python --style=mimic --non-interactive
  • 校验：bash AIDevFlow/scripts/pre-commit-check.sh、bash AIDevFlow/scripts/validate-commit-msg.sh
  • 渲染与联动：bash AIDevFlow/scripts/render-rules.sh、bash AIDevFlow/scripts/check-doc-sync.sh

常见问题与处理

• 初始化后未写入 rules.env：
  • 检查是否使用了 --no-config；需要写入时去掉该选项并重跑。
• 设置模式缺少上游：
  • 非交互需显式传参 --remote=<url> --branch=<name>；交互下会提示输入。
• 钩子执行失败：
  • 手动运行 bash AIDevFlow/scripts/install-git-hooks.sh；检查权限与 Git 版本。
• .git 目录嵌套：
  • 避免在父仓中保留额外 .git/（submodule 场景除外）。

命令速查

• 初始化帮助：bash AIDevFlow/scripts/custom_init.sh --help
• 模式帮助：bash AIDevFlow/scripts/setup-framework-mode.sh --help
• 渲染规则：bash AIDevFlow/scripts/render-rules.sh
• 校验集合：bash AIDevFlow/scripts/verify_rule_linkages.sh、bash AIDevFlow/scripts/check-doc-sync.sh、bash AIDevFlow/scripts/check-templates.sh
• 接口关系：bash AIDevFlow/scripts/list-interface-relations.sh、bash AIDevFlow/scripts/gen-mapping-doc.sh
• 演进：bash AIDevFlow/scripts/framework_evolve.sh verify|apply