AIOps Docs
知识库
知识库
  • 开篇

    • 1. 项目概述
    • 2. 快速上手
    • 3. 核心理念
  • 场景

    • 4. 历史项目入库
    • 5. 文档召回辅助研发
    • 6. 日常文档维护
    • 7. 新项目初始化
  • How it works

    • 8. 治理模型
    • 9. 三级结构
    • 10. 迭代绑定
    • 11. config-ui
  • 资料

    • CLI 命令参考
    • 技能说明
    • 知识生命周期(总调度)
    • 治理引导
    • 历史项目入库
    • 文档召回辅助研发
    • 日常文档维护
    • 新项目简报
    • 知识审查

CLI 命令参考

@makia9879/aiops CLI 是 AIOps 知识治理的命令行入口。所有命令都是幂等的——可以反复执行,不会产生重复或冲突的内容。

安装 CLI

全局安装(推荐)

npm install -g @makia9879/aiops

安装后 aiops 命令全局可用。

npx 直接运行

npx -y @makia9879/aiops <command> [options]

适合一次性使用,不需要全局安装。

命令总览

aiops <command> [options]
命令作用修改项目文件
install安装 AIOps 技能到 agent 运行时目录不修改
uninstall删除 AIOps 技能和 CLI 管理的辅助工具链不修改
init在当前项目初始化知识治理结构修改
setup先 install 再 init修改
config-ui启动本地页面维护迭代绑定配置修改
link-docs在源码仓库建立指向文档仓库的指针修改
help显示帮助信息不修改

install

只安装技能和工具,不碰项目文件。

aiops install [options]

安装了什么:

  • 7 个 AIOps 治理技能 → ~/.agents/skills/ 和 ~/.codex/skills/
  • 3 个辅助工具 → ~/.aiops/tools/
    • @colbymchenry/codegraph@0.9.9
    • @understand-anything/skill@2.7.6
    • @mindfoldhq/trellis@0.5.19

技能安装逻辑:

技能目录按 SHA256 对比。目标目录不存在 → 全新安装。内容一致 → 跳过。内容不一致 → 覆盖更新。

工具链检查逻辑:

CLI 会先检查 ~/.aiops/tools/ 下的固定版本包和 ~/.aiops/bin/ 下的可执行 shim,输出每个工具的期望版本、当前版本和缺失项。交互式终端会询问是否由安装程序自动补齐;非交互环境必须传 --yes 才自动补齐;--with none 跳过工具链。

常用组合:

# 只装技能,跳过工具链
aiops install --with none

# 只装部分工具
aiops install --with codegraph,trellis

# 从指定目录安装技能(开发调试用)
aiops install --skills-source /path/to/skills

uninstall

删除由 CLI 安装到本机运行时目录的 AIOps 技能和辅助工具链,不删除当前工作空间的 .aiops/ 项目知识数据。

aiops uninstall [options]

卸载了什么:

  • 7 个 AIOps 治理技能:默认从 ~/.agents/skills/ 和 ~/.codex/skills/ 删除
  • CLI 管理的固定版本辅助工具链目录:默认从 ~/.aiops/tools/ 删除
  • CLI 管理的工具 shim:默认从 ~/.aiops/bin/ 删除

最后一行 stdout:

CLI uninstall command: npm uninstall -g @makia9879/aiops

这行命令只负责卸载全局安装的 CLI 包本身;如果使用的是 npx -y @makia9879/aiops ...,通常不需要再执行全局卸载。

常用组合:

# 卸载默认技能和默认工具链
aiops uninstall

# 只卸载技能,不动工具链
aiops uninstall --with none

# 卸载指定运行时技能目录
aiops uninstall --skills-target /path/to/runtime/skills

# 卸载指定工具链根目录
aiops uninstall --tools-root /path/to/.aiops/tools

init

在当前项目初始化知识治理结构。会向上查找已有 .aiops/ 目录——如果找到了就复用,没找到就新建。

aiops init [options]

生成了什么:

  • .aiops/ 目录(governance.yaml、hooks/、projects/ 等)
  • .aiops/projects/<project>/ 项目知识骨架
  • .aiops/projects/<project>/iteration-bindings.yaml 迭代绑定配置
  • .claude/settings.json 和 .codex/hooks.json Hook 配置(追加式写入,不覆盖已有内容)
  • guides/ VuePress 文档站点模板

常用组合:

