merge: 合并 Gitea xiaohei/heicode 与本地 Heicode 文档/官网
- 解决 README 冲突:合并愿景说明与 Taiji 网关/快速启动说明 - 解决 mac_helper.py:统一为可执行脚本 Made-with: Cursor
This commit is contained in:
@@ -1,30 +1,55 @@
|
||||
# Heicode
|
||||
|
||||
Heicode 是一个**面向团队的智能体驱动软件交付**工作区:把 **改造后的大模型网关(New API)**、**终端与桌面上的智能体编程客户端(cc-haha)**,以及 **Agnet 平台上的子智能体团队** 串成一条从想法到上线、再到运维迭代的闭环。
|
||||
Heicode 是一个**面向团队的智能体驱动软件交付**工作区:把 **改造后的大模型网关(New API / TaijiAICloud)**、**终端与桌面上的智能体编程客户端(cc-haha)**,以及 **Agnet 平台上的子智能体团队** 串成一条从想法到上线、再到运维迭代的闭环。
|
||||
|
||||
## 这个仓库里有什么
|
||||
|
||||
| 目录 | 作用 |
|
||||
|------|------|
|
||||
| `new-api/` | 基于 New API 生态的 **网关与运营能力**(模型渠道、计费、鉴权、多协议中继等),经深度改造后作为用户登录后看到的 **后台与 API 能力层**。 |
|
||||
| `cc-haha/` | **CLI / 本地服务 / Desktop(Tauri)** 相关代码,提供类 **Claude Code** 的编程与协作体验,并与 New API 对齐登录与接口。 |
|
||||
| `cc-haha/` | **CLI / 本地服务 / Desktop(Tauri)**;类 **Claude Code** 体验,与平台登录、模型发现对齐。 |
|
||||
| `new-api/` | 网关与运营能力(渠道、计费、鉴权、中继等),含 HeiCode 浏览器登录等适配。 |
|
||||
| `website/` | 产品说明**静态官网**(可用 Docker 本地预览)。 |
|
||||
| `_all-in-one-upload/` | 历史或打包上传相关目录(按需维护)。 |
|
||||
|
||||
## 产品在解决什么问题
|
||||
|
||||
- **自动化开发范式**:不止「写代码」,而是覆盖需求、实现、测试、**多云部署**、运维与迭代的 **标准化团队模式**(瀑布 / 敏捷模板 + 子智能体规模可配置)。
|
||||
- **平台整合**:用户从官网进入 → 使用改造后的 **New API** 控制台 → 下载 **CLI** 与 **Desktop** → 与 **Agnet** 上已部署的 **子智能体团队** 协同;子智能体可具备 Git 与云资源(GCP / AWS / Azure)的**策略化**自动化能力。
|
||||
- **可审计交付**:多智能体协作记录、产品文档、开发日志等与版本和发布关联。
|
||||
- **自动化开发范式**:覆盖需求、实现、测试、**多云部署**、运维与迭代,以及 **瀑布 / 敏捷** 子智能体团队模板(详见 `docs/vision-heicode-full-stack-agentic-dev.md`)。
|
||||
- **单仓交付**:客户端与网关同步迭代,减少版本错位;发版时同一标签回归登录、模型拉取、对话等主线。
|
||||
- **可审计交付**:多智能体协作、产品文档、开发日志与发布版本关联。
|
||||
|
||||
## 详细愿景与范式说明
|
||||
|
||||
完整的产品叙事、三问回答、架构分层、用户旅程、**瀑布(5~9)与敏捷(3~8)子 Agnet 角色清单**、风险与路线图见:
|
||||
## 详细愿景与范式
|
||||
|
||||
**[docs/vision-heicode-full-stack-agentic-dev.md](./docs/vision-heicode-full-stack-agentic-dev.md)**
|
||||
|
||||
## 官网静态站(本地 Docker)
|
||||
## 快速启动(开发联调)
|
||||
|
||||
仓库内自带 **`website/`** 静态站点与根目录 **`docker-compose.yml`**。在本机已安装 Docker 且可拉取 `nginx:alpine` 镜像的前提下:
|
||||
```bash
|
||||
# 根依赖(若使用 bun 工作区)
|
||||
bun install
|
||||
|
||||
# HeiCode 本地服务
|
||||
cd cc-haha
|
||||
bun run src/server/index.ts
|
||||
|
||||
# 另开终端:桌面端
|
||||
cd cc-haha/desktop
|
||||
bun run tauri dev
|
||||
```
|
||||
|
||||
联调网关时示例:
|
||||
|
||||
```bash
|
||||
HEICODE_TAIJIAICLOUD_BASE_URL=http://localhost:3000 bun run src/server/index.ts
|
||||
```
|
||||
|
||||
`new-api` 中与 HeiCode 登录相关的路由(最小集,以实际代码为准):
|
||||
|
||||
- `GET /heicode/oauth/authorize`
|
||||
- `GET /heicode/oauth/session`
|
||||
|
||||
平台侧能力还包括模型发现(如 `GET /v1/models`)与 Anthropic Messages 兼容入口等,详见 `new-api` 与 `cc-haha` 各自 README。
|
||||
|
||||
## 官网静态站(本地 Docker)
|
||||
|
||||
```bash
|
||||
cd /path/to/heicode
|
||||
@@ -33,13 +58,19 @@ docker compose up --build
|
||||
|
||||
浏览器访问:**http://localhost:8888**
|
||||
|
||||
若拉取 Docker Hub 超时,请配置镜像加速或代理后重试;静态文件也可直接用浏览器打开 `website/index.html` 做离线预览(部分字体来自 Google Fonts,需网络)。
|
||||
若拉取 `nginx:alpine` 超时,请配置 Docker 镜像加速;也可直接打开 `website/index.html` 离线浏览(部分字体依赖 Google Fonts)。
|
||||
|
||||
## 发版与回归建议
|
||||
|
||||
- 同一版本标签发布客户端与网关镜像。
|
||||
- 每次发版至少回归:**登录**、**模型拉取**、**对话请求**。
|
||||
- 先在本地 Docker / 本地联调通过,再做外网域名与证书。
|
||||
|
||||
## 相关外部参考(概念)
|
||||
|
||||
- [oh-my-claudecode](https://ohmyclaudecode.com/) — 高效使用 Claude Code 类工具的实践与脚手架方向。
|
||||
- Agnet 平台文档(部署与编排由平台侧提供)— 集成时以平台当前 API 与权限模型为准。
|
||||
- [oh-my-claudecode](https://ohmyclaudecode.com/) — Claude Code 类工具的高效实践参考。
|
||||
- Agnet 平台以实际部署环境与文档为准。
|
||||
|
||||
## 许可证
|
||||
|
||||
各子项目可能沿用不同开源许可证(例如 `new-api` 侧常见为 AGPLv3),请以各子目录内 `LICENSE` 为准。
|
||||
各子项目许可证见各子目录内 `LICENSE`(例如 `new-api` 侧常见为 AGPLv3)。
|
||||
|
||||
Reference in New Issue
Block a user