cgmk CLI

cgmk 是一个面向内容同步、AI 调用、多媒体处理与脚本联调的命令行工具。

• npm 包名：@cagoe/mkcli
• 命令名：cgmk
• 当前发布阶段：0.0.1

0.0.x 仍属于持续迭代阶段。已经能安装和使用，但不承诺接口完全稳定；命令、参数和输出结构后续仍可能调整。

安装

要求：

• Node.js >= 18

全局安装：

npm install -g @cagoe/mkcli

安装完成后，直接使用：

cgmk --help
cgmk --version

先看什么

如果你第一次使用，建议先按这个顺序：

1. cgmk --help
2. cgmk doctor
3. cgmk config init
4. cgmk config show

这样可以先确认命令入口、当前环境和本地配置是否就绪。

常见用法

检查环境与配置：

cgmk doctor
cgmk config init
cgmk config show

文档解析：

cgmk doc engines
cgmk doc doctor
cgmk doc parse --file /abs/path/to/file.pdf

内容同步：

cgmk sync feishu check --file /abs/path/to/note.md
cgmk sync feishu pull --file /abs/path/to/note.md
cgmk sync feishu push --file /abs/path/to/note.md

图片处理：

cgmk image trim --input /abs/path/to/input.png
cgmk image remove-bg --input /abs/path/to/input.png
cgmk image resize --input /abs/path/to/input.png --width 1200

AI 能力：

cgmk ai chat --prompt "你好"
cgmk ai search --query "OpenAI Responses API"
cgmk ai image text2image --prompt "一只白色戴眼镜的小猫"

配置说明

大多数命令都依赖本地配置或环境变量。

常见入口：

• cgmk config init
• cgmk config show
• cgmk config set --key <path> --value <value>

如果某个 provider、模型或远端平台没有配置完成，通常可以先跑：

cgmk doctor

发布包内容

当前 npm 发布包默认只包含：

• dist/**
• README.md

不会发布 src/**、tests/**、docs/**。

命令索引

下面这段列表既给使用者快速扫命令面，也作为 README 的稳定命令声明源。

• cgmk doctor
• cgmk doc bootstrap
• cgmk doc doctor
• cgmk doc engines
• cgmk doc parse
• cgmk config init
• cgmk config show
• cgmk config set
• cgmk sync feishu check
• cgmk sync feishu pull
• cgmk sync feishu push
• cgmk sync yuque check
• cgmk sync yuque pull
• cgmk sync yuque push
• cgmk sync yuque import-bridge
• cgmk storage check
• cgmk storage upload
• cgmk resource extract
• cgmk resource download
• cgmk resource credits
• cgmk resource clear-origin-tag
• cgmk resource doctor
• cgmk image resize
• cgmk image crop
• cgmk image convert
• cgmk image watermark
• cgmk image trim
• cgmk image remove-bg
• cgmk image upscale
• cgmk video probe
• cgmk video cut
• cgmk video extract-audio
• cgmk ai chat
• cgmk ai search
• cgmk ai image
• cgmk ai image text2image
• cgmk ai image image2image
• cgmk ai image jimeng-doctor
• cgmk ai video
• cgmk ai video text2video
• cgmk ai video image2video
• cgmk ai video frames2video
• cgmk ai video subject2video
• cgmk ai video query-result
• cgmk ai video list-task
• cgmk ai video show-task
• cgmk ai vision
• cgmk ai speech
• cgmk ai speech list-voice
• cgmk ai speech clone-voice
• cgmk ai speech design-voice
• cgmk ai speech delete-voice
• cgmk ai speech query-result
• cgmk ai speech list-task
• cgmk ai speech show-task

开发说明

如果你是这个仓库的开发者，再继续看这些文件：

• src/README.md
• AGENTS.md

本地开发常用命令：

npm install
npm run build
npm test
npm run docs:build