OpenSunstar AGENTS.md

AGENTS.md — AI Agent Integration Guide

商业控制面隔离与发版边界

账号、订阅与计费、多租户团队服务及云端运维属于独立维护的私有商业控制面，是 OpenSunstar 核心商业化许可边界。本公开仓库仅包含 Apache-2.0 授权的公共客户端、os CLI、本地配置与工作流能力，以及展示或调用可选控制面能力的客户端侧集成。

发版、README/website 同步、tag、GitHub Release、npm 发布与远程推送时，必须保持以下隔离：

• 私有商业控制面源码、服务端实现、计费系统、多租户服务、云端运维配置与部署脚本，必须保留在独立私有远程仓库和本地私有仓库。
• 本仓库发版内容不得包含 opensunstar-control-plane、control-plane 私有目录、@opensunstar/control-plane 包，或 E:\projects\opensunstar-control-plane 本地路径内容。
• 若商业控制面有更新，必须独立安排私有仓库提交、推送、部署与发版，不与本公开仓库发版混合。
• 公共客户端中保留的订阅账号、团队配置等 UI / API 适配仅代表客户端入口，不等同于私有商业控制面源码授权。

CLI 治理与编排工具 (os)

当检测到 AI 编程工具配置异常时，可运行以下命令诊断：

os drift check --json          # 检查配置漂移
os readiness score --json      # Agent 就绪度评分
os doctor --json               # 环境诊断
os flow validate --json        # 阶段门禁校验
os flow validate --strict --json  # 跨模块治理门禁（检查设计合约/Recipe/Specs 就位）
os project status --json       # 项目全景状态（聚合编排+资产+漂移）

退出码约定: 0=正常, 1=有发现(如漂移/门禁阻断), 2=治理门禁阻断(strict), 3=错误 所有命令支持 --json 输出机器可读格式。 写操作支持 --dry-run 预览和 --yes 跳过确认。

全局选项

选项	说明
--json	输出 JSON 格式（机器消费）
--timeout <seconds>	操作超时（秒），防止 Agent 会话无限挂起

错误输出格式

JSON 模式下错误输出包含 code、message、hint 三字段，便于 Agent 自动诊断：

{
  "error": true,
  "code": "error",
  "message": "数据库不存在: ...",
  "hint": "运行 os config bootstrap --yes 初始化，或检查 ~/.OpenSunstar 目录权限"
}

常用诊断流程

# 0. 首次使用（无 GUI 时）
os config bootstrap --yes

# 1. 环境健康检查
os doctor --json

# 2. 配置漂移扫描（强制刷新缓存）
os drift check --refresh --json

# 3. 就绪度评分
os readiness score --json

# 4. 漂移修复（预演）
os drift repair --dry-run --json

# 5. 漂移修复（执行）
os drift repair --yes --json

项目编排闭环

# 项目全景状态（聚合 DB 资产 + 文件系统编排状态）
os project status --project-path /path/to/project --json

# 阶段门禁（标准：检查 .specs/ 工件）
os flow validate --project-path . --project-type web --change-id CHG-001 --target-stage implementation --json

# 阶段门禁（严格：额外检查设计合约/Recipe/FlowConfig 就位）
os flow validate --project-path . --project-type web --change-id CHG-001 --target-stage implementation --strict --json

# 导出 CI 门禁配置
os flow config --project-path . --project-type web --json

# Recipe 安装预检
os recipe plan --project-path . --name my-recipe --json

# Recipe 安装到项目
os recipe install --project-path . --name my-recipe --yes --json