codearts-cli

command module

v0.8.0 Latest Latest Go to latest Published: Jul 24, 2026 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Lzhtommy/codearts-cli

Links

Open Source Insights

README ¶

codearts-cli

华为云 CodeArts 命令行工具，为人类和 AI Agent 而建。覆盖流水线、工作项管理、代码托管、编译构建四大模块共 21 个接口，配套 5 个 AI Agent Skills。

安装 · AI Agent Skills · 配置 · 命令速查 · 高级用法 · 测试 · 架构 · 贡献

为什么用 codearts-cli？

Agent-Native 设计 — 4 个结构化 Skills，兼容 Claude Code / Cursor / Codex / Gemini CLI 等主流 AI 工具
轻量零依赖 — 不引入 huaweicloud-sdk-go-v3（几十 MB），自研 AK/SK 签名（SDK-HMAC-SHA256），单一二进制 ~3 MB
四模块二十接口 — 流水线、工作项、代码托管、编译构建，一条命令触发 CI/CD、管理 Bug、发评论、创建 MR、跑编译
Debug 友好 — 所有命令支持 --dry-run，预览 method / path / body 不发请求
安全可控 — AK/SK 存储 0600 权限，config show 自动脱敏，CI 场景用 --sk-stdin 防泄露
开源即用 — MIT 协议，npm install 一行安装

功能概览

模块	命令	API	说明
🚀 流水线	`pipeline list`	ListPipelines	查询流水线列表
🚀 流水线	`pipeline run`	RunPipeline	触发流水线
🚀 流水线	`pipeline stop`	StopPipelineRun	停止流水线实例
🚀 流水线	`pipeline status`	ShowPipelineRunDetail	查询流水线运行详情
📋 工作项	`issue list`	ListIpdProjectIssues	查询工作项列表
📋 工作项	`issue show`	ShowIssueDetail	查询工作项详情
📋 工作项	`issue create`	CreateIpdProjectIssue	创建工作项
📋 工作项	`issue batch-update`	BatchUpdateIpdIssues	批量更新工作项
📋 工作项	`issue relations`	ListE2EGraphsOpenAPI	查询工作项关联（E2E 图）
📋 工作项	`issue members`	ListProjectUsers	查询项目成员
📋 工作项	`issue statuses`	ListIssueStatues	查询工作项状态定义
📋 工作项	`issue comment list`	ListIssueComments†	查询工作项评论列表
📋 工作项	`issue comment add`	CreateIssueComment†	给工作项发评论
🔀 代码托管	`repo list`	ShowAllRepositoryByTwoProjectId	查询仓库列表
🔀 代码托管	`repo mr list`	ListRepositoryMergeRequests	查询合并请求列表
🔀 代码托管	`repo mr show`	ShowMergeRequestDetail	查询合并请求详情
🔀 代码托管	`repo mr create`	CreateMergeRequest	创建合并请求
🔀 代码托管	`repo mr comment list`	ListMergeRequestDiscussions	查询 MR 检视意见列表
🔀 代码托管	`repo mr comment add`	CreateMergeRequestDiscussion	创建 MR 检视意见
🔀 代码托管	`repo member list`	ListMembers	查询仓库成员列表
🛠️ 编译构建	`build list`	ListProjectJobs	查询项目构建任务列表
🛠️ 编译构建	`build run`	ExecuteJob	触发构建
🛠️ 编译构建	`build stop`	StopTheJob	停止运行中的构建
🛠️ 编译构建	`build status`	ShowJobStepStatus	查询构建任务步骤状态

† CreateIssueComment / ListIssueComments 未在华为云公开 API 文档中收录，从控制台 UI 反推并端到端验证。

安装

前置依赖

Node.js (npm/npx)
Go v1.23+（仅从源码构建时需要）

快速开始（人类用户）

AI Agent 提示： 如果你是 AI Agent 正在帮用户安装，直接跳到快速开始（AI Agent）。

安装

选择一种方式：

方式 1 — npm 安装（推荐）：

# 安装 CLI
npm install -g @autelrobotics/codearts-cli

# 安装 AI Agent Skills（可选但推荐）
npx skills add Lzhtommy/codearts-cli -y -g

方式 2 — 从源码构建：

需要 Go v1.23+。

git clone https://github.com/Lzhtommy/codearts-cli.git
cd codearts-cli
make install PREFIX=$HOME/.local

