# CodebaseWiki
CodebaseWiki能够为你的项目生成结构化文档，并且持续同步代码改动以更新文档。当你查询开发知识点、解读代码、新增功能特性时，它还会深度解析项目结构与代码实现，结合知识库与对话上下文给出更精准详尽的回答和文档参考，让智能体充分理解你的代码仓库。
CodebaseWiki自带检索工具Knowledge，智能体需要查询CodebaseWiki内容时会自动调用。
#### 约束与限制
表1约束与限制 
| 限制类别 | 具体限制 |
|:---|:---|
| 代码文件数量                          | 代码文件≤10000个                     |
   
#### CodebaseWiki命令清单
 表2CodebaseWiki命令列表 
| 命令（TUI）                      | 命令（CLI）                                | 功能说明                                     |
|:---|:---|:---|
| /codebase-knowledge/init    | codearts codebase-knowledge --init   | 生成代码库CodebaseWiki文件                      |
| /codebase-knowledge/update | codearts codebase-knowledge --update | 增量更新代码库CodebaseWiki文件，只同步代码改动的部分来更新Wiki文档 |
   
#### 生成CodebaseWiki文件
接下来以TUI开发环境为例，为你演示如何生成CodebaseWiki文件。
1. 进入TUI开发环境。 
   1. 打开目标项目的根目录。
   
   2. 鼠标右键单击空白处，选择"在终端中打开"。
   
   3. 在终端中输入"codearts"并回车，即可进入TUI开发环境。
   
   
   
   
2. 生成CodebaseWiki文档。 
   1. 在对话框中输入"/"，选择"/codebase-knowledge/init"，启动CodebaseWiki文档生成任务。
   
   2. 查看生成的CodebaseWiki文档。 任务执行完成后，会自动生成如下两个文件夹，同时会在你的项目中新建一个专属目录".codeartsdoer/.codebase/branches/分支名/docs"用于存放上述文件夹。
      - **codebase-knowledge**：存放代码库全局知识，即整个代码仓库的通用信息。
      
      - **project-knowledge**：存放项目专属知识，即本项目业务相关信息，包含业务说明、项目配置、业务流程等。
      
      
      图1文档成功生成   
      ![](https://support.huaweicloud.com/usermanual-cli/zh-cn_image_0000002765264497.png "点击放大") 
   
   
   
   
3. 更新已生成的CodebaseWiki文档。 
   CodebaseWiki并非静态文档，而是与代码保持同步。初次生成完成后，系统会持续监控代码改动。当你修改了代码文件后，系统会识别出代码与CodebaseWiki文档存在差异。此时，你只需通过"/codebase-knowledge/update"命令，即可重新生成受改动影响的文档片段。