驭码CodeRider 2.0产品概述和快速入门

驭码CodeRider 2.0产品概述

一、 CodeRider 2.0产品介绍

驭码CodeRider 是极狐GitLab 推出的基于生成式人工智能技术的新一代软件生产工具，为开发者提供自然语言生成代码、代码补全、代码调优纠错、单元测试生成、代码解释以及智能技术问答等功能。CodeRider 与 GitLab 深度融合，为企业提供软件开发全生命周期（SDLC）的支持，涵盖项目快速上手、企业文档库/代码仓智能问答、议题管理、合并请求智能辅助、代码智能评审、安全扫描智能解析、流水线管理等功能。

核心场景

1. 智能全栈开发

CodeRider 帮助您从零开始搭建完整项目，自动生成技术方案和完整代码。无论是设计多系统协作架构，还是拆分并执行任务细节，都能提供清晰指引和现成代码，让复杂工程开发周期大幅缩短。

2. 实时编程助手

CodeRider 在您研发过程中，根据项目代码仓库内容实时生成代码推荐，同时可根据代码文件为您生成单元测试、代码优化建议等。CodeRider 旨在为您提供沉浸式代码辅助体验，借助其流畅的代码生成速度，帮助您提升编程效率。

3. 智能 DevOps 辅助

CodeRider 为极狐GitLab 的研发全生命周期提供 AI 赋能，打造简单易用的智能辅助研发流程，提升您的组织合作研发效率。

4. 智能研发对话

CodeRider 支持多轮对话技术问答，并结合企业私有文档、企业私有代码等核心数字资源，为您高效解决工作中的问题，提升企业内部数字资源的应用价值。

产品优势

安全合规，数据主权自主可控：

支持企业本地化部署或私有云部署，确保代码、数据及知识资产全程隔离，满足企业对数据隐私和安全性的严格要求，为业务提供可信度和安全性保障。

灵活适配，多场景无缝迁移：

提供多种部署模式，包括私有化、SaaS 和混合云，满足不同企业的 IT 基础架构需求。企业可以根据自身需求，选择最优的部署方案，实现资源的灵活调度和可控管理。

模型能力持续进化，成本效率双优：

采用 SOTA 大模型技术，确保技术的长期可控性和最优性能。大模型能力密度平均每百天翻一倍，同时结合小型化、高质量、高响应、低成本的优化方案，提供精准、高效的智能编程体验。

深度集成 GitLab，重塑 DevOps 智能体验：

原生支持 GitLab，基于 GitLab 的用户体系、知识库和代码管理机制，提供 AI 赋能的 DevOps 解决方案。支持需求理解、代码编写、合并请求处理、代码审查等功能，助力企业高效协作、提升研发效能。

复杂任务全流程智能开发：

支持复杂任务的拆解、规划和执行，结合大模型能力自动生成开发方案，并在代码编写、调试、测试等各个环节提供智能辅助，提升开发效率与代码质量，实现端到端的智能化开发流程。

二、 CodeRider 2.0 产品功能

1、 Loom - 智能化端到端项目开发

a.复杂任务拆解与分析：自动分解复杂编程任务，生成可执行的子任务方案，并提供优化建议。
b.跨文件读取、编辑代码文件：支持跨多个文件解析和修改代码，实现智能代码生成与重构。
c.错误信息自反馈与纠正：自动捕捉错误信息，分析根因并生成修复建议，优化代码质量。
d.终端指令执行：智能解析和执行终端指令，辅助开发者高效完成环境配置与调试操作。

2. 代码智能评审

a.代码提交预审核：提交修改代码前进行代码预审核，帮助用户将代码评审前置，提升开发效率。
b.文件级代码智能审核：生成文件级 AI 代码审核建议，同时支持在 IDE 中查看 MR 代码变更细节并评审。
c.代码审核 Agent：智能化审核合并请求代码变更，可结合 SAST 扫描结果给出审核建议，同时支持项目级个性化配置评审规则。

3. 代码智能生成/补全

a.代码智能实时补全：跨文件实时生成单行或多行代码推荐，支持灵活选择代码补全的模型引擎。
b.自然语言生成代码：在 IDE 中使用自然语言描述生成代码。

4. 智能辅助编程

