代码库索引
华为云码道(CodeArts)代码智能体提供了代码库索引功能,帮助您快速检索并获取代码相关信息。该功能支持创建本地个人索引与云端共享索引,灵活适配不同场景需求。
约束与限制
| 限制类别 | 具体限制 |
|---|---|
| 语言 | 支持Java、JavaScript、TypeScript和Go。 |
| 代码文件总数 |
|
| 功能限制 | 仅码道代码智能体基础版和专业版支持创建云端团队级和企业级代码库索引。 |
本地个人索引和云端索引的差异
| 对比维度 | 本地个人索引 | 云端索引 |
|---|---|---|
| 使用者 | 当前用户 |
|
| 仓库类型 | 不限制 | 支持Git、Repo和Github三种仓库。 |
代码库索引命令行参数
支持以下核心操作参数,用于管理代码库索引生命周期。
创建代码库索引
以下介绍创建本地个人索引和创建云端索引的具体步骤。
创建本地个人索引
- 进入TUI开发环境。
- 打开目标项目的根目录。
- 鼠标右键单击空白处,选择“在终端中打开”。
- 在终端中输入“/codearts”并回车,即可进入TUI开发环境。
- 创建代码库索引。在对话框中输入“/codebase/init”并回车,即可开始创建索引。 图1 输入索引创建命令
- 查看索引创建进度。在对话框中输入“/codebase/detail”并回车,即可查看索引创建进度。 图2 查看索引创建进度
- 增量更新代码库索引。在对话框中输入“/codebase/update”并回车,即可对新增或修改的内容进行索引。
系统会对比当前状态与上一次增量更新的结果,仅对新增或修改过的代码文件进行索引,跳过未变更文件以节省时间。
- 删除代码库索引。如果需要清除当前所有索引数据,可在对话框中输入“/codebase/delete”并回车。
创建云端索引
- 进入码道代码智能体控制台。
- 在左侧导航栏选择“智能体设置 > 代码库索引”,进入代码库索引页面。
- 单击“新建索引”,进入新建代码库索引页面。
- 参考表4,设置索引基本信息,单击“下一步”。
表4 代码库索引参数说明 参数
说明
可见范围
定义代码库索引的可见范围。仅码道代码智能体基础版和专业版,支持创建云端团队和企业代码库索引。
- 个人:仅成员本人可用。
- 团队:仅本团队成员可用,由企业管理员、团队管理员或团队成员创建。
- 企业:所有企业成员都可用,由企业管理员、团队管理员、团队成员或企业成员创建。
可用团队
“可见范围”设置为“团队”时,才会显示该配置项。
在下拉列表中选择团队,仅展示当前账号所属团队。
代码源
选择您想要索引的代码仓库来源。
- Repo:代码托管(CodeArts Repo)中的仓库。
- Git:通用Git仓库。
- Github:GitHub平台仓库,支持公开仓库及经授权的私有仓库。
选择项目
“代码源”设置为“Repo”时,才会显示该配置项。
从已关联的代码源中,选择具体要索引的项目。
获取授权
选择一种方式来授权系统访问您的代码源。
- 通过服务授权:在下拉框中选择服务扩展点,该扩展点对应Repo、Github或Git仓库的连接信息。
若还未创建服务扩展点,单击“添加”,参考表5创建服务扩展点。
- 通过个人访问令牌:使用用户个人账户生成的访问令牌进行认证。
默认分支
“代码源”设置为“Git”时,才会显示该配置项。
输入Git仓库的分支名称,分支名称不能超过200个字符。
图3 新建服务扩展点
表5 服务扩展点参数说明 参数
说明
连接名称
自定义连接仓库的名称。
命名规范:由中文、英文、数字、下划线和中划线组成,不能以下划线开头。
Git仓库Url
“代码源”设置为“Repo”或“Git”时,才显示该配置项。
Repo/Git仓库的HTTPS访问地址。
用户名
“代码源”设置为“Repo”或“Git”时,才显示该配置项。
Repo/Git仓库HTTPS协议的认证用户名。
密码或Access Token
“代码源”设置为“Git”时,才显示该配置项。
Git仓库HTTPS协议的认证密码或Access Token。
Access Token
“代码源”设置为“Repo”或“Github”时,才显示该配置项。
Repo/Github仓库HTTPS协议的Access Token。
- 选择代码库和语言,单击“确定”,完成代码库索引的创建。
在代码库仓索引页面,查看新创建的代码库索引。当该代码库索引的状态由“解析中”变为“解析完成”时,表示解析代码库索引成功。
- 查看索引创建进度。
- 在Git/Repo/Github仓库项目的根目录下,鼠标右键单击空白处,选择“在终端中打开”。
- 在终端中输入“/codearts”并回车,进入TUI开发环境,系统将自动从云端下载团队代码库索引。
- 在TUI对话框中,输入“/codebase/detail”并回车,即可查看索引创建进度。