gongzhiyong
2a6a709f58
Add a complete docs skeleton for onboarding and integration, including orchestration-plan contract, acceptance matrix, OAuth flow, architecture maps, and milestone status tracking to support Agnet-facing delivery work. Made-with: Cursor
3.4 KiB
3.4 KiB
CLAUDE.md — Heicode 单仓导航（给 Claude Code / 助手）
本文是 仓库根级 的快速地图与协作约定。细分栈的规则请看各子目录自带文档（避免重复与漂移）。
仓库地图（explore 摘要）
| 路径 | 角色 | 栈 / 备注 |
|---|---|---|
cc-haha/ |
Heicode 客户端：CLI（Ink）+ 本地 HTTP/WS 服务 + Desktop（Tauri + React） | Bun + TypeScript；产品入口 bin/heicode |
new-api/ |
Heicode Manager：网关 + 管理控制台 | Go（Gin/GORM）+ web/default 前端（Bun/Rsbuild/React） |
website/ |
产品介绍站点 | Next.js；根 docker-compose.yml 提供 heicode-www :8888 |
docs/ |
愿景、里程碑（docs/milestones/）、Agnet 集成（docs/integration/） |
Markdown |
根 package.json 仅少量 workspace 级依赖（如适配器用到的包）；主要开发依赖在 cc-haha/package.json。
权威子文档（改代码前先打开对应一篇）
- 客户端（cc-haha）：
cc-haha/AGENTS.md— 目录结构、运行命令、测试、提交约定。 - 网关（new-api）：
new-api/CLAUDE.md— Go 分层、JSON/i18n/DB 规则等。 - 产品愿景与交付节奏：
docs/vision-heicode-full-stack-agentic-dev.md、docs/milestones/README.md。
最小开发闭环
# 依赖（客户端主体）
cd cc-haha && bun install
# 终端 A：本地 API（桌面端依赖）
bun run src/server/index.ts
# 终端 B：桌面
cd desktop && bun run tauri dev
联调本机 Manager（new-api）时常见：
HEICODE_TAIJIAICLOUD_BASE_URL=http://localhost:3000 bun run src/server/index.ts
更多变量见 cc-haha/src/server/config/providerPresets.ts 与 cc-haha/src/server/api/heicode-auth.ts（如 HEICODE_<PROVIDER>_OAUTH_*）。
Heicode ↔ Manager 关键触摸点（代码索引）
- 客户端登录 / Provider：
cc-haha/src/server/api/heicode-auth.ts，路由前缀/api/heicode-auth/*（由cc-haha/src/server/router.ts挂载）。 - 模型发现：
cc-haha/src/server/services/providerService.ts、cc-haha/src/server/api/providers.ts。 - Provider 预设：
cc-haha/src/server/config/providerPresets.json+providerPresets.ts。 - Manager 侧 Heicode OAuth：
new-api/controller/heicode_oauth.go，路由new-api/router/heicode-router.go（例如/heicode/oauth/authorize、/heicode/oauth/session）。
协作约定（根级）
- 改哪一层跟哪篇文档：Go 行为以
new-api/CLAUDE.md为准；客户端 TS/React 以cc-haha/AGENTS.md为准。 - 小步提交：沿用历史风格（如
feat:/fix:/docs:）；PR 写清影响面与验证步骤。 - 集成与「SK」边界：平台契约见
docs/integration/agnet-platform-api-design.md，里程碑见docs/milestones/。 - 不要臆测计费：计费与订阅在平台侧，不在 Heicode 客户端内实现。
Docker / 站点
- 根目录
docker-compose.yml：构建website/静态站点镜像（端口 8888）。 - Manager 本地编排以
new-api/docker-compose.yml及仓库内 override 为准（若存在）。
若本文件与子目录 AGENTS.md / CLAUDE.md 冲突，以子目录为准并及时更新根文件摘要。