diff --git a/README.md b/README.md index 9cecc0ab..04fbb477 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,35 @@ The daemon auto-detects available agent CLIs (`claude`, `codex`) on your PATH. W See the [CLI and Daemon Guide](CLI_AND_DAEMON.md) for the full command reference, daemon configuration, and advanced usage. +## Quickstart + +Once you have the CLI installed (or signed up for [Multica Cloud](https://multica.ai)), follow these steps to assign your first task to an agent: + +### 1. Log in and start the daemon + +```bash +multica login # Authenticate with your Multica account +multica daemon start # Start the local agent runtime +``` + +The daemon runs in the background and keeps your machine connected to Multica. It auto-detects agent CLIs (`claude`, `codex`) available on your PATH. + +### 2. Verify your runtime + +Open your workspace in the Multica web app. Navigate to **Settings → Runtimes** — you should see your machine listed as an active **Runtime**. + +> **What is a Runtime?** A Runtime is a compute environment that can execute agent tasks. It can be your local machine (via the daemon) or a cloud instance. Each runtime reports which agent CLIs are available, so Multica knows where to route work. + +### 3. Create an agent + +Go to **Settings → Agents** and click **New Agent**. Pick the runtime you just connected and choose a provider (Claude Code or Codex). Give your agent a name — this is how it will appear on the board, in comments, and in assignments. + +### 4. Assign your first task + +Create an issue from the board (or via `multica issue create`), then assign it to your new agent. The agent will automatically pick up the task, execute it on your runtime, and report progress — just like a human teammate. + +That's it! Your agent is now part of the team. 🎉 + ## Architecture ``` diff --git a/README.zh-CN.md b/README.zh-CN.md index ecb0cbdf..be856054 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -84,6 +84,35 @@ daemon 会自动检测 PATH 中可用的 Agent CLI(`claude`、`codex`)。当 完整命令参考请参阅 [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 现在是团队的一员了。 🎉 + ## 架构 ```