文档首页/ 华为云码道（CodeArts）代码智能体/ 用户指南（码道CLI）/ CLI/ 命令
更新时间：2026-07-02 GMT+08:00
查看PDF
分享

命令

表1 CLI命令表

命令

描述

子命令或子参数

codearts help

查看命令帮助

无

codearts completion

生成Shell自动补全脚本

无

codearts mcp

管理MCP服务器

详细子命令请参考MCP命令

codearts [project]

启动指定项目的TUI开发环境，其中[project]是可选参数，表示目标项目名称

例如，执行以下命令，进入TUI开发模式并加载Test项目：

codearts D:\Test

无

codearts run [message]

非交互模式运行码道CLI，直接传入提示词。

例如，执行以下命令，读取当前目录下的文件： 
codearts run 读取文件

codearts run命令支持的参数列表请参考表2

codearts agent

管理智能体
  • create，创建新智能体
  • list，列出所有可用智能体

codearts models [provider]

列出可用模型

  • 例如，执行如下命令，可获取所有供应商的可用模型 
    codearts models
  • 例如，执行如下命令，可获取指定供应商“huaweicloud-maas”的可用模型 
    codearts models huaweicloud-maas

无

codearts stats

显示Token使用量和成本统计信息
执行如下命令，查看所有统计数据 
codearts stats

其余子命令请查看表3

codearts session

管理会话
  • list，列出所有会话。
  • delete <sessionID>。其中，执行codearts session list可查询sessionID，sessionID是必填参数。执行命令后，选中需删除的会话，按下回车即可

codearts export [sessionID]

以JSON格式打印出指定会话ID的数据。其中，执行codearts session list可查询sessionID

  • 例如，执行如下，选中需导出的会话，按下回车，即可打印出此会话的数据 
    codearts export
  • 例如，执行如下命令，即可打印出此sessionID的数据 
    codearts export [sessionID]

无

codearts import <file>

从本地JSON文件导入会话数据，<file>为必填参数

例如，执行如下命令，将把指定文件的数据导入，多一条sessionID数据

codearts import seesion.json

使用场景：生成这条sessionID数据后，您可以基于该ID继续会话

无

codearts upgrade

将码道CLI升级到最新版本

无

codearts uninstall

卸载码道CLI并删除所有相关文件

无

codearts docs

获取码道CLI的帮助文档链接

无

codearts privacy

查看码道CLI的隐私政策

无

codearts debug

调试与故障排查工具

涉及子命令请查看表7

codearts --version

打印版本号

无

codearts --print-logs

将日志输出到stderr

无

codearts --log-level

日志级别（DEBUG、INFO、WARN、ERROR）

无

codearts codebase

您可通过codearts codebase命令管理代码库索引

此命令支持的参数请查看表3

codearts serve

启动无界面的服务器。

在执行serve相关命令前，请先在PowerShell、CMD或者终端执行如下命令，为服务器配置用户名和密码，否则将返回如下报错：“Error: CODEARTS_SERVER_PASSWORD is not set; please configure the password to start the server.”

export CODEARTS_SERVER_USERNAME="服务器登录账号"
export CODEARTS_SERVER_PASSWORD="服务器登录密码"

其中，服务器登录账号与登录密码由用户自行设置。

此命令支持的参数请查看表10

codearts attach

将本地命令行绑定到远端码道CLI服务实例，使用用户名和密码登录，支持两种传账号密码的方式：环境变量、命令行--password参数。

此命令支持的参数列表请参考表11
表2 codearts run支持的参数列表

标志

描述

codearts run --command
  • 运行命令，使用--command <命令>。
    例如，执行如下命令，完成初始化： 
    codearts run --command init

    例如，执行如下命令，可运行test命令

    codearts run --command test
  • 使用SDD命令生成代码。格式为--command <SDD命令> <参数>。

    SDD命令支持以下四种取值：sdd-new、sdd-design、sdd-tasks和sdd-apply。参数为必填项，具体含义如下：

    • 当命令为sdd-new时，参数代表您需要执行的任务描述。
    • 当命令为sdd-design、sdd-tasks或sdd-apply时，参数代表产物文件夹名。

    在CLI中使用SDD命令时，无需在命令前添加斜杠“/”。其余功能与TUI界面保持一致。如需了解详细信息，请参见SDD。

codearts run --continue

继续上一个会话，可缩写为“-c”

例如，执行如下命令，继续上一个会话

codearts run --continue

codearts run --sessionID

要继续的sessionID，可缩写为“-s”

例如，执行如下命令，对指定sessionID执行

codearts run --fork

继续时分叉会话

codearts run --model

要使用的模型，可缩写为“-m”

codearts run --agent

要使用的代理

codearts run --file

附加到消息的文件，可缩写为“-f”

codearts run --format

格式：default或json

codearts run --title

会话标题

codearts run --thinking

显示思考块

codearts run --attach

用于连接到一个正在运行的服务器。

