@szhn/ai-cli 使用文档

数字海南 AI 辅助开发工具集，提供统一的命令行入口，集成多个 AI 辅助开发子模块。

概述

npm 包名：@szhn/ai-cli
CLI 名称：dh-ai

子命令列表

子命令	说明
`dh-ai skill`	AI 编码 skills 管理——为项目初始化/升级/删除预设的 AI 编码规范
`dh-ai agent`	AI Agent 管理——为项目初始化/升级/删除预设的 AI Agent 角色
`dh-ai files`	规范文档管理——将预设 Markdown 规范文件安装到项目

安装

1) 配置私有源

bash

npm config set @szhn:registry https://npmmirror.digitalhainan.com.cn/

2) 安装

项目内安装（推荐）：

bash

npm i -D @szhn/ai-cli

或全局安装：

bash

npm i -g @szhn/ai-cli

skill 子命令

AI 编码 skills 管理工具，可一键将预设编码规范写入项目的 AI 工具目录。

支持模块：common、frontend、backend、ui
支持工具：Agent、Lingma、Trea、Claude、Cursor、GitHub Copilot

`skill init` — 初始化 skills

在项目目录执行：

bash

dh-ai skill init

交互流程：

选择要安装的模块（common / frontend / backend / ui）
选择具体的 skills
选择目标 AI 工具
选择安装位置：当前工作目录（仅对当前项目生效，默认）或用户目录（对所有项目全局生效）
若存在同名文件，提示是否覆盖

说明：

如果项目根目录缺少 DESIGN.md，命令会给出提醒，请按需运行 dh-ai files init 安装规范文件。

预演模式（不实际写入）：

bash

dh-ai skill init --dry-run

`skill update` — 升级已安装的 skills

交互选择升级：

bash

dh-ai skill update

按模块升级：

bash

dh-ai skill update --module frontend

升级单个 skill：

bash

dh-ai skill update --skill frontend/dh-fe-performance

预演模式：

bash

dh-ai skill update --dry-run

`skill remove` — 删除已安装的 skills

交互模式（先选模块，再选模块内 skills）：

bash

dh-ai skill remove

按模块删除：

bash

dh-ai skill remove --module backend

删除单个 skill：

bash

dh-ai skill remove --skill backend/dh-be-apione-usage

预演模式：

bash

dh-ai skill remove --dry-run

`skill list` — 列出 skills

列出所有可用 skills（已安装的用 ✔ 标绿）：

bash

dh-ai skill list

只显示当前项目已安装的 skills：

bash

dh-ai skill list --installed

`skill status` — 检查版本状态

检查已安装的 skills 是否有更新可用，逐一对比本地文件与最新源文件内容：

bash

dh-ai skill status

输出示例：

  ✔  common/git-commit        claude   已是最新
  ✗  backend/code-generator   cursor   有更新可用  → dh-ai skill update
  !  ui/design-system         github   源文件缺失（skill 包版本过旧）

状态说明：

状态	含义
`✔ 已是最新`	本地文件与包内源文件一致
`✗ 有更新可用`	内容存在差异，运行 `dh-ai skill update` 升级
`! 源文件缺失`	当前安装的 `@szhn/ai-cli` 版本不包含此 skill，请升级包

模块说明

模块	说明
`common`	通用规范（代码风格、Git 提交等）
`frontend`	前端开发规范
`backend`	后端开发规范
`ui`	UI/UX 设计规范

文件路径规则

skills 安装后按以下结构写入目标目录：

text

{tool-dir}/skills/{skill-id}/SKILL{ext}

AI 工具	目录	文件扩展名
Agent	`.agents/skills`	`.md`
Lingma	`.lingma/skills`	`.md`
Trea	`.trea/skills`	`.md`
Claude	`.claude/skills`	`.md`
Cursor	`.cursor/skills`	`.md`
GitHub Copilot	`.github/skills`	`.md`

示例：

.github/skills/dh-fe-performance/SKILL.md
.cursor/skills/dh-cm-code-style/SKILL.md
.claude/skills/dh-be-apione-usage/SKILL.md

agent 子命令

AI Agent 管理工具，可将预设角色说明安装到项目或用户目录。

支持工具：Agent、Lingma、Trea、Claude、Cursor、GitHub Copilot

`agent init` — 初始化 agents