# 最简单的用法
aiops init --yes --project my-app

# 多产品项目
aiops init --yes --project cert-auth --products CA,RA,KMC,OCSP

# 已成型多仓库项目:产品即代码仓库
aiops init --yes --project ca-platform \
  --product-repos ca_admin,ra_admin,kmc_admin,ocsp-responder \
  --link-product-repos

# 最高治理等级
aiops init --yes --project my-app --level xhigh

setup

等于 install + init,一步到位。大多数情况下用这个就够了。

aiops setup [options]

config-ui

启动本地 HTTP server,并在浏览器里配置项目迭代、产品版本和微服务主分支绑定。

aiops config-ui --project certificate-system

config-ui 读取 .aiops/projects/<project>/project.yaml 和 iteration-bindings.yaml,展示项目 -> 产品 -> 微服务树。保存时只应写当前项目的 iteration-bindings.yaml,并可安全补齐缺失的 product.yaml 和 service.yaml。它不执行 git checkout,不自动创建或合并分支,不自动提交。

详见 config-ui 使用说明。

link-docs

代码仓库和文档仓库分开管理时,在源码仓库运行:

aiops link-docs --docs-repo ../aiops-docs

该命令只在源码仓库写入本机文件 .aiops-docs.yaml、.aiops-hook-runner.sh,并安装本机 .git/hooks/pre-push。源码仓库不复制完整 .aiops/;push hook 会定位文档仓库并启动 Claude Code 分析未处理提交,进度记录在文档仓库 .aiops/projects/<project>/commit-analysis.md。

选项表

CLI 行为

选项类型默认值说明
-y, --yesflag关闭跳过交互式问答,使用默认值或命令行参数
-h, --helpflag—显示帮助信息

项目配置

选项类型默认值说明
--project <id>string自动推断项目标识,用作 .aiops/projects/<id>/ 的目录名。默认从 package.json 的 name 字段或当前目录名推断
--products <list>stringcore逗号分隔的产品列表。例如 CA,RA,KMC,OCSP
--services <groups>string<product>-service产品到服务的分组,例如 ca:ca-admin+ca-worker,kmc:kmc-admin
--product-repos <mappings>string—产品仓库列表或映射。例如 ca_admin,ra_admin 或 ca=./ca_admin。CLI 会自动生成同名 service,写入每个仓库的 code_root,并读取当前 Git 分支作为 required_branch
--iteration <id>stringcurrent初始化时创建的项目迭代
--docs-branch <branch>stringmain初始化时写入的文档分支
--service-branch <branch>stringdocs branch初始化时写入的微服务主分支
--code-root <path>string当前目录初始化时写入的微服务源码根
--link-product-reposflag关闭初始化后把 --product-repos 中的源码仓库 hook 链接到当前文档库
--level <level>stringhigh治理等级:low、medium、high、xhigh
--language <lang>stringzh-CN知识文档语言

config-ui 选项

选项类型默认值说明
--project <id>string自动推断指定要维护的项目。多个项目时必须提供
--host <host>string127.0.0.1本地 HTTP server 监听地址
--port <port>number自动本地 HTTP server 端口
--no-openflag关闭只启动 server,不自动打开浏览器
--read-onlyflag关闭只查看,不允许保存

路径覆盖

选项类型默认值说明
--skills-source <path>string自动发现技能源目录。默认按顺序尝试:打包内置 → 当前目录 ./skills → 父目录 ../skills → ...
--skills-target <path>string~/.agents/skills 和 ~/.codex/skills运行时技能安装目标目录。多个目录用系统路径分隔符分隔
--tools-root <path>string~/.aiops/tools工具链安装根目录。各工具安装在此目录下,可执行 CLI 的 shim 放在 <tools-root>/../bin

工具链

选项类型默认值说明
--with <tools>stringdefaultdefault 安装全部三个工具;none 跳过全部;逗号分隔列表选择安装。可选项:codegraph、understand-anything、trellis

link-docs

选项类型默认值说明
--docs-repo <path>string无指向 AIOps 文档仓库的路径(必填)

环境变量

CLI 也可以用环境变量覆盖部分配置:

变量对应选项
AIOPS_SKILLS_SOURCE--skills-source
AIOPS_SKILLS_TARGETS--skills-target(用系统路径分隔符)
最近更新: 2026/6/16 16:28
Contributors: Makia98, Makia9879
Next
技能说明