Repository Index Management
Repository indexes help you quickly search and retrieve relevant information within your repositories. You can create and delete cloud indexes on the console. The created indexes can be synchronized to the CodeArts Agent client.
CodeArts Agent supports two types of indexes: local indexes (created on the client) and cloud indexes (created on the console).
This section describes how enterprise members manage cloud indexes on the console. For details about how to manage local indexes on the client, see Repository Index.
| Dimension | Local Indexing | Cloud Indexing |
|---|---|---|
| Storage location | Index files are stored locally (under .codegraph in the current project's root directory). | For the initial build, the complete index package is uploaded and stored in the cloud. Incremental indexes generated due to code changes are stored locally (under .codeartsdoer/.codebase in the current project's root directory). |
| Search capabilities | Search by keyword, symbol, and file name is supported. | Semantic understanding and repository-wide code logic analysis are supported. |
| Build rules |
| |
| Update rules | Automatic update upon file changes | Indexes are automatically updated when Auto Update is enabled and the number of repository files is less than 50,000. In other scenarios, manual operations are required. |
Constraints
| Category | Package Edition | Description |
|---|---|---|
| Language | - | Java, JavaScript, TypeScript, Go, ArkTS, C, C++, Python, Vue, and Lua. |
| Seats | - | Only accounts with enabled seats can create and delete the cloud indexes. |
| Total number of code files | Free | Up to 5,000 code files can be indexed. |
| Basic | Up to 50,000 code files can be indexed. | |
| Professional | Up to 100,000 code files can be indexed. | |
| Functions | Free | Only user-level cloud repository indexes can be created. |
| Basic/Professional | Cloud repository indexes of the enterprise, team, and user levels can be created. |
Creating Cloud Indexes
You can use repository indexes to build a vector index, enabling intelligent, feature-level retrieval and precise matching based on code semantics.
- Log in to the CodeArts Agent console as an enterprise member or administrator.
- Choose Agent Settings > Repository Index.
- Click Create Repository and set basic index information.
Table 3 Repository index parameters Parameter
Description
Visible To
Visible scope of the repository index.
- Private: available only to members themselves.
- Team: available only to team members and created by the enterprise administrator, team administrator, or team members.
- Enterprise: available to all enterprise members and created by the enterprise administrator, team administrator, enterprise members, or team members.
Available Team
This parameter is displayed only when Applied To is set to Team.
Enterprise administrators can view all teams but can select only one, while team administrators can only view and select the team they belong to.
code source
Source of the code repository that you want to index.
- Git: a general Git repository.
- GitHub: a GitHub repository, which can be a public repository or an authorized private repository.
Authorization Method
Select a service endpoint from the drop-down list. The endpoint corresponds to the connection information of the GitHub or Git repository.
If no service endpoint has been created, click creation to create one by referring to Table 4.
Language
This parameter is displayed only when code source is set to Git.
Select a language from the drop-down list.
Default Branch
This parameter is displayed only when code source is set to Git.
Enter the branch name of a Git repository. The branch name can contain a maximum of 200 characters.
Table 4 Service endpoint parameters Parameter
Description
Connection Name
Name of the custom repository to be connected.
Naming rules: The name can contain letters, digits, underscores (_), and hyphens (-), but cannot start with an underscore.
Git URL
This parameter is displayed only when Code Source is set to Git.
HTTPS access address of the Git repository
User Name
This parameter is displayed only when code source is set to Git.
User name for HTTPS authentication of the Git repository.
Password or Access Token
This parameter is displayed only when code source is set to Git.
Password or access token for HTTPS authentication of the Git repository.
Access Token
This parameter is displayed only when code source is set to Github.
Access token for HTTPS authentication of the GitHub repository.
- If you set code source to Git, click OK to create the repository index. If code source is set to GitHub, click Next, select your repository and language, and click OK.
When its status changes from parsing to parsing completed, the code has been successfully parsed and the index has been successfully created.
- Open the client and navigate to the target repository project. The system will automatically synchronize the repository index from the cloud.
When the progress reaches 100%, the repository index has been synchronized.
- Verify that the index has been successfully created.
Describe your requirements in natural language. The system invokes the CodeSemanticSearch tool to perform in-depth code search based on natural language semantics, breaking through keyword restrictions.
How is request status processing implemented?
Deleting Cloud Indexes
Table 5 shows the operation permissions of different roles to delete repository indexes.
| Role | Enterprise-Level Repository Index | Team-Level Repository Index | User-Level Repository Index |
|---|---|---|---|
| Enterprise administrator | All repository indexes | All repository indexes | All repository indexes |
| Team administrator | All repository indexes created by the user | All repository indexes created by a team administrator and team members | All repository indexes created by the user |
| Team member | All repository indexes created by the user | All repository indexes created by the user | All repository indexes created by the user |
| Enterprise member | All repository indexes created by the user | No operation permissions. | All repository indexes created by the user |
| Operation | Procedure |
|---|---|
| Delete a specified repository index. | When there are only several indexes, you can delete them one by one.
|
| Delete the repository indexes in a batch. | If there are many indexes, you can delete them in batches.
|
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot