safesight/AGENTS.md
tian 80c1e63c95 docs: 新增根级 AGENTS.md 仓库总规范
pi 从 cwd 向上加载 AGENTS.md 并拼接: 根目录工作时不会加载子目录规范,
补根级总览(仓库结构/两端关系/工作流),指向 edge/control 各自细则
2026-08-02 11:45:49 +08:00

1.7 KiB
Raw Permalink Blame History

AGENTS.md — SafeSight 单仓库总规范

本文件为仓库级总览。子目录有各自的详细规范,进入对应目录工作时 pi 会自动加载:

  • edge/AGENTS.md — 设备端C++RK3588 构建验证约束、DAG+插件架构、本地/设备验证分桶
  • control/AGENTS.md — 管理端Go构建/测试命令、代码架构、编码规则、测试设备

仓库结构

safesight/
├── edge/      ← 设备端RK3588agent(Go) + 媒体引擎(C++) + 部署脚本
├── control/   ← 管理端Gosafesightd 服务 + Web UI
└── docs/      ← 文档(索引见 docs/README.md部署手册 docs/deployment/deployment.md

两端关系

  • control 通过 HTTP + UDP discovery 管理 edge 设备
  • 改接口/协议/版本时两端需同步,单仓库便于跨端修改
  • 版本:edge/VERSIONcontrol/VERSION 独立构建号自动注入YYYYMMDD.HHMMSS

开发工作流

  • 设备端构建/验证必须在 RK3588 设备上(本机不做完整 C++ 构建,见 edge/AGENTS.md
  • 管理端 Go 代码本机可编译/测试(cd control && go build ./...
  • 部署文档:docs/deployment/deployment.md(含产品镜像批量生产流程、断电保护)
  • 变更记录:根目录 CHANGELOG.md
  • 文档规范:新文档按内容放入 docs/ 对应分类requirements/design/implementation/bugfix/testing/guides/deployment

通用规则

  • 设备端脚本语言为 bash管理端为 Go + PowerShell见各子目录 AGENTS.md 细则)
  • 现场设备(测试用):orangepi@10.0.0.81token 见 control/AGENTS.md