Skip to content

doc.md

Latest commit

 

History

History
680 lines (428 loc) · 25.1 KB

doc.md

File metadata and controls

680 lines (428 loc) · 25.1 KB

MonkeyCode AI 使用指南

欢迎使用 MonkeyCode AI！本文档将帮助你快速上手，了解如何完成各项操作。

一、产品简介

MonkeyCode 是面向研发团队的企业级 AI 开发平台，覆盖 需求 → 设计 → 开发 → 代码审查 全流程。你可以用自然语言描述需求，让 AI 帮你写代码、做设计、做 Review。

入口说明：首页（/）提供「开始使用」进入控制台；开发者广场（/playground）、公开任务（/tasks/public）可从首页或直接访问对应路径。

二、登录与账号

登录

  1. 打开登录页，选择 用户登录 或 团队管理登录
  2. 输入邮箱和密码
  3. 完成验证码验证
  4. 点击登录
  • 用户登录：进入个人控制台，使用智能任务、项目管理等功能
  • 团队管理登录：进入企业管理后台，管理团队资源

找回密码

在登录页点击「找回密码」，输入注册邮箱，系统会发送重置链接到你的邮箱。点击邮件中的链接，按提示设置新密码即可。

三、控制台导航

登录后进入控制台，左侧是导航栏：

  • 代码审查：进入 Git 机器人页面，配置和管理代码审查机器人
  • 开发项目：展示项目列表。点击「+」可创建项目，点击刷新图标可刷新列表。每个项目可展开子菜单显示其下的任务。另有 默认 分组，用于展示未关联到项目的任务
    • 点击「默认」进入新任务页（/console/tasks），可创建任务；默认分组旁的「+」为创建任务
    • 点击某个项目进入项目概览页；项目旁的「+」为启动任务（基于该项目仓库创建 AI 任务）
  • 配置：点击底部「配置」打开设置弹窗，可管理 Git 身份、AI 大模型、系统镜像、宿主机、开发环境、通知等

底部可查看账户余额和点数，点击头像可退出登录。

四、智能任务

如何创建一个任务

  1. 输入任务内容
    在输入框中用自然语言描述你的需求，例如：「为这个项目添加用户登录功能」。

  2. 选择任务类型
    点击「开发 / 设计 / 审查」按钮选择：

    • 开发：让 AI 根据需求写代码
    • 设计：让 AI 输出技术方案和设计文档
    • 审查：让 AI 审查代码，提出改进建议

  3. 选择代码来源
    点击「代码」按钮：

    • 我的仓库：展开后按已绑定的 Git 身份（GitHub、Gitee、GitLab、Gitea 等）分组，选择身份后显示该身份下授权的仓库列表（支持搜索）；若未绑定，会提示「去绑定」并跳转到配置页
    • 其他仓库：输入完整的 Git 仓库地址，按回车确认；下方会显示历史使用过的仓库供快速选择
    • ZIP 文件：选择本地的 .zip 压缩包上传（最大 10MB），上传成功后该文件会作为代码来源

  4. 选择技能（可选）
    点击「技能」按钮，按标签分类展示技能列表。勾选需要的技能以扩展 AI 能力，部分默认技能不可取消。

  5. 语音输入（可选）
    点击麦克风按钮，用语音描述任务，系统会自动转为文字。

  6. 点击「执行」
    会弹出「任务参数」配置窗口，确认后即可开始执行。任务创建成功后会跳转到任务详情页。

任务参数配置

执行前可以调整：

  • 大模型：选择要使用的 AI 模型（含免费模型和付费选项）
  • 仓库分支：不填则使用主分支
  • 身份凭证：使用「其他仓库」时，需选择已绑定的 Git 身份（从「我的仓库」选择的仓库已自动关联身份，不展示此选项）

子账号还可以选择宿主机和系统镜像。开发工具固定为 OpenCode。

查看任务列表

任务创建后会在下方以卡片形式展示，每个卡片显示：

  • 任务摘要
  • 关联的仓库或文件
  • 状态：等待执行、正在执行、任务完成、执行失败
  • Token 用量（若有）
  • 创建时间