在项目目录执行：

bash

dh-ai agent init

交互流程：

选择要安装的 agents
选择目标 AI 工具
选择安装位置：当前工作目录（仅对当前项目生效，默认）或用户目录（对所有项目全局生效）
若存在同名文件，提示是否覆盖

预演模式（不实际写入）：

bash

dh-ai agent init --dry-run

`agent update` — 升级已安装的 agents

交互选择升级：

bash

dh-ai agent update

升级单个 agent：

bash

dh-ai agent update --agent frontend-developer

预演模式：

bash

dh-ai agent update --dry-run

`agent remove` — 删除已安装的 agents

交互删除：

bash

dh-ai agent remove

删除单个 agent：

bash

dh-ai agent remove --agent backend-developer

预演模式：

bash

dh-ai agent remove --dry-run

`agent list` — 列出 agents

列出所有可用 agents（已安装的用 ✔ 标绿）：

bash

dh-ai agent list

只显示当前项目已安装的 agents：

bash

dh-ai agent list --installed

`agent status` — 检查版本状态

检查已安装的 agents 是否有更新可用：

bash

dh-ai agent status

状态说明与 skill status 一致：

状态	含义
`✔ 已是最新`	本地文件与包内源文件一致
`✗ 有更新可用`	内容存在差异，运行 `dh-ai agent update` 升级
`! 源文件缺失`	当前安装的 `@szhn/ai-cli` 版本不包含此 agent，请升级包

文件路径规则

agents 安装后按以下结构写入目标目录：

text

{tool-dir}/agents/{agent-id}{ext}

AI 工具	目录	文件扩展名
Agent	`.agents/agents`	`.md`
Lingma	`.lingma/agents`	`.md`
Trea	`.trea/agents`	`.md`
Claude	`.claude/agents`	`.md`
Cursor	`.cursor/agents`	`.md`
GitHub Copilot	`.github/agents`	`.md`

示例：

.github/agents/frontend-developer.md
.claude/agents/technical-architect.md

files 子命令

规范文档管理工具，可将包内预设的 Markdown 规范文件（如设计规范、开发规范）一键安装到项目目录。

`files list` — 列出可用文件

bash

dh-ai files list

输出示例：

  ◦  DESIGN.cn.md              设计规范 — Rock 设计体系（数字海南）
  ◦  DESIGN.md                 Design System — Rock Design System (Digital Hainan)

`files init` — 安装到项目

交互式选择文件并安装（会询问目标目录）：

bash

dh-ai files init

直接指定目标目录（跳过询问）：

bash

dh-ai files init --output docs

预演模式（不实际写入）：

bash

dh-ai files init --dry-run

交互流程：

勾选要安装的 Markdown 文件（默认全选）
输入目标目录（相对项目根目录，留空则写入根目录）
若存在同名文件，提示是否覆盖

运行要求

Node.js >=16.0.0

@szhn/ai-cli 使用文档 ​

概述 ​

子命令列表 ​

安装 ​

1) 配置私有源 ​

2) 安装 ​

skill 子命令 ​

skill init — 初始化 skills ​

skill update — 升级已安装的 skills ​

skill remove — 删除已安装的 skills ​

skill list — 列出 skills ​

skill status — 检查版本状态 ​

模块说明 ​

文件路径规则 ​

agent 子命令 ​

agent init — 初始化 agents ​

agent update — 升级已安装的 agents ​

agent remove — 删除已安装的 agents ​

agent list — 列出 agents ​

agent status — 检查版本状态 ​

文件路径规则 ​

files 子命令 ​

files list — 列出可用文件 ​

files init — 安装到项目 ​

运行要求 ​

@szhn/ai-cli 使用文档

概述

子命令列表

安装

1) 配置私有源

2) 安装

skill 子命令

`skill init` — 初始化 skills

`skill update` — 升级已安装的 skills

`skill remove` — 删除已安装的 skills

`skill list` — 列出 skills

`skill status` — 检查版本状态

模块说明

文件路径规则

agent 子命令

`agent init` — 初始化 agents

`agent update` — 升级已安装的 agents

`agent remove` — 删除已安装的 agents

`agent list` — 列出 agents

`agent status` — 检查版本状态

文件路径规则

files 子命令

`files list` — 列出可用文件

`files init` — 安装到项目

运行要求