例如，执行如下命令，连接到正在运行的codearts服务器“http://localhost:4096”，执行问答： 
codearts run --attach http://localhost:4096 --password 12345 "hi"
表3 codearts stats支持的参数列表

命令

描述

codearts stats --days

显示最近N天的统计信息

  • 例如，执行如下命令，查看全部天数 
    codearts stats --days
  • 执行如下命令，查看近2天 
    codearts stats --days 2

codearts stats --tools

显示工具维度的统计数据

codearts stats --models

显示所有模型用量明细

codearts stats --project

显示项目的统计数据

进入需要查询的Git仓根目录下，右键选择“在终端中打开”，执行如下命令，查询当前项目的统计数据。

codearts stats --project
说明：

若目标代码仓无Git提交记录，系统会展示全部非Git仓项目数据。
表4 codearts [project]支持标志

标志

简写

描述

--continue

-c

进入TUI开发模式，继续上一个会话

例如，执行如下命令，即可进入“D:\Test”项目下，进入TUI开发模式继续对话。

codearts D:\Test -c

--session

-s

要继续的sessionID。其中，sessionID通过执行“codearts session list”获取。

codearts D:\Test -s <sessionID>

--fork

-

基于指定会话创建分叉会话。子命令如下：

  • codearts --fork -c，进入TUI开发模式，继续上一个会话
  • codearts --fork -s sessionID，基于指定的会话ID，创建分叉会话

--model

-m

要使用的模型

--agent

-

要使用的代理
表5 codearts session list支持的参数

标志

简写

描述

--max-count

-n

限制为最近N个会话

--format

-

输出格式：table或json
表6 codearts uninstall命令标志

标志

简写

描述

--keep-config

-c

保留配置文件

--keep-data

-d

保留会话数据

--dry-run

-

显示将被删除的内容

--force

-f

跳过确认提示
表7 codearts debug子命令

命令

描述

codearts debug config

含义：显示解析后的完整配置

用途：查看当前生效的所有配置（包括合并了默认值、环境变量后的最终状态），用于排查配置加载问题

codearts debug rg

含义：ripgrep（代码搜索）调试工具，涉及子命令请查看表8

用途：专门调试ripgrep相关的行为，比如搜索规则、忽略文件、路径匹配等问题

codearts debug file

含义：文件系统调试工具，涉及子命令请查看

用途：用于调试文件读取/写入、路径解析、权限、符号链接等文件相关的问题

codearts debug scrap

含义：列出所有已知项目

用途：主要用于调试，帮助开发者了解码道CLI当前识别的项目

codearts debug skill

含义：列出所有可用技能

用途：输出当前环境中加载的所有Skill，包括它们的名称、描述、位置及内容

codearts debug agent <name>

含义：查看指定智能体的配置详情，<name>是必填参数

用途：输出某个智能体（Agent）的完整配置，包括权限、工具、模型参数、提示词等，用于调试Agent行为异常

codearts debug paths

含义：显示全局路径信息

用途：输出核心目录路径，包括数据目录、配置目录、缓存目录或者状态目录，用于排查文件找不到、权限问题

codearts debug wait

含义：无限等待（用于调试），如需退出，按快捷键（Windows（Ctrl+C）/Mac（⌘+C））

用途：启动后不退出，保持进程运行，方便调试器附加到进程中进行调试
表8 codearts debug rg的子命令

命令

描述

codearts debug rg tree

含义：表示使用ripgrep展示文件目录树

用途：
  • 查看ripgrep实际“看到”的文件结构，验证哪些目录/文件被包含或排除
  • 排查.gitignore、.ignore等规则是否生效，为什么某些文件搜不到

典型场景：怀疑项目文件被意外忽略，想确认ripgrep的扫描范围

codearts debug rg files

含义：使用ripgrep列出所有文件

用途：
  • 列出ripgrep扫描范围内的所有文件（受忽略规则影响）
  • 快速对比实际文件和ripgrep可见文件的差异，定位“文件未被索引”问题

典型场景：某个文件在码道CLI里搜不到，想确认是否被ripgrep忽略

codearts debug rg search <pattern>

含义：使用 ripgrep 搜索文件内容

用途：
  • 直接调用ripgrep搜索文件内容，验证码道CLI搜索功能的底层行为
  • 对比码道CLI界面搜索结果和原生ripgrep结果是否一致，判断问题出在前端还是底层

典型场景：搜索结果缺失、匹配规则异常，用原生 ripgrep 做对比验证
表9 codearts debug file的子命令

命令

描述

codearts debug file read <path>

含义：以JSON格式读取并输出指定文件的内容

用途：

  • 直接查看码道CLI实际读到的文件内容（尤其是配置文件、状态文件）
  • 排查“文件明明存在，但码道CLI读取不到、读取内容为空或者读取格式不对的问题
  • 验证文件编码、JSON格式是否正确

codearts debug file status

含义：显示文件系统状态信息

用途：

  • 查看当前目录或者工作区的文件状态、权限、是否存在异常（如符号链接、只读权限）
  • 排查“文件权限不足”“路径不存在”等问题
  • 检查文件是否被系统锁定、占用

codearts debug file list <path>

含义：列出当前项目下指定目录下的所有文件和子目录

用途：主要用于列举项目下的目录下的文件和子目录

codearts debug file search <query>

含义：按条件模糊搜索当前项目下的文件

用途：用于快速查找跟条件相似的文件

codearts debug file tree [dir]

含义：显示指定的目录下非空目录的树结构

用途：以树形视图展示指定目录的完整结构，直观查看目录层级
表10 codearts serve支持的参数列表

参数

描述

--port

指定服务器监听端口，默认端口为4096

例如，执行如下命令，指定监听端口4096： 
codearts serve --port 4096

服务成功启动后，可打开新窗口，通过codearts attach命令连接服务器，详细操作指导可参考表1。

--hostname

服务器监听地址，默认值为127.0.0.1

例如，执行如下命令，指定服务器监听地址127.0.0.1： 
codearts serve --hostname 127.0.0.1

服务成功启动后，可打开新窗口，通过codearts attach命令连接服务器，详细操作指导可参考表1。

--mdns

启用mDNS局域网零配置服务发现，同一局域网内设备可自动扫描并访问当码道CLI，无需手动填写本机IP地址。

例如，执行如下命令，将在本机4096端口启动码道CLI，并启用mDNS局域网服务发现；同一局域网内设备可自动扫描当前服务，无需手动填写主机IP，通过.local域名即可访问Web管理页面与MCP接口。 
codearts serve --port 4096 --mdns

--mdns-domain

此参数需要配合--mdns使用，表示自定义mDNS局域网主机名前缀，默认值为codearts.local：如果用户不写--mdns-domain，系统会自动使用codearts作为前缀，拼接mDNS固定后缀.local，完整局域网域名就是codearts.local。

例如，执行如下命令，表示采用默认域名：codearts.local，访问地址为：http://codearts.local:4096 
codearts serve --port 4096 --mdns
例如，执行如下命令，表示手动指定--mdns-domain，覆盖默认值，域名为：dev-server.local，访问地址为：http://dev-server.local:4096 
codearts serve --port 4096 --mdns --mdns-domain dev-server

--cors <origin>

表示给外部网页开权限，配置允许跨域访问的浏览器页面来源地址，支持多次配置多个来源。传入*表示放行所有网页，用于本地开发调试。未配置时仅服务自身页面可调用接口，外部网页会触发浏览器跨域拦截。

例如，执行如下命令，表示运行在http://localhost:5173的本地前端页面，可以正常请求4096端口的接口 
codearts serve --port 4096 --cors http://localhost:5173
例如，执行如下命令，允许访问多个来源： 
codearts serve --port 4096 \
--cors http://localhost:5173 \
--cors http://127.0.0.1:3000
例如，执行如下命令，表示允许所有源，表示仅本地调试用，生产环境不建议，存在安全风险。 
codearts serve --port 4096 --cors *
表11 codearts attach支持的参数列表

参数

描述

<url>

执行该命令，可以连接到运行的服务端。

您可以按照如下步骤连接正在运行的服务器：

  1. 使用该命令连接服务器前，您需要配置临时环境变量，指定连接服务器的用户名和密码：
    • Windows系统的配置命令如下： 
      set CODEARTS_SERVER_USERNAME=服务器用名
set CODEARTS_SERVER_PASSWORD=服务器密码
    • macOS或者Linux系统的配置命令如下： 
      export CODEARTS_SERVER_USERNAME="服务器用户名"
export CODEARTS_SERVER_PASSWORD="服务器密码"
  2. 执行如下命令，在一台终端启动服务： 
    codearts serve
    出现如下回显，表示成功启动服务。 
    本服务为本地开发环境，非标准云服务，不提供企业级安全加固与 SLA 保障。
请勿将服务地址暴露至公网或分享给他人，可能存在未授权访问、代码泄露等风险。
继续使用即视为您已了解并自愿承担上述风险。
建议通过配置反向代理等安全访问方案，配置方式可参考：https://support.huaweicloud.com/codeartssnap_faq/codeartsagentcli_0036.html
codearts server listening on http://127.0.0.1:4096
  3. 在一台终端启动服务后，您可以执行如下命令，在另一台终端连接指定服务器： 
    codearts attach ${CODEARTS_SERVER_URL} --password ${CODEARTS_SERVER_PASSWORD}

    其中，${CODEARTS_SERVER_URL}为要连接的服务器地址，${CODEARTS_SERVER_PASSWORD}为服务器的密码。

    例如，执行如下命令，连接本机4096端口的远程开发服务器，并通过密码完成鉴权接入开发环境。 
    codearts attach http://localhost:4096 -p yourpassword

-p，--password

服务端密码

-c，--continue

继续上次会话

-s，--session

指定会话ID

--fork

分叉会话，与“--continue”或“--session”配合使用
父主题： CLI

相关文档