点击任务卡片进入任务详情页。列表支持无限滚动，向下滚动可加载更多任务。

五、任务开发页面

任务执行时，会进入任务详情页（/console/task/:taskId），你可以在这里与 AI 协作。

页面布局

  • 主区域：与 AI 的对话区域，包含执行步骤、消息列表、输入框
  • 底部按钮：文件、终端、修改、预览、续期。点击任一按钮可展开右侧面板，再次点击可收起
    • 文件：项目文件树，可浏览、打开、编辑文件
    • 终端：终端输出，展示 AI 执行的命令，也可手动输入
    • 修改：查看 AI 修改过的文件及 Diff
    • 预览：端口转发与在线预览
    • 续期：延长开发环境使用时间

开发环境准备中时，主区域会显示准备状态（如「正在创建虚拟机」等）。

与 AI 对话

  • 当 AI 执行完毕、等待你的反馈时，底部输入框会变为可输入状态
  • 输入补充说明或新指令，点击发送，AI 会继续执行
  • 支持 Shift+Enter 换行，Enter 发送
  • 输入框旁有菜单按钮，可进行：
    • 重置上下文：清空当前对话上下文，后续操作基于新上下文
    • 重新加载开发工具：重新加载 OpenCode 等开发工具
  • 支持语音输入：点击麦克风按钮，用语音描述需求，系统会自动转为文字
  • 支持斜杠命令：点击终端图标可查看可用命令（如 /command），选择后插入到输入框

查看 AI 的执行进度

  • 对话区域顶部会展示「执行步骤」区块，显示 AI 的 TODO 计划及每个步骤的完成状态
  • 执行中会显示耗时，可点击停止按钮中断执行
  • 任务完成后会显示 Token 用量（输入/输出 tokens）

提交代码变更

当 AI 修改了代码后：

  1. 对话区域会显示「X 个文件被修改，是否提交保存」
  2. 点击「提交」会向 AI 发送指令，让其用 git 提交并推送；也可点击「不急」暂时忽略
  3. 若需选择性提交，可点击该提示区域打开变更列表，勾选要提交的文件后提交选中或全部提交
  4. 在「修改」面板中可查看每个文件的 Diff

查看和编辑文件

  • 点击底部「文件」按钮展开文件树，点击文件可查看内容（超过 1MB 会提示无法预览）
  • 支持多种展示方式：代码高亮、Markdown 渲染、图片预览、JSON 格式化等
  • 代码类文件可直接在编辑器中修改，修改后保存即可
  • 文件操作支持：新建文件/文件夹、上传、复制、移动、删除等

其他功能

在线预览

当任务中运行了 Web 服务（如前端开发服务器）时：

  1. 点击底部「预览」按钮展开预览面板
  2. 查看已开放的端口列表
  3. 若端口尚未开放，需先「开放端口」：系统会获取你的 IP 并加入白名单，开放后可通过生成的访问地址在浏览器中预览
  4. 若端口已开放，直接复制访问地址在浏览器中打开即可

续期

开发环境有回收时间，即将到期时「续期」按钮会闪烁提醒：

  1. 点击「续期」按钮
  2. 在弹窗中选择要续期的时长
  3. 确认后开发环境的使用时间会延长

六、代码审查（Git 机器人）

在「代码审查」页面（/console/gitbot），可以配置 Git 机器人，让 AI 自动审查你的合并请求（PR/MR）。

审查任务

切换到「审查任务」标签：

  • 以列表形式展示所有由机器人触发的审查任务
  • 每个任务显示关联的 PR/MR、状态、平台等，点击可跳转到对应 Git 平台的 PR 页面
  • 点击「刷新」可更新列表
  • 若无任务，会显示「如何使用？」链接，可查看配置说明

创建审查机器人

  1. 切换到「机器人」标签
  2. 点击「创建审查机器人」
  3. 填写：
    • 备注：可选，便于区分多个机器人
    • Git 平台：GitLab、GitHub 或 Gitee
    • Access Token：在对应平台的设置中生成，用于机器人访问仓库
    • 宿主机：选择运行审查任务的机器（MonkeyCode 内置或自有宿主机）
  4. 提交后，系统会显示 Webhook 地址和 Secret Token，并提示在 Git 平台配置