a.项目引导：为项目提供快速引导功能，帮助用户快速上手项目代码。
b.代码解释：对选中的代码实现自动识别编程语言并生成代码解释。
c.代码注释：针对选中代码生成行间注释，帮助用户逐行理解代码。
d.代码修改：根据用户输入的代码修改指令完成对选中代码的修改。
e.单元测试：针对选中代码生成单元测试代码，帮助用户准确、高效地测试函数或代码片段。
f.代码优化：针对选中代码生成改进建议，以提升代码的可读性、可维护性、安全性等。

5. 智能 DevOps 助手

a.处理议题：用户讨论议题过程中AI自动生成概览，帮助用户高效地阅读议题信息，提升理解效率。
b.生成提交信息：为提交的代码变更智能生成提交信息，同时支持用户修改。
c.处理合并请求：智能生成合并请求摘要，包含合并请求的概述、变更内容、影响范围、预期结果等，帮助用户高效地理解合并请求的相关信息。
d.管理流水线：支持查看流水线状态、管理流水线、下载流水线产物、创建流水线。
e.查询和处理更多 DevOps 任务：查询议题、查看合并请求、查看史诗、查看代码片段、查看漏洞，同时支持自定义配置任务面板。
f.GitLab 快捷操作命令：支持20多种GitLab快捷操作命令，快速调起 GitLab 多种操作和相关功能。

6. 智能问答

a.自然语言多轮技术问答：提供灵活的问答模型，为用户打造 IDE 中沉浸式研发技术问答环境。
b.知识库问答：支持基于私有文档库的问答，并支持用户灵活设置知识库的创建、删除、更新等。
c.企业代码问答：支持基于代码库的技术问答，并支持用户灵活设置代码知识库的创建、删除、更新等。
e.智能研发问答平台：企业非技术用户无需依赖编程 IDE 即可体验 CodeRider 问答功能，助力团队高效管理和利用企业内部文档，提升企业数字资产价值。

前提条件

1、个人用户：已成功注册极狐GitLab SaaS账号，注册地址为：https://jihulab.com/users/sign_up。
2、私有化部署企业用户：已成功部署极狐GitLab 与驭码CodeRider，并拥有企业 GitLab 账号。
3、版本说明：驭码CodeRider 目前支持 Visual Studio Code（1.85 及以上版本）。
4、操作系统说明：驭码CodeRider 目前支持 Windows 10/11，Linux（主流发布版）、macOS 系统使用。

驭码CodeRider 2.0快速入门

一、安装与登录驭码CodeRider2.0

步骤一：准备工作

