Help Center/ CodeArts Agent/ User Guide (IDE)/ Context/ CodebaseWiki
Updated on 2026-09-17 GMT+08:00
View PDF
Share

CodebaseWiki

CodebaseWiki generates structured documentation for your project and continuously syncs with code changes to keep the documentation up to date. When you look up development knowledge, interpret code, or add new features, it also performs in-depth analysis of the project structure and code implementation, and combines knowledge bases with chat context to provide more precise and detailed answers and list documentation references, enabling the agent to fully understand your code repositories.

CodebaseWiki comes with a built-in retrieval tool, Knowledge, which is automatically invoked when the agent needs to query CodebaseWiki content.

Constraints

Table 1 Constraints

Category

Description

Number of code files

≤ 10,000

Generating CodebaseWiki Documentation

  1. Log in to CodeArts Agent IDE as instructed in Quick Start.
  2. Click in the IDE's left sidebar menu and click Generate to start generating the CodebaseWiki documentation.
  3. View the generated CodebaseWiki documentation.

    Once the generation is complete, the following two folders are automatically generated, and a dedicated directory .codeartsdoer/.codebase/branches/main/docs is created in your project to house the two folders.

    • codebase-knowledge: stores global knowledge about a repository, that is, general information about the repository.
    • project-knowledge: stores project-specific knowledge, that is, business-related information for this project, including business descriptions, project configuration, and business processes.
    Figure 1 Documentation generated

  4. Update generated CodebaseWiki documentation.

    CodebaseWiki does not generate static documentation, but keeps synchronized with the code. After the initial generation, the system continuously monitors code changes. When you modify a code file, the system detects discrepancies between the code and the CodebaseWiki documentation. At this point, click Update to regenerate the sections affected by the changes.

Parent Topic: Context