在 Git 平台配置

将生成的 Webhook 地址和 Secret Token 配置到你的 Git 仓库或组织的 Webhook 设置中。配置完成后，当有 PR/MR 创建或更新时，Git 平台会向该地址发送事件，MonkeyCode 收到后自动触发 AI 进行代码审查。具体配置步骤因平台而异，可参考各平台的 Webhook 文档。

管理机器人

每个机器人卡片右侧有「更多」菜单：

  • 编辑：修改备注、Token、宿主机等配置
  • 查看 Webhook：再次查看 Webhook 地址和 Secret Token，可复制
  • 权限管理：选择可将该机器人分享给哪些团队成员，被分享的成员可以使用该机器人
  • 删除：移除不再使用的机器人（需确认）

七、开发项目

如何创建项目

  1. 在左侧「开发项目」区域点击「+」按钮
  2. 在弹窗中输入项目名称
  3. 选择代码仓库：
    • 若已绑定 Git 身份（GitHub、Gitee、GitLab、Gitea 等），会显示已绑定的身份列表，选择其中一个身份
    • 选择身份后，系统会加载该身份下授权的仓库列表，从中选择要关联的仓库
    • 若尚未绑定 Git 账号，会提示「去绑定」并跳转到配置页
  4. 提交后，项目会出现在侧边栏，并自动进入该项目页面

项目页面

进入项目后，顶部有三个 Tab：信息、需求、任务。

信息 Tab：

  • 项目信息：名称、描述、仓库状态（未绑定仓库时会显示提示）
  • 文件树：树形展示仓库结构，点击目录可展开/折叠，点击文件可预览内容
  • README：自动加载仓库根目录的 README.md 并渲染

需求 Tab：创建和管理需求，详见「项目需求」。

任务 Tab：查看该项目下的所有任务，点击任务可进入任务详情页。

启动 AI 操作

在项目信息区域点击「启动 AI」按钮：

  • 弹出「启动 AI 任务」对话框，选择分支后点击「开始对话」
  • 系统会基于当前项目仓库创建开发任务，并跳转到任务详情页与 AI 对话

项目设置

点击项目信息区域的「更多」菜单：

  • 修改名称：在弹窗中修改项目名称和描述，保存即可
  • 环境变量：配置项目运行时的环境变量
  • 开发镜像：选择项目使用的系统镜像
  • 移除项目：删除项目（不可恢复，请谨慎操作）

项目需求

在项目内切换到「需求」标签：

  1. 点击「创建需求」
  2. 输入需求标题和原始需求说明（支持 Markdown）
  3. 提交后，需求会出现在列表中

需求详情：点击某个需求可查看和编辑：

  • 标题：点击可修改
  • 原始需求、技术方案：可编辑并保存
  • 状态：进行中、已完成、已关闭
  • 优先级：高、中、低

从需求启动任务：在需求详情的「更多」菜单中：

  • 启动设计任务：让 AI 基于需求输出技术方案
  • 启动开发任务：让 AI 基于需求直接开发
  • 移除：删除该需求

项目任务

切换到「任务」标签，可查看该项目下的所有任务，点击任务卡片可进入任务开发页面。

八、配置

在「配置」页面，可以管理各类基础设置。

Git 平台身份凭证

用于在 Git 仓库中拉取和提交代码。

绑定 GitHub：点击「绑定 GitHub」，按提示完成 GitHub App 安装和授权。

绑定 Gitee：点击「绑定 Gitee」，在弹窗中完成 OAuth 授权。

绑定其他平台（如 GitLab、Gitea）：

  1. 点击「绑定」→「绑定其他平台」
  2. 选择平台类型，填写 Base URL、Access Token、邮箱、用户名
  3. 提交即可

管理：已绑定的身份可修改备注或移除。

AI 大模型

平台提供部分免费模型，你也可以添加自己的 API 模型。

添加：

  1. 点击「添加模型」
  2. 填写 API Token 和模型 API 地址（默认百智云，可改为自建或第三方）
  3. 选择接口类型（如 OpenAI Chat、Anthropic 等，需与模型兼容）
  4. 点击「获取模型列表」拉取该地址下的可用模型
  5. 从列表中选择要添加的模型
  6. 保存前会进行连接检查，通过后即可使用

管理：可设为默认、检查连接、修改或移除（仅自己添加的模型可编辑和删除）。

系统镜像

配置任务运行时的操作系统环境（Docker 镜像）。不同镜像提供不同的预装环境和工具。

添加：点击「添加镜像」，输入镜像名称（如 docker.io/library/ubuntu:24.04），可选填写备注，保存即可。

管理：可设为默认、修改备注、移除。

宿主机

若希望任务在你自己的机器上执行，需先将机器接入为宿主机。

  1. 点击「绑定宿主机」或「获取安装命令」
  2. 弹窗会显示一段安装命令，点击可复制
  3. 以 root 权限登录你的 Linux 服务器，粘贴并执行该命令
  4. 执行成功后刷新页面，宿主机会出现在列表中

管理：可修改备注、设为默认、移除。

通知

配置任务执行完成后的通知接收方式，支持钉钉、飞书、企业微信、Webhook 等渠道。可添加多个通知通道，并选择要接收的事件类型（如任务完成、任务失败等）。

开发环境（虚拟机）

展示你名下所有开发环境，包括任务自动创建的以及手动创建的。

查看列表：每个环境显示名称、状态（运行中/待机/离线）、系统、配置、创建时间等。可切换「显示离线环境」来查看已回收的环境。

创建：

  1. 点击「创建开发环境」
  2. 选择宿主机（或 MonkeyCode 免费宿主机）
  3. 选择系统镜像、CPU 核数、内存大小
  4. 选择回收时间（如 1 小时后、3 天后等）
  5. 可选：填写仓库地址、分支、身份凭证，创建时会预拉取代码
  6. 点击创建

操作：续期、删除、进入终端、打开文件管理

九、终端

从开发环境列表点击「终端」进入终端页面。需在 URL 中指定环境 ID（通常从开发环境列表点击进入时会自动带上）。

首次连接

若该环境没有已有连接，会弹出选择框：

  • 使用已有连接：列出该环境下已有的终端会话，选择其中一个连接
  • 新建连接：创建新的终端会话

选择后即可进入终端界面。也可以关闭某个不再需要的终端连接。

常用功能

  • 重新连接：断线后点击「重新连接」重新建立连接
  • 在线预览：与任务开发页面的在线预览相同，可配置端口转发，在浏览器中访问运行中的 Web 服务
  • 文件管理：跳转到该环境的文件管理页面
  • 远程协助：
    1. 点击「远程协助」
    2. 选择模式：只读（对方只能看，不能操作）或 控制（对方可输入命令）
    3. 点击「生成连接信息」
    4. 复制连接地址和密码，发送给对方
    5. 对方在浏览器打开地址、输入密码后即可连接
  • 配色方案：在下拉框中选择终端主题，选择后会保存，下次进入自动应用

十、文件管理

从开发环境列表点击「文件管理」进入。默认进入该环境的 /workspace 目录。

浏览文件

  • 顶部面包屑显示当前路径，点击任意一级可快速跳转
  • 点击「上级目录」返回上一级
  • 点击文件夹进入该目录
  • 点击文件：若为目录则进入，若为普通文件且小于 1MB 则打开编辑弹窗；超过 1MB 会提示无法在线编辑

新建

点击「新建」下拉：

  • 创建文件夹：输入文件夹名称（相对于当前路径），保存后会在当前目录下创建
  • 创建文件：输入文件名（含路径），保存后创建空文件
  • 上传文件：选择本地文件，上传到当前目录

文件操作

每个文件/文件夹右侧有「更多」菜单：

  • 复制：在弹窗中选择或输入目标路径，将文件复制到该位置
  • 移动：在弹窗中选择或输入目标路径，将文件移动到该位置
  • 下载：将文件下载到本地
  • 删除：删除该文件或文件夹（需确认，删除目录会递归删除其内容）

编辑文件

在编辑弹窗中修改内容后，点击保存即可写入。支持多种文件类型的语法高亮。

十一、IDE 辅助工具