下载并安装 Visual Studio Code 1.85.0(https://code.visualstudio.com/download)及以上版本。

步骤二：从插件市场安装 CodeRider2.0

方法一：通过 Visual Studio Code 插件市场安装

快速安装：唤起 Visual Studio Code 插件市场直接安装 CodeRider，安装后请重启 IDE，即可开启智能编码之旅。
1、打开 Visual Studio Code 扩展窗口，搜索“驭码 CodeRider”，找到插件后点击安装。
2、插件安装完成后，请重启 IDE。

方法二：下载安装包

1、下载 CodeRider 插件安装包。
2、下载完成后，打开 Visual Studio Code，选择“扩展”>“视图和更多操作”>“从 VSIX 安装”，选择下载的插件安装包并完成安装。
3、插件安装完成后，请重启 IDE。

步骤三：登录 CodeRider2.0

1、单击导航栏的驭码 CodeRider，输入驭码实例地址，并勾选相关协议后，选择登录方式。 注：中国大陆 SaaS 用户的驭码实例地址为：https://coderider.jihulab.com（默认）。若您为私有化部署企业用户，请联系企业管理员获取驭码实例地址。

2、登录方式一：OAuth 登录
a.选择 OAuth 登录方式后，打开外部授权登录网站。
b.在跳转的 Web 网页端点击授权 CodeRider 后再次点击打开 Visual Studio Code。
c.请于 1 分钟内在 Visual Studio Code 中点击允许 CodeRider 打开此 URL，之后稍等片刻即可看到登录完成的状态。

3、登录方式二：PAT 登录
a.选择“个人访问令牌登录”（PAT）方式后。若您为首次使用 PAT 登录的用户，请点击“创建” PAT。若您已有 PAT，请直接跳转第 e 步。
b.在创建 PAT 页面，请完成以下配置：
输入“令牌名称”，默认为“CodeRider”，可无需修改。
设置 PAT 到期时间，建议取消时间限制，则有效期为一年。
选择范围勾选：api。
c.配置完成后，点击“创建个人访问指令”。
d.注意：由于无法再次访问该 PAT，请复制并妥善保存。
e.将创建好的 PAT 填写到对应位置，建议勾选“记住当前 PAT”以便后续登录使用，点击“登录”即可登录成功。

二、JetBrains IDEs / Android Studio 安装与登录指南

安装与登录驭码CodeRider2.0

步骤一：准备工作

下载并安装 JetBrains IDEs 2024.1.* 系列及以上版本或 Android Studio 2024.1.* 系列及以上版本。

步骤二：在 IDE 中安装 CodeRider

提示：下述内容以在 IntelliJ IDEA 中安装 CodeRider 为例。

方法一：从插件市场安装

1、打开 IntelliJ IDEA 设置窗口，在插件市场搜索“JiHu-GitLab CR”，找到插件后点击安装。
2、插件安装完成后，请重启 IDE。

方法二：下载安装包安装

1、下载 CodeRider 插件安装包。
2、下载完成后，打开 IntelliJ IDEA 设置界面，从插件管理的下拉菜单中选择从本地安装插件，选择下载的插件安装包并完成安装。
3、插件安装完成后，请重启 IDE。

步骤三：登录

1、单击导航栏的 CodeRider，输入驭码实例地址，并勾选相关协议后，选择个人访问令牌登录。
2、若您为首次使用 PAT 登录的用户，请点击“创建” PAT。若您已有 PAT，请直接跳转第 3 步。
a.在创建 PAT 页面，请完成以下配置：
输入“令牌名称”，默认为“CodeRider”，可无需修改。
设置 PAT 到期时间，建议取消时间限制，则有效期为一年。
选择范围勾选：api。
b.配置完成后，点击“创建个人访问指令”。
c.注意：由于无法再次访问该 PAT，请复制并妥善保存。
3、将 PAT 填写到对应位置，建议勾选“记住当前 PAT”以便后续登录使用，点击“登录”即可登录成功。

三、 Loom 使用指南

注意：使用驭码CodeRider Loom，需要将 VS Code 插件 CodeRider 升级至最新版本（2.0.0 版本）。目前仅支持 VSCode 使用。
驭码CodeRider Loom 可系统化处理复杂软件开发任务，通过创建编辑文件、解析项目架构、安全访问浏览器及授权执行终端指令的全流程覆盖，提供超越传统代码补全的全栈级支持。

在与 Loom 的合作研发中，需要注意以下几点建议：

1、**需求描述清晰：**建议用分点描述或模板化字段（如任务、目标、步骤、限制条件）明确需求，详细列出待开发任务要求，尽量将抽象要求转化为具体参数。
2、复杂需求拆解：对多步骤任务（如“开发一个登录系统”），建议拆分为独立子任务（验证码生成、数据库连接、密码加密）分次生成并组合。
3、明确生成要求：编程任务尽量指定输出规范，声明编程语言、框架版本、代码规范（如PEP8）等。另外，需要提前声明不需要的内容（如“避免使用过时库”“禁止硬编码密码”）。
4、反馈迭代优化：AI 可能无法做到完全准确生成需求。若输出结果不符预期，可提供错误代码片段并指定修改方向（如“循环逻辑冗余，请改用哈希表优化”）。

快速上手

Loom 可与用户共同完成研发任务，开发过程中整体交互界面如下：

使用说明

1. 常规任务

1、设置工作模式：
a.计划：计划模式下，Loom 将会根据需求完成任务计划。
b.执行：执行模式下，Loom 将立即完成任务。

2、在 CodeRider 插件中打开 Loom 面板，并在输入框中描述需求。在描述需求时，可通过输入 “@” 获取内容，或者 “#” 索引文件夹、文件。
a.“@问题”：检查当前项目中的代码或配置错误，以便于 Loom 修复。
b.“@终端”：执行终端操作。
c.“@Git 提交”：选择 Git 提交记录来完成操作。
d.“#文件夹或文件”：索引文件夹或文件内容作为上下文。

3.输入项目需求后，Loom 将对任务进行拆解，并按步骤执行。在此过程中，Loom 将协助您安装项目运行所需的依赖环境，并将编程实现结果以 diff 的形式显示在工作区。

4、项目代码编写完成后，保存所有代码变更并运行项目。

2. GitLab 任务

**注：**使用该功能，需要确保您当前打开的项目托管在连接的 GitLab 实例上。

若您希望直接处理 GitLab 中的任务时，请在 CodeRider “工作流”面板中找到对应的 Issue，并单击“Loom 执行”，Loom 将直接读取您的待处理需求并执行。

**注：**若希望 Loom 有较好的执行效果，请确保您的 Issue 描述清晰，并将复杂任务进行必要拆解。

四、智能研发问答平台使用指南

CodeRider 提供企业级问答平台，支持自然语言问答、企业知识库问答、企业代码问答功能。企业非技术用户无需依赖编程 IDE 即可体验 CodeRider 问答功能，助力团队高效管理和利用企业内部文档，提升企业数字资产价值。请登录智能研发问答平台体验问答功能。

登录

1、若您为 SaaS 用户，请点击智能研发问答平台，并跳转授权登录。
2、若您为私有化部署用户，请联系企业管理员，获取登录网址。

自然语言多轮对话

当配置模型生效后，您可以灵活选择云端模型、私有模型（企业私有化部署用户）来完成问答。同时，CodeRider 支持多轮对话问答，能够快速响应开发人员的问题，并提供准确的解决方案。

CodeRider 会在当前会话框首次聊天时，生成会话标题摘要。同时，支持在界面顶部单击修改会话标题。

知识库配置与使用

知识库配置

CodeRider 的知识库功能权限依赖于 GitLab 项目权限，拥有项目“维护者”及以上权限的用户，可以将对应的 GitLab 项目创建、更新和删除对应知识库；拥有项目“访客”及以上权限的用户，可以调用该知识库，但无法对知识库进行创建和删除操作。

创建知识库时，如您希望基于当前项目的其他分支创建，请同时输入“知识库分支名”参数，若未输入将默认基于受保护的分支创建。同时创建知识库过程会显示创建进度，当您手动点击界面“刷新”或者重新打开界面时，将会看到进度更新。

当知识库对应的项目在 GitLab 平台被更新后，您可以手动触发“更新知识库”以同步更新。

目前，CodeRider 支持文档和代码两种类型，为保障您的体验效果，在创建知识库时请按需选择，同时确保您单个文件小于 10 MB。关于已支持的文件类型，请参考：

a.“文档”类型的知识库，目前已支持的文件类型为 .txt、 .doc、 .docx、 .ppt、 .pptx、 .md、 .mdx、 .pdf (experimental), .yaml, .yml。
b.“代码”类型的知识库，目前已支持的文件类型为 Python(.py)、Go（.go）、Ruby（.rb）、JavaScript(.js)、TypeScript（.ts）、Java(.java)、CPP(.cpp,.cc)、C(.h,.c)、C#(.cs)、Rust(.rs)、Kotlin(.kt)、HTML(.html)、CSS(.css)、SQL(.sql)。
注：
a.SaaS 免费用户单个知识库文件数上限为500个，付费用户单个知识库文件数上限为1000个。
b.创建、更新知识库时可能需要稍作等待，在等待过程中您可通过“刷新”按钮确认知识库的创建、更新状态。

知识库使用

CodeRider 支持基于云端模型、私有模型（私有化部署企业）的企业知识库功能，拥有访客及以上权限的用户可以在对话框“@” 知识库名称，并针对知识库内容进行技术问答。

代码审核使用指南

代码评审功能配置

1. 配置 GitLab SAST

**注：**如果您无需使用 SAST 结果作为代码评审参考，请直接跳转第 2 步“Webhook 的配置”。
1.确认您是 GitLab 旗舰版用户，参考 GitLab 官方文档配置。
2.在 .gitlab-ci.yml 文件中增加 artifacts 的 paths 配置。

2. Webhook的配置

拥有项目“开发者”及以上权限的用户，打开项目“设置”的“Webhooks”，点击“添加新的 webhook”。

2.1 输入下列对应信息：

1.URL：

2、选择“显示完整的URL”。

输入“Secret 令牌” ：Secret 令牌请联系企业管理员获取。
私有化部署客户企业管理员参考：私有化部署的令牌需在企业管理平台生成：

3、“触发来源”勾选：评论、合并请求事件。

4、勾选“启用SSL验证”。

2.2 配置信息填写完成后，点击“添加webhook”确认配置即可配置成功。

补充说明：

若 Webhook 的 URL 未配置用户 PAT，则需要邀请 CodeReview Agent 进入待评审的项目或群组，邀请方式： 将“CodeRider Agent”邀请成为项目成员，并赋予“开发者”权限。

3. 项目级别的评审规则配置

确保您待合并分支有文件 .coderider-review.toml。

配置参数说明：

**config 区块：**控制基本行为
mr_max_files：限制每个合并请求中分析的最大文件数，防止审查过于复杂的变更
**coderider_code_suggestions 区块：**控制代码建议生成
num_code_suggestions：控制为每个问题提供的代码改进建议数量
extra_instructions：为代码生成提供额外上下文和指导方向
**coderider_reviewer 区块：**控制代码审查行为
extra_instructions：为代码审查提供额外指导和重点关注领域
通过适当配置，可以使 CoderRider 关注团队特定的编码标准、安全问题或性能优化等方面。

代码评审功能使用

CodeRider 支持 GitLab 项目基于 Web 端调用 MR 代码审核 Agent。当群组/项目代码仓已配置好审核功能后，触发方式：

1、无需使用 SAST 扫描结果作为评审参考：
首次提交 MR，触发 MR 时自动评审。
当再次提交合并请求时，需手动触发代码审核，触发方式：在已提交的 MR 审核框输入@CODERIDER_AGENT /coderider-review即可启动评审，稍等片刻即可看到评审建议。
2、需使用 SAST 扫描结果作为评审参考：
需要在 SAST 扫描任务运行成功后手动触发，触发方式：在已提交的 MR 审核框输入/coderider-review即可启动评审，稍等片刻即可看到评审建议。
评审意见操作：CodeRider 支持您针对评审建议进行修改、评论，或点击“应用建议”再次提交变更代码。

企业管理平台使用指南

1. 用户管理

**说明：**私有化部署的企业客户拥有用户管理权限，企业管理平台域名为：CodeRider 域名/admin。

1.1 查看企业成员

管理员登录 CodeRider 企业管理平台，选择“用户”即可查看已登录的所有用户信息，包含 GitLab 用户名、用户邮箱、创建时间及失效时间。同时支持依据 GitLab 用户名或用户邮箱搜索用户。

1.2 添加企业成员

管理员登录 CodeRider 企业管理平台，选择“注册白名单”即可添加 CodeRider 企业用户。

1.3 企业成员信息修改

管理员登录 CodeRider 企业管理平台，在“注册白名单”界面选择对应的用户，点击“编辑”即可修改企业成员信息。

1.4 删除企业成员

管理员登录 CodeRider 企业管理平台，在“注册白名单”界面选择对应的用户，点击“删除”并二次确认后，即可删除对应用户的 CodeRider 企业用户权限。

2. 企业模型配置

CodeRider 提供企业管理员统一配置企业用户的模型权限，在开发者使用 CodeRider IDE 插件时，可继承来自企业管理员的配置。

企业内管理员登录 CodeRider 企业管理平台，在“模型配置”界面选择功能可使用的引擎及默认引擎，点击“确认”后即可设置成功。

3. 企业公共知识库配置

CodeRider 支持您将企业沉淀的文档、代码设置为企业公共权限的知识库。配置步骤参考：

1、请先参考 CodeRider 插件配置指南将企业文档、代码设置为知识库。
2、CodeRider 企业管理员登录 CodeRider 企业管理平台，将该知识库对应的项目仓链接“新增”为企业公共权限。

若您需要删除知识库的企业公共权限，点击知识库对应的“移除”按钮，并二次确认后，即可移除。

注：在企业管理平台上，新增或移除企业公共知识库的操作，仅修改知识库的可见范围。即“新增”时相当于将已有知识库修改为企业公共权限；“移除”时，仅取消其企业公共权限，但其仍然为知识库。

4. 企业指令配置

CodeRider 支持企业管理员为企业用户创建插件端的快捷指令。创建步骤参考：
1、登录企业 CodeRider Admin 平台打开“指令管理”界面。
2、点击“新建指令”并输入指令名称、指令描述（非必填）及提示词，选择是否启用指令，并确认。
a.指令名称：不超过20字，且不能与官方指令、其他企业指令重名，不超过 20 字。
b.指令描述：对当前指令的简单描述，方便用户理解指令的功能，不超过 50 字，非必填。
c.提示词：指令的提示词内容，需尽量简洁、清晰，如有复杂任务请将任务进行拆解，不超过 1000 字。

同时，支持对已有企业指令的 修改、删除、是否启用操作：
a.修改：双击对应企业指令卡片。
b.删除：点击对应企业指令“删除”按钮。
c.是否启用：点击对应企业指令开关按钮。