Updated on 2026-10-22 GMT+08:00

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

CodebaseWiki Commands

Table 2 CodebaseWiki commands

Command (TUI)

Command (CLI)

Function

/codebase-knowledge/init

codearts codebase-knowledge --init

Generates the CodebaseWiki documentation.

/codebase-knowledge/update

codearts codebase-knowledge --update

Incrementally updates the CodebaseWiki documentation, syncing only the code changes.

Generating CodebaseWiki Documentation

The following demonstrates how to generate CodebaseWiki documentation, using the TUI development environment as an example:

  1. Enter the TUI development environment.

    1. Open the root directory of the target project.
    2. Right-click in the blank area and select Open Windows Terminal here.
    3. In the terminal, enter codearts and press Enter to enter the TUI environment.

  2. Generate the CodebaseWiki documentation.

    1. In the chat box, enter / and select /codebase-knowledge/init to start the generation of CodebaseWiki documentation.
    2. View the generated CodebaseWiki documentation.

      Once the generation is complete, the following two folders are automatically generated, and a dedicated directory .codeartsdoer/.codebase/branches/Branch name/docs is created in your project to house the 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

  3. 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, you can regenerate the sections affected by the changes by using the /codebase-knowledge/update command.