IDE 辅助工具（/console/ide）目前为「敬请期待」状态，后续将提供与 IDE 集成的辅助能力。可通过控制台内直接访问该路径进入。

十二、开发者广场

开发者广场（/playground）可浏览和分享内容，可从首页进入或直接访问。未登录时可浏览，发布需先登录。

浏览

  • 在搜索框输入关键词，点击「搜索」或按回车，可筛选帖子
  • 每个卡片显示封面图、标题、描述、作者、浏览量
  • 点击卡片进入详情页查看完整内容

发布

点击「发布」后，先选择发布类型：

写一篇文章

  • 输入标题、正文（支持 Markdown）
  • 可上传图片：点击上传区域选择图片，或拖拽图片到编辑区
  • 点击发布，审核通过后会显示在广场上

分享你执行过的任务

  • 从下拉列表中选择要分享的任务
  • 输入标题和说明
  • 可选：通过「选择文件」从该任务的开发环境中勾选要打包的代码文件，分享时会一并打包供他人下载
  • 点击发布，审核通过后会显示在广场上

十三、公开任务

公开任务（/tasks/public）展示他人公开分享的任务列表。每个任务以卡片形式展示，点击可进入任务详情页，查看任务描述、执行过程或关联的代码文件等。

十四、远程协助

当你在终端页面使用「远程协助」功能时，会生成一个连接地址和密码。将地址和密码发送给对方后：

  • 只读模式：对方在浏览器中打开地址、输入密码后，只能看到你的终端画面，无法输入或操作
  • 控制模式：对方可以看到终端画面，并且可以输入命令、进行操作

适用于需要他人协助排查问题、或进行远程演示等场景。

十五、企业管理后台

使用团队管理员账号登录后，可进入企业管理后台（/manager）。左侧导航包含：仪表盘、成员管理、开发环境（宿主机）、AI 大模型、系统镜像、管理员、操作记录、其他配置。下面分别说明每个页面的功能和操作方式。

仪表盘

当前为「敬请期待」状态，后续将提供团队概览数据。

成员管理

成员管理页面分为两个区域：团队成员 和 分组。

团队成员

查看成员列表

  • 页面展示所有团队成员，每人显示头像、姓名、邮箱、加入时间、最后使用时间
  • 顶部显示「当前成员数量 / 成员上限」

添加成员

  1. 点击「添加成员」按钮（若已达成员上限则按钮不可用）
  2. 在弹窗的文本框中输入邮箱地址
  3. 支持批量添加：多个邮箱用分号、逗号或换行分隔，例如：user1@example.com; user2@example.com
  4. 点击「添加」完成

管理成员

每个成员右侧有「更多」菜单：

  • 设为禁用：禁用后该成员无法登录，名称会显示删除线
  • 设为启用：将已禁用的成员恢复为可用状态
  • 重置密码：系统会向该成员邮箱发送密码重置邮件，成员通过邮件链接自行设置新密码

分组

分组用于将成员归类，便于后续为宿主机、镜像、模型等资源分配使用权限。

添加分组

  1. 点击「添加分组」
  2. 输入分组名称
  3. 点击「添加」

管理分组

每个分组右侧有「更多」菜单：

  • 修改名称：修改分组名称
  • 调整成员：打开成员选择框，勾选或取消勾选成员，点击「保存」更新该分组的成员列表
  • 删除：删除该分组（需确认）

查看分组成员

点击分组下方的「X 个成员」，可弹窗查看该分组下的成员列表。

开发环境（宿主机）

管理团队接入的宿主机，宿主机用于创建开发环境（虚拟机）。

绑定宿主机

  1. 点击「绑定宿主机」
  2. 弹窗会显示一段安装命令
  3. 以 root 权限登录你的 Linux 服务器，复制并执行该命令
  4. 执行成功后，刷新页面，宿主机会出现在列表中

查看宿主机列表

每个宿主机卡片显示：

  • 备注或名称、IP
  • 状态（在线/离线等）
  • 核数、内存、架构
  • 开发环境数量及正在使用的数量
  • 所属分组
  • 当前正在使用的开发环境及占用者

