agentleFS
JohnnyQ-commitsJohnnyQ-commits/aqueduct-data-agent/CLAUDE.md

aqueduct-data-agent

CLAUDE.md2 starsChanged 32 days agoMITView on GitHub

这份文件是给 Claude(包括 Claude Code CLI、PyCharm Claude 等所有形态)的项目级指令。 Aqueduct 是一个工业级数据开发自动化 Agent 框架。 给定需求文档,自动产出 15 个标准化交付物(DDL、ETL SQL、DQC、血缘图、设计文档等)。 核心特点: - 插件直接生成为优先:日常数据开发优先使用 /data-developer 在单次对话中完成,快速高效 - CLI 管道模式:需要自动化/CI/CD/批量处理时使用 aqueduct dev(7 阶段管道) - 7 层架构:Config → LLM → Tools → Skills → Engine → Memory → MCP - 线性管道编排:7 个 Phase 顺序执行(core.py _run_pipeline,非 DAG 引擎),Phase 4.5 有审查→修复循环(手工回跳) 自然语言请求数据开发时,默认使用 /data-developer(插件直接生成模式): - 用户在对话中发送需求文档路径、描述数据开发需求 → 使用 /data-developer - Claude 在单次对话中直接生成所有交付物(1-2 次 LLM 调用,5-10 分钟) 仅在以下情况使用 /aqueduct-dev(CLI 管道模式): - 用户明确提到"CLI"、"管道"、"pipeline" - 用户明确使用 /aqueduct-dev skill - 用户要求"走管道"、"用项目代码"、"跑 aqueduct dev" - CI/CD…

  • Reads credentials
  • Installs packages

The file

Files
CLAUDE.md

CLAUDE.md — Aqueduct Project Instructions

这份文件是给 Claude(包括 Claude Code CLI、PyCharm Claude 等所有形态)的项目级指令。

项目简介

Aqueduct 是一个工业级数据开发自动化 Agent 框架。 给定需求文档,自动产出 15 个标准化交付物(DDL、ETL SQL、DQC、血缘图、设计文档等)。

核心特点:

  • 插件直接生成为优先:日常数据开发优先使用 /data-developer 在单次对话中完成,快速高效
  • CLI 管道模式:需要自动化/CI/CD/批量处理时使用 aqueduct dev(7 阶段管道)
  • 7 层架构:Config → LLM → Tools → Skills → Engine → Memory → MCP
  • 线性管道编排:7 个 Phase 顺序执行(core.py _run_pipeline,非 DAG 引擎),Phase 4.5 有审查→修复循环(手工回跳)

最重要的规则

模式选择(关键)

自然语言请求数据开发时,默认使用 /data-developer(插件直接生成模式):

  • 用户在对话中发送需求文档路径、描述数据开发需求 → 使用 /data-developer
  • Claude 在单次对话中直接生成所有交付物(1-2 次 LLM 调用,5-10 分钟)

仅在以下情况使用 /aqueduct-dev(CLI 管道模式):

  • 用户明确提到"CLI"、"管道"、"pipeline"
  • 用户明确使用 /aqueduct-dev skill
  • 用户要求"走管道"、"用项目代码"、"跑 aqueduct dev"
  • CI/CD 或批量处理场景

❌ 绝对不要做的事

  1. 不要在 /data-developer 模式下绕过 Skill:使用 /data-developer 时,按其指导直接生成所有交付物
  2. 不要跳过 Phase 4.5 的工具链校验(CLI 管道模式下):ValidatorTool、LineageTool、EstimatorTool 的结果必须保留
  3. 不要忽略管道输出的 errors 列表:如果有 errors,必须向用户报告并分析原因

✅ 必须做的事

  1. 使用 Skills:用户要求数据开发时,默认使用 /data-developer(直接生成,快速高效)
  2. Phase 1 必须确认(CLI 管道模式下):管道在 Phase 1 会暂停要求用户确认需求理解,不要跳过
  3. 展示产出物:完成后,列出 output/ 目录下所有生成文件

开发环境

虚拟环境

# 激活虚拟环境
source .venv/bin/activate        # Linux/macOS
.venv\Scripts\activate           # Windows

# 安装依赖(首次或依赖变更后)
pip install -e ".[dev]"

常用命令

# 运行测试
python -m pytest tests/ -v

# 代码检查
ruff check src/ tests/
ruff format src/ tests/

# 端到端测试
aqueduct dev examples/ecommerce_daily_stat.md

# 查看项目状态
aqueduct status

项目结构

src/aqueduct/
├── cli/main.py          # CLI 入口(argparse)
├── core.py              # 管道执行器 _run_pipeline()
├── exceptions.py        # 自定义异常(LLMTimeoutError 等)
├── config/settings.py   # Pydantic-settings 配置
├── engine/
│   ├── nodes/           # 8 个节点(7 个 Phase + change 变更管理)
│   ├── recovery.py      # 错误恢复(指数退避)
│   └── state.py         # WorkflowState TypedDict
├── skills/              # 9 个业务 Skill + prompt/ 模板
├── tools/               # 10 个原子工具
├── llm/                 # Claude 适配器 + 模型路由
├── memory/              # 本体知识库 + Top-K 召回
└── utils/               # 日志、正则等工具

关键模块说明

模块文件职责
管道执行core.py_run_pipeline() 线性管道 + 审查→修复循环
Phase 节点engine/nodes/*.py每个 Phase 的状态组装和调用
LLM 调用engine/nodes/helpers.pycall_llm() 统一入口,带完整日志
SQL 开发engine/nodes/sql.pyPhase 4:生成/读取 SQL + 自动工具链
代码审查engine/nodes/review.pyPhase 4.5:独立上下文审查 + 解析问题
超时处理llm/claude.py超时抛 LLMTimeoutError,指数退避重试

测试方式

# 单元测试 + 集成测试(1028 tests)
python -m pytest tests/ -v

# 端到端验证(需要 LLM API key)
aqueduct dev examples/ecommerce_daily_stat.md

Claude Skills

本项目有 5 个 Claude Code Skills:

Skill触发方式用途优先级
/data-developer默认 — 自然语言数据开发请求单次对话直接生成所有交付物⭐ 最高
/aqueduct用户提到"数据开发"、"ETL开发"、"需求转SQL"等框架调用入口,默认路由到 /data-developer路由层
/aqueduct-dev用户明确提到"CLI"、"管道"启动 7 阶段 CLI 管道仅明确指定时
/aqueduct-review用户要求审查 SQL 变更、对比线上版本SQL 审查模式(差异比对 + 需求覆盖度)—
/change-management用户提到"变更"、"CR"交付后需求变更管理—

配置文件

文件用途
.env数据平台凭证(DP_BASE_URL, DP_COOKIE 等)
.mcp.jsonMCP 服务器配置
.claude/settings.jsonClaude Code 权限

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.