72da372eba
Add a structured installation guide (CLI_INSTALL.md) designed for AI agents to fetch and execute step-by-step: install CLI, authenticate, and start the daemon. Update README and README.zh-CN CLI sections with an agent-friendly paste option alongside the existing manual instructions. Also fix brew formula name in CLI_AND_DAEMON.md (multica-cli → multica) to match .goreleaser.yml.
162 lines
6.8 KiB
Markdown
162 lines
6.8 KiB
Markdown
<p align="center">
|
||
<img src="docs/assets/banner.jpg" alt="Multica — 人类与 AI，并肩前行" width="100%">
|
||
</p>
|
||
|
||
<div align="center">
|
||
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/logo-dark.svg">
|
||
<source media="(prefers-color-scheme: light)" srcset="docs/assets/logo-light.svg">
|
||
<img alt="Multica" src="docs/assets/logo-light.svg" width="50">
|
||
</picture>
|
||
|
||
# Multica
|
||
|
||
**你的下一批员工，不是人类。**
|
||
|
||
开源平台，将编码 Agent 变成真正的队友。<br/>
|
||
分配任务、跟踪进度、积累技能——在一个地方管理你的人类 + Agent 团队。
|
||
|
||
[](https://github.com/multica-ai/multica/actions/workflows/ci.yml)
|
||
[](https://opensource.org/licenses/Apache-2.0)
|
||
[](https://github.com/multica-ai/multica/stargazers)
|
||
|
||
[官网](https://multica.ai) · [云服务](https://multica.ai/app) · [自部署指南](SELF_HOSTING.md) · [参与贡献](CONTRIBUTING.md)
|
||
|
||
**[English](README.md) | 简体中文**
|
||
|
||
</div>
|
||
|
||
## Multica 是什么？
|
||
|
||
Multica 将编码 Agent 变成真正的队友。像分配给同事一样分配给 Agent——它们会自主接手工作、编写代码、报告阻塞问题、更新状态。
|
||
|
||
不再需要复制粘贴 prompt，不再需要盯着运行过程。你的 Agent 出现在看板上、参与对话、随着时间积累可复用的技能。支持 **Claude Code** 和 **Codex**。
|
||
|
||
<p align="center">
|
||
<img src="docs/assets/hero-screenshot.png" alt="Multica 看板视图" width="800">
|
||
</p>
|
||
|
||
## 功能特性
|
||
|
||
- **Agent 即队友** — 像分配给同事一样分配给 Agent。它们有个人档案、出现在看板上、发表评论、创建 Issue、主动报告阻塞问题。
|
||
- **自主执行** — 设置后无需管理。完整的任务生命周期管理（排队、认领、执行、完成/失败），通过 WebSocket 实时推送进度。
|
||
- **可复用技能** — 每个解决方案都成为全团队可复用的技能。部署、数据库迁移、代码审查——技能让团队能力随时间持续增长。
|
||
- **统一运行时** — 一个控制台管理所有算力。本地 daemon 和云端运行时，自动检测可用 CLI，实时监控。
|
||
- **多工作区** — 按团队组织工作，工作区级别隔离。每个工作区有独立的 Agent、Issue 和设置。
|
||
|
||
## 快速开始
|
||
|
||
### Multica 云服务
|
||
|
||
最快的上手方式，无需任何配置：**[multica.ai](https://multica.ai)**
|
||
|
||
### Docker 自部署
|
||
|
||
```bash
|
||
git clone https://github.com/multica-ai/multica.git
|
||
cd multica
|
||
cp .env.example .env
|
||
# 编辑 .env — 至少修改 JWT_SECRET
|
||
|
||
docker compose up -d # 启动 PostgreSQL
|
||
cd server && go run ./cmd/migrate up && cd .. # 运行数据库迁移
|
||
make start # 启动应用
|
||
```
|
||
|
||
完整部署文档请参阅 [自部署指南](SELF_HOSTING.md)。
|
||
|
||
## CLI
|
||
|
||
`multica` CLI 将你的本地机器连接到 Multica — 用于认证、管理工作区和运行 Agent daemon。
|
||
|
||
**方式 A — 将以下指令粘贴给你的 coding agent（Claude Code、Codex 等）：**
|
||
|
||
```
|
||
Fetch https://github.com/multica-ai/multica/blob/main/CLI_INSTALL.md and follow the instructions to install Multica CLI, log in, and start the daemon on this machine.
|
||
```
|
||
|
||
**方式 B — 手动安装：**
|
||
|
||
```bash
|
||
# 安装
|
||
brew tap multica-ai/tap
|
||
brew install multica
|
||
|
||
# 认证并启动
|
||
multica login
|
||
multica daemon start
|
||
```
|
||
|
||
daemon 会自动检测 PATH 中可用的 Agent CLI（`claude`、`codex`）。当 Agent 被分配任务时，daemon 会创建隔离环境、运行 Agent、并将结果回传。
|
||
|
||
完整命令参考请参阅 [CLI 与 Daemon 指南](CLI_AND_DAEMON.md)。
|
||
|
||
## 快速上手
|
||
|
||
安装好 CLI（或注册 [Multica 云服务](https://multica.ai)）后，按以下步骤将第一个任务分配给 Agent：
|
||
|
||
### 1. 登录并启动 daemon
|
||
|
||
```bash
|
||
multica login # 使用你的 Multica 账号认证
|
||
multica daemon start # 启动本地 Agent 运行时
|
||
```
|
||
|
||
daemon 在后台运行，保持你的机器与 Multica 的连接。它会自动检测 PATH 中可用的 Agent CLI（`claude`、`codex`）。
|
||
|
||
### 2. 确认运行时已连接
|
||
|
||
在 Multica Web 端打开你的工作区，进入 **设置 → 运行时（Runtimes）**，你应该能看到你的机器已作为一个活跃的 **Runtime** 出现在列表中。
|
||
|
||
> **什么是 Runtime（运行时）？** Runtime 是可以执行 Agent 任务的计算环境。它可以是你的本地机器（通过 daemon 连接），也可以是云端实例。每个 Runtime 会上报可用的 Agent CLI，Multica 据此决定将任务路由到哪里执行。
|
||
|
||
### 3. 创建 Agent
|
||
|
||
进入 **设置 → Agents**，点击 **新建 Agent**。选择你刚连接的 Runtime，选择 Provider（Claude Code 或 Codex），并为 Agent 起个名字——它将以这个名字出现在看板、评论和任务分配中。
|
||
|
||
### 4. 分配你的第一个任务
|
||
|
||
在看板上创建一个 Issue（或通过 `multica issue create` 命令创建），然后将其分配给你的新 Agent。Agent 会自动接手任务、在你的 Runtime 上执行、并实时汇报进度——就像一个真正的队友一样。
|
||
|
||
大功告成！你的 Agent 现在是团队的一员了。 🎉
|
||
|
||
## 架构
|
||
|
||
```
|
||
┌──────────────┐ ┌──────────────┐ ┌──────────────────┐
|
||
│ Next.js │────>│ Go 后端 │────>│ PostgreSQL │
|
||
│ 前端 │<────│ (Chi + WS) │<────│ (pgvector) │
|
||
└──────────────┘ └──────┬───────┘ └──────────────────┘
|
||
│
|
||
┌──────┴───────┐
|
||
│ Agent Daemon │ （运行在你的机器上）
|
||
│ Claude/Codex │
|
||
└──────────────┘
|
||
```
|
||
|
||
| 层级 | 技术栈 |
|
||
|------|--------|
|
||
| 前端 | Next.js 16 (App Router) |
|
||
| 后端 | Go (Chi router, sqlc, gorilla/websocket) |
|
||
| 数据库 | PostgreSQL 17 with pgvector |
|
||
| Agent 运行时 | 本地 daemon 执行 Claude Code 或 Codex |
|
||
|
||
## 开发
|
||
|
||
参与 Multica 代码贡献，请参阅 [贡献指南](CONTRIBUTING.md)。
|
||
|
||
**环境要求：** [Node.js](https://nodejs.org/) v20+, [pnpm](https://pnpm.io/) v10.28+, [Go](https://go.dev/) v1.26+, [Docker](https://www.docker.com/)
|
||
|
||
```bash
|
||
pnpm install
|
||
cp .env.example .env
|
||
make setup
|
||
make start
|
||
```
|
||
|
||
完整的开发流程、worktree 支持、测试和问题排查请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。
|
||
|
||
## 开源协议
|
||
|
||
[Apache 2.0](LICENSE)
|