修改宿主机

  1. 点击宿主机右侧「更多」→「修改」
  2. 可修改：
    • 备注：便于识别的名称
    • 可使用该宿主机的分组：勾选哪些分组的成员可以使用该宿主机创建开发环境
  3. 点击「保存」

移除宿主机

点击「更多」→「移除」，确认后该宿主机将从团队中移除。

镜像管理

管理团队可用的系统镜像，用于构建开发环境。

绑定镜像

  1. 点击「绑定」按钮
  2. 填写：
    • 镜像名称：Docker 镜像地址，例如 docker.io/library/ubuntu:24.04
    • 备注：可选，便于识别
    • 可使用该配置的分组：勾选哪些分组的成员可以使用该镜像
  3. 点击「保存」

查看镜像列表

每个镜像显示名称、备注、完整镜像地址、所属分组。

修改镜像

  1. 点击镜像右侧「更多」→「修改」
  2. 可修改备注和可使用该镜像的分组
  3. 点击「保存」

移除镜像

点击「更多」→「移除」，确认后该镜像将从团队中移除。

AI 大模型

管理团队可用的 AI 模型，供成员在任务中使用。

添加模型

  1. 点击「添加模型」或卡片上的添加按钮
  2. 填写：
    • API Token：模型服务的 API 密钥
    • 模型 API 地址：默认百智云地址，可改为自建或第三方地址
    • 接口类型：根据模型选择（如 OpenAI Chat、Anthropic 等）
  3. 点击「获取模型列表」拉取该地址下的可用模型
  4. 选择要添加的模型
  5. 可使用该配置的分组：勾选哪些分组的成员可以使用该模型
  6. 点击「保存」，系统会先检查连接，通过后完成添加

查看模型列表

每个模型显示名称、接口类型、健康状态、所属分组。

管理模型

每个模型右侧有「更多」菜单：

  • 检查：测试模型连接是否正常，弹窗显示检查结果
  • 修改：修改 API 配置、分组等
  • 移除：从团队中移除该模型（需确认）

操作记录

查看团队内的操作日志，便于审计和排查问题。

查看记录列表

表格展示每条记录的时间、用户、操作类型、来源 IP。

操作

  • 每页显示：可选择每页 10、20、50、100 条
  • 翻页：使用底部的「首页」「上一页」「下一页」按钮
  • 查看请求：点击某条记录的「查看请求」，弹窗显示该次操作的请求内容（JSON 格式）
  • 查看响应：点击「查看响应」，弹窗显示该次操作的响应内容

管理员

管理拥有企业管理后台权限的管理员账号。

查看管理员列表

展示所有管理员，每人显示头像、姓名、邮箱、加入时间、最后使用时间。

添加管理员

  1. 点击「添加管理员」
  2. 输入邮箱地址和姓名
  3. 点击「添加」
  4. 系统会向该邮箱发送邀请，对方按邮件指引完成注册后即可登录管理后台

重置密码

点击某管理员右侧「更多」→「重置密码」，确认后系统会向该管理员邮箱发送密码重置邮件。

十六、常见问题

Q：如何创建项目？
A：在左侧「开发项目」区域点击「+」按钮，输入项目名称，选择已绑定的 Git 身份，从该身份下授权的仓库列表中选择要关联的仓库后提交即可。若尚未绑定 Git 账号，需先在配置中完成绑定，详见「七、开发项目」→「如何创建项目」。

Q：如何绑定 GitHub？
A：进入「配置」→「Git 平台身份凭证」→ 点击「绑定 GitHub」，按页面提示完成 GitHub App 安装即可。

Q：任务执行失败怎么办？
A：可在任务详情页刷新页面重试，或回到新任务页（/console/tasks）重新创建任务。系统会重新创建开发环境。

Q：如何接入自己的电脑作为开发环境？
A：进入「配置」→「宿主机」→ 点击「获取安装命令」，将命令复制到本地终端执行。执行成功后，你的电脑会出现在宿主机列表中。

Q：子账号和主账号有什么区别？
A：子账号在创建任务时可以选择宿主机和系统镜像；主账号会使用团队或系统默认配置。

如有更多问题，可点击页面顶部的「帮助文档」查看官方文档，或扫码加入微信交流群。