# 安装 AI Agent Skills（可选）
npx skills add Lzhtommy/codearts-cli -y -g

配置 & 使用

# 1. 配置凭证（交互式，SK 不回显）
codearts-cli config init

# 2. 查看配置
codearts-cli config show

# 3. 开始使用
codearts-cli pipeline run <pipeline_id> --project-id <project_id>
codearts-cli issue list --issue-type Bug

快速开始（AI Agent）

以下步骤面向 AI Agent。部分步骤需要用户在终端中完成交互。

Step 1 — 安装

npm install -g @autelrobotics/codearts-cli
npx skills add Lzhtommy/codearts-cli -y -g

Step 2 — 配置凭证

交互式：用户需要在终端输入 AK、SK（不回显）、Project ID、Region、Gateway URL、User ID。

codearts-cli config init

非交互（CI）：

echo "$HW_SK" | codearts-cli config init --ak "$HW_AK" --sk-stdin --project-id <uuid> --user-id <uuid> --yes

Step 3 — 验证

codearts-cli config show
codearts-cli issue list --issue-type Bug --dry-run

Agent Skills

Skill	说明
`codearts-shared`	配置初始化、凭证管理、通用标志、端点解析、错误处理（被其它 skill 自动引用）
`codearts-pipeline`	流水线列表 / 启动 / 停止 / 运行详情
`codearts-issue`	工作项查询 / 详情 / 创建 / 批量更新 / 关联追溯 / 项目成员 / 状态定义 / 评论
`codearts-repo`	仓库列表 / MR 创建 / MR 检视意见 / 仓库成员
`codearts-build`	构建任务列表 / 触发构建 / 停止构建 / 步骤状态

# 安装全部 skills
npx skills add Lzhtommy/codearts-cli -y -g

# 仅安装特定 skill
npx skills add Lzhtommy/codearts-cli -s codearts-pipeline -y -g

配置

`config init`

交互式初始化，依次输入 6 项：

#	字段	必填	说明
1	AK	是	IAM Access Key ID（账号级全局，跨 region 通用）
2	SK	是	IAM Secret Access Key（输入时不回显）
3	Project ID	默认	CodeArts 项目 UUID（工作项接口必须，流水线/仓库可显式传入）
4	Region	是	租户所在 region，默认 `cn-south-1`；北京四填 `cn-north-4`。决定签名 Host，填错则找不到对应项目/仓库
5	Gateway	可选	内网转发网关 URL，默认 `http://10.250.63.100:8099`；输入 `-` 清空后直连 region 公网端点
6	User ID	可选	IAM user_id（32 位 UUID），`issue create` 默认 assignee

`config set <key> <value>`

修改单个字段，无需走完整 init 流程：

codearts-cli config set userId <uuid>
codearts-cli config set region cn-north-4
codearts-cli config set gateway http://10.250.63.100:8099
# 公网直连（清空网关）：
codearts-cli config set gateway ""

可用 key：ak / sk / projectId / region / gateway / userId

`config show` / `config path`

codearts-cli config show    # 打印配置（AK 脱敏、SK 全掩）
codearts-cli config path    # 打印配置文件绝对路径

配置文件：~/.codearts-cli/config.json（权限 0600）。

命令速查

流水线

`pipeline list` — 查询流水线列表

# 列出项目下所有流水线
codearts-cli pipeline list --project-id <proj>

# 按名称过滤 + 分页
codearts-cli pipeline list --project-id <proj> --name "deploy" --limit 20

Flag	说明
`--project-id`（必填）	华为云项目 UUID
`--name`	按名称模糊匹配
`--status`	按状态过滤（可重复）
`--creator-id` / `--executor-id`	按创建人/执行人过滤（可重复）
`--offset` / `--limit`	分页
`--sort-key` / `--sort-dir`	排序（asc / desc）
`--dry-run`	预览请求

`pipeline run <pipeline_id>` — 启动流水线

# 使用默认参数
codearts-cli pipeline run <pid> --project-id <proj>

# 指定源分支
codearts-cli pipeline run <pid> --project-id <proj> \
  --sources '[{"type":"code","params":{"build_type":"branch","target_branch":"main"}}]'

# 注入变量
codearts-cli pipeline run <pid> --project-id <proj> \
  --variables '[{"name":"ENV","value":"staging"}]'

Flag	说明
`--project-id`（必填）	华为云项目 UUID
`--sources` / `--sources-file`	源覆盖 JSON 数组
`--variables` / `--variables-file`	变量 JSON 数组
`--body` / `--body-file`	完整请求体
`--description` / `--choose-job` / `--choose-stage`	备注 / 指定 job / stage
`--dry-run`	预览请求

`pipeline stop <pipeline_id> <pipeline_run_id>` — 停止流水线

codearts-cli pipeline stop <pid> <run_id> --project-id <proj>

`pipeline status <pipeline_id> [pipeline_run_id]` — 查询运行详情

# 查指定 run
codearts-cli pipeline status <pid> <run_id> --project-id <proj>

# 省略 run_id，返回最近一次运行
codearts-cli pipeline status <pid> --project-id <proj>

返回 status / start_time / end_time / run_number / stages / sources / artifacts 等字段。

工作项管理

工作项命令统一使用 config.json 的 projectId，不支持 --project-id。若未配置，先执行 codearts-cli config set projectId <uuid>。

`issue list` — 查询列表

# 最简
codearts-cli issue list --issue-type Bug

# 查"我名下的 Bug"（assignee = config 中的 userId）
codearts-cli issue list --issue-type Bug \
  --filter '[{"assignee":{"values":["<your_user_id>"],"operator":"||"}}]'

# 分页 + 排序
codearts-cli issue list --issue-type US,Task --page-no 1 --page-size 50 --sort-field created_date

filter 参数格式：

[{"<field>": {"values": ["..."], "operator": "||"}}]

<field>：assignee / status / priority / … （加 descendants. 前缀可对子工作项下钻，一般无需）
operator：||（OR，默认）/ !（NOT）/ = / <> / < / >

Flag	说明
`--issue-type`（必填）	逗号分隔：`RR/SF/IR/US/Task/Bug/Epic/FE/SR/AR`
`--filter` / `--filter-file`	过滤条件 JSON（格式见上）
`--filter-mode`	`AND_OR`（默认）/ `OR_AND`
`--page-no` / `--page-size`	分页
`--sort-field` / `--sort-asc`	排序

`issue show <issue_id>` — 查询详情

codearts-cli issue show <id> --issue-type US

`issue create` — 创建工作项

codearts-cli issue create --title "修复登录超时" --description "..." --category Bug

--assignee 省略时自动取 config 中的 userId。

`issue batch-update` — 批量更新

codearts-cli issue batch-update --id 111,222,333 --category Bug --attribute '{"priority":"中"}'

`issue relations <issue_id>` — 查询工作项关联（E2E 图）

codearts-cli issue relations 1251275102548402177 --category US

返回父/子工作项、关联的 commits / MR / 分支 / 测试用例 / 文档。--is-src true|false 用于跨项目查询。

`issue members` — 查询项目成员

codearts-cli issue members

返回 config.projectId 下的所有成员，每条包含 user_id（32 位 UUID，可用作 issue create --assignee）、user_name、nick_name、role_name。

`issue statuses <category_id>` — 查询工作项状态定义

codearts-cli issue statuses 10020

<category_id> 是 5 位数字工作项类型 ID（非 Bug/Task 字符串）。有效取值：10001 / 10020 / 10021 / 10022 / 10023 / 10027 / 10028 / 10029 / 10033 / 10065。返回 result 数组，每条含 name 和 belonging（START / IN_PROGRESS / END）。

`issue comment list <issue_id>` — 查询工作项评论列表

# 默认拉评论 + 回复 + 操作日志
codearts-cli issue comment list 1255554812900024320

# 只看用户评论，倒序，每页 50
codearts-cli issue comment list 1255554812900024320 \
  --category comment --date-desc true --page-size 50

# 跨项目查询
codearts-cli issue comment list <id> --target-project-id <other-project-uuid>

Flag	说明
`<issue_id>`（位置参数）	18–19 位数字 ID（API 返回的 `id`，非控制台 `number` 短号）
`--category`	上游必填项，CLI 默认 `comment,reply,operation`；可子集逗号分隔
`--page-no` / `--page-size`	分页（0 = API 默认）
`--date-desc`	`true` / `false` 倒/正序；省略则按 API 默认
`--target-project-id`	跨项目查询时填来源项目 ID

返回 result.comment_list[]，每条含 id / issue_id / type（comment / reply / operation）/ description（HTML 体）/ creator_info / created_date（毫秒时间戳）/ top / top_flag，Operation 类型还附 extend_attribute_obj 操作日志详情。接口未在公开 API 文档中收录，行为从 UI 反推并端到端验证。

`issue comment add <issue_id>` — 给工作项发评论

# 基础
codearts-cli issue comment add 1255545097800962048 \
  --issue-category Task \
  --description "<p>评审通过，请合并</p>"

# 长文本走文件
codearts-cli issue comment add <id> --issue-category Task --description-file note.html

# 完整 JSON
codearts-cli issue comment add <id> --body-file comment.json

Flag	说明
`<issue_id>`（位置参数）	18–19 位数字 ID（API 返回的 `id`，非控制台 `number` 短号）
`--issue-category`（必填）	工作项类型字符串：`Task` / `Bug` / `US` / `RR` / `SF` / `IR` / `SR` / `AR` / `Epic` / `FE`
`--description`（必填*）	评论 HTML 体，纯文本要包 `<p>...</p>`
`--description-file`	描述从文件读
`--body` / `--body-file`	完整 JSON（覆盖上面）

* 用 --body / --body-file 时不需要这两个 flag。category 字段固定 "comment"，CLI 会自动补。

接口未在华为云公开 API 文档中收录，body 形态：{"category":"comment","issue_category":"Task","description":"<p>...</p>"}。

代码托管

<repository_id> 必须是正整数（数字仓库 ID），不是 UUID。可通过 repo list 获取。

`repo list` — 查询仓库列表

# 列出项目下所有仓库（返回每个仓库的 repository_id）
codearts-cli repo list --project-id <proj>

# 按名称搜索
codearts-cli repo list --project-id <proj> --search "backend"

Flag	说明
`--project-id`（必填）	项目 UUID（可从 `git remote -v` 提取）
`--search`	按仓库名或创建人搜索
`--page-index` / `--page-size`	分页（默认 20 条/页）
`--dry-run`	预览请求

`repo mr list <repo_id>` — 查询合并请求列表

# 默认按创建时间倒序，返回的 iid 用于 show / comment 子命令
codearts-cli repo mr list 8147520

# 过滤 + 分页
codearts-cli repo mr list 8147520 --state opened --target main --sort desc --limit 50

Flag	说明
`--state`	`all` / `opened` / `closed` / `merged`（默认 all）
`--search`	标题 / 描述关键字
`--author-id`	按创建人 user_id 过滤（逗号分隔）
`--source` / `--target`	按源 / 目标分支过滤
`--order-by` / `--sort`	排序字段（created_at / updated_at）/ 方向（asc / desc）
`--offset` / `--limit`	分页（limit 1-100，默认 20）

`repo mr show <repo_id> <mr_iid>` — 查询合并请求详情

codearts-cli repo mr show 8147520 16

`repo mr create <repo_id>` — 创建合并请求

codearts-cli repo mr create 8147520 \
  --title "feat: x" --source feat/x --target main \
  --reviewers "uid-a,uid-b" --squash --force-remove-source

Flag	说明
`--title` / `--source` / `--target`（必填）	标题 / 源分支 / 目标分支
`--reviewers` / `--assignees`	逗号分隔 user_id
`--work-item`	关联工作项 ID（可重复）
`--squash` / `--force-remove-source`	合并选项
`--body-json` / `--body-file`	完整 JSON body

`repo mr comment list <repo_id> <mr_iid>` — 查询检视意见列表

codearts-cli repo mr comment list 8147520 16

# 过滤 + 分页
codearts-cli repo mr comment list 8147520 16 --unresolved true --sort desc --limit 50

Flag	说明
`--unresolved`	`true`（仅未解决）/ `false`（仅已解决），省略为全部
`--author-id`	按作者 user_id 过滤
`--sort`	按创建时间排序：asc / desc
`--offset` / `--limit`	分页（limit 1-100，默认 20）

`repo mr comment add <repo_id> <mr_iid>` — 创建检视意见

codearts-cli repo mr comment add 8147520 15 --body "LGTM" --severity suggestion

`repo member list <repo_id>` — 查询仓库成员

# 所有成员
codearts-cli repo member list 8147520

# 搜索 + 分页
codearts-cli repo member list 8147520 --search "zhang" --offset 0 --limit 50

# 按权限点过滤（如：有 code push 权限的成员）
codearts-cli repo member list 8147520 --permission code --action push

Flag	说明
`--search`	在 user_name / nick_name / tenant_name 上模糊匹配
`--offset` / `--limit`	分页（默认 offset=0，limit=20，limit 上限 100）
`--permission`	`repository` / `code` / `member` / `branch` / `tag` / `mr` / `label`
`--action`	动作（需配合 `--permission`；取值随权限点不同，详见 skill 文档）

编译构建

build list 需要 --project-id（项目 UUID）。build run / build stop 使用 <job_id>（构建任务 ID，从 build list 返回值的 id 字段取）。

`build list` — 查询构建任务

# 列出项目下所有构建任务
codearts-cli build list --project-id <proj>

# 按名称 / 创建人模糊搜索 + 分页
codearts-cli build list --project-id <proj> --search "backend" \
  --page-index 0 --page-size 50

# 按最近一次构建状态过滤
codearts-cli build list --project-id <proj> --build-status red

Flag	说明
`--project-id`（必填）	项目 UUID
`--page-index` / `--page-size`	分页（默认 0 / 10，page-size 上限 100）
`--search`	任务名 / 创建人模糊匹配
`--sort-field` / `--sort-order`	排序
`--creator-id`	按创建人 user_id 过滤
`--build-status`	`red` / `blue` / `timeout` / `aborted` / `building` / `none`
`--by-group` / `--group-path-id`	分组查看

`build run <job_id>` — 触发构建

# 用任务默认参数触发
codearts-cli build run 48c66c6002964721be537cdc6ce0297b

# 覆盖分支 + 带参数 + 指定代码源
codearts-cli build run <job_id> \
  --branch main --build-type branch --scm-type codehub --repo-id 8147520 \
  --param "ENV=staging" --param "VERSION=1.2.0"

Flag	说明
`--param KEY=VAL`	构建参数（可重复或逗号分隔）
`--branch` / `--build-tag` / `--commit-id`	scm 源覆盖
`--build-type`	`branch` / `tag` / `commitId`
`--scm-type` / `--repo-id` / `--repo-name`	代码源：`default` / `codehub`
`--body-json` / `--body-file`	完整 JSON body

返回值包含 daily_build_number（后续 build stop 需要的 build_no）和 actual_build_number。

`build stop <job_id> <build_no>` — 停止构建

codearts-cli build stop 48c66c6002964721be537cdc6ce0297b 105

<build_no> 是单次构建序号（从 1 递增），来自 build run 返回值或构建历史面板，不要和 job_id 混淆。

`build status <job_id> [build_no]` — 查询构建状态

# 省略 build_no 时 API 默认查 build_no=1
codearts-cli build status <job_id>

# 查指定构建编号
codearts-cli build status <job_id> 42

返回 result.workflow.status（completed/runnable/pending）、result.workflow.abort_status（aborted/timeout/空）、status（success/fail）等字段。

高级用法

Dry Run

所有命令支持 --dry-run，打印 method / path / query / body 但不发请求：

codearts-cli pipeline run <pid> --project-id <proj> --dry-run
codearts-cli issue create --title "x" --description "x" --category Bug --dry-run

Region 与网关

签名 Host 由 config.json 的 region 派生（<服务>-ext.<region>.myhuaweicloud.com），所以 region 必须与租户所在 region 一致，否则永远匹配不到对应的项目/仓库。AK/SK 是账号级全局的，切 region 不用换凭证。

内网部署（默认）：region=cn-south-1 + gateway=http://10.250.63.100:8099。请求带广州 Host，物理转发到网关，由网关按 Host 路由。
公网多 region（如北京四）：region=cn-north-4 + gateway 留空，直连该 region 的公网端点，无需网关。

# 广州内网 → 北京四公网
codearts-cli config set region cn-north-4
codearts-cli config set gateway ""

# 切换内网网关
codearts-cli config set gateway http://<your-gateway>:<port>

project-id 作用域

模块	`--project-id`	config.json `projectId`
流水线	必填	不读
工作项管理	不支持	必读
代码托管	`repo list` 必填；`mr` / `member` 命令走 `repo_id`	`repo list` 不读
编译构建	`build list` 必填；`run` / `stop` 走 `job_id`	不读

提示：在 CodeArts Repo 克隆的仓库目录下，可从 git remote -v 自动提取 project-id：
PROJECT_ID=$(git remote -v | grep codehub | head -1 | grep -oE '[a-f0-9]{32}' | head -1)

测试

单元测试集中在 tests/ 目录下，按模块组织：

# 运行全部测试
go test ./tests/...

# 运行单个模块
go test ./tests/client/    # 签名 + HTTP 客户端
go test ./tests/core/      # 配置加载/保存/校验
go test ./tests/output/    # JSON 输出格式
go test ./tests/cmd/       # CLI 工具函数

# 带详细输出
go test ./tests/... -v

# 跑完整项目（含 tests/）
go test ./...

测试模块	文件	用例数	覆盖点
`tests/client/`	`signer_test.go`	11	HashHex / HmacHex / CanonicalURI / CanonicalQuery / CanonicalHeaders / Sign
`tests/client/`	`client_test.go`	7	Do 成功 / 400 / 401 hint / 500 raw / 空响应 / POST body / 缺凭证
`tests/core/`	`config_test.go`	10	Validate / Redacted / MaskLeft / Save+Load 往返 / 默认值 / 兼容性
`tests/output/`	`output_test.go`	5	PrintJSON / Successf / Errorf / DryRunf
`tests/cmd/`	`helpers_test.go`	14	ParseRepoID / ExtractStringFromResp / FirstNonEmpty
合计		47

HTTP 测试使用 httptest.Server 模拟 API，文件 I/O 测试使用 t.TempDir() + 临时 $HOME，不依赖外部服务。

项目结构

codearts-cli/
├── main.go                           # 入口
├── Makefile                          # build / install / dist / npm-link
├── package.json                      # npm 包描述
├── .goreleaser.yml                   # 跨平台编译配置
├── scripts/
│   ├── install.js                    # npm postinstall：下载预编译二进制
│   └── run.js                        # npm bin 入口：exec Go 二进制
├── skills/
│   ├── codearts-shared/SKILL.md      # AI Skill: 配置 / 认证 / 通用
│   ├── codearts-pipeline/SKILL.md    # AI Skill: 流水线
│   ├── codearts-issue/SKILL.md       # AI Skill: 工作项
│   ├── codearts-repo/SKILL.md        # AI Skill: 代码托管
│   └── codearts-build/SKILL.md       # AI Skill: 编译构建
├── tests/
│   ├── client/                       # 签名 + HTTP 客户端测试
│   ├── core/                         # 配置测试
│   ├── output/                       # 输出格式测试
│   └── cmd/                          # CLI 工具函数测试
├── cmd/
│   ├── root.go                       # 根命令
│   ├── config.go                     # config init / show / path / set
│   ├── pipeline.go                   # pipeline list / run / stop / status
│   ├── issue.go                      # issue list / show / create / batch-update / relations / members / statuses / comment list / comment add
│   ├── repo.go                       # repo list / mr list,show,create,comment / member list
│   └── build.go                      # build list / run / stop / status
└── internal/
    ├── core/config.go                # 配置加载 / 保存（~/.codearts-cli/config.json）
    ├── client/
    │   ├── signer.go                 # SDK-HMAC-SHA256 AK/SK 签名
    │   ├── client.go                 # HTTP 封装 + 三服务端点推导
    │   ├── pipeline.go               # 流水线 API
    │   ├── projectman.go             # 工作项 API
    │   ├── repo.go                   # 代码托管 API
    │   └── build.go                  # 编译构建 API
    └── output/output.go              # JSON 输出 + 成功 / 错误消息

扩展新 API

如果是新服务域，在 internal/client/client.go 加 XxxEndpoint() 方法
在 internal/client/*.go 加接口方法，调用 c.Do(ctx, method, endpoint, path, query, body, &out)
在 cmd/ 加 cobra 子命令，参考 --dry-run 模式
在 cmd/root.go 注册

已踩坑记录：

华为 APIGW 签名的 CanonicalURI 必须以 / 结尾
POST 即使无参数也必须发 {}（否则 PARSE_REQUEST_DATA_EXCEPTION）
401 APIGW.0301 会回显服务端 canonical_request，直接 diff 即可定位

贡献

欢迎社区贡献！如果发现 Bug 或有功能建议，请提交 Issue 或 Pull Request。

重大变更建议先通过 Issue 讨论。

License

本项目基于 MIT License 开源。运行时调用华为云 CodeArts 平台 API，使用前请遵守华为云服务协议和华为云隐私政策。

Documentation ¶

Overview ¶

codearts-cli — Huawei Cloud CodeArts CLI (Go implementation).

A lightweight CLI wrapping the CodeArts SDK for common CI/CD workflows (currently the CodeArtsPipeline RunPipeline API).

Source Files ¶

View all Source files

main.go

Directories ¶

Path	Synopsis
cmd Package cmd wires the cobra command tree for codearts-cli.	Package cmd wires the cobra command tree for codearts-cli.
internal
client Package client implements a minimal Huawei Cloud API client with AK/SK signing (SDK-HMAC-SHA256).	Package client implements a minimal Huawei Cloud API client with AK/SK signing (SDK-HMAC-SHA256).
core Package core provides configuration storage for codearts-cli.	Package core provides configuration storage for codearts-cli.
output Package output provides consistent stdout/stderr formatting for codearts-cli.	Package output provides consistent stdout/stderr formatting for codearts-cli.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

README ¶

codearts-cli

为什么用 codearts-cli？

功能概览

安装

前置依赖

快速开始（人类用户）

安装

配置 & 使用

快速开始（AI Agent）

Agent Skills

配置

config init

config set <key> <value>

config show / config path

命令速查

流水线

pipeline list — 查询流水线列表

pipeline run <pipeline_id> — 启动流水线

pipeline stop <pipeline_id> <pipeline_run_id> — 停止流水线

pipeline status <pipeline_id> [pipeline_run_id] — 查询运行详情

工作项管理

issue list — 查询列表

issue show <issue_id> — 查询详情

issue create — 创建工作项

issue batch-update — 批量更新

issue relations <issue_id> — 查询工作项关联（E2E 图）

issue members — 查询项目成员

issue statuses <category_id> — 查询工作项状态定义

issue comment list <issue_id> — 查询工作项评论列表

issue comment add <issue_id> — 给工作项发评论

代码托管

repo list — 查询仓库列表

repo mr list <repo_id> — 查询合并请求列表

repo mr show <repo_id> <mr_iid> — 查询合并请求详情

repo mr create <repo_id> — 创建合并请求

repo mr comment list <repo_id> <mr_iid> — 查询检视意见列表

repo mr comment add <repo_id> <mr_iid> — 创建检视意见

repo member list <repo_id> — 查询仓库成员

编译构建

build list — 查询构建任务

build run <job_id> — 触发构建

build stop <job_id> <build_no> — 停止构建

build status <job_id> [build_no] — 查询构建状态

高级用法

Dry Run

Region 与网关

project-id 作用域

测试

项目结构

扩展新 API

贡献

License

Documentation ¶

Overview ¶

Source Files ¶

Directories ¶

`config init`

`config set <key> <value>`

`config show` / `config path`

`pipeline list` — 查询流水线列表

`pipeline run <pipeline_id>` — 启动流水线

`pipeline stop <pipeline_id> <pipeline_run_id>` — 停止流水线

`pipeline status <pipeline_id> [pipeline_run_id]` — 查询运行详情

`issue list` — 查询列表

`issue show <issue_id>` — 查询详情

`issue create` — 创建工作项

`issue batch-update` — 批量更新

`issue relations <issue_id>` — 查询工作项关联（E2E 图）

`issue members` — 查询项目成员

`issue statuses <category_id>` — 查询工作项状态定义

`issue comment list <issue_id>` — 查询工作项评论列表

`issue comment add <issue_id>` — 给工作项发评论

`repo list` — 查询仓库列表

`repo mr list <repo_id>` — 查询合并请求列表

`repo mr show <repo_id> <mr_iid>` — 查询合并请求详情

`repo mr create <repo_id>` — 创建合并请求

`repo mr comment list <repo_id> <mr_iid>` — 查询检视意见列表

`repo mr comment add <repo_id> <mr_iid>` — 创建检视意见

`repo member list <repo_id>` — 查询仓库成员

`build list` — 查询构建任务

`build run <job_id>` — 触发构建

`build stop <job_id> <build_no>` — 停止构建

`build status <job_id> [build_no]` — 查询构建状态