@chuangkit-labs/agent-cli
v0.1.3
Published
Command-line client for Chuangkit Agent creative workflows
Readme
@chuangkit-labs/agent-cli
ckt-agent 是创客贴 Agent 创作 CLI,适用于 WorkBuddy 以及其他支持 CLI Skill 的 Agent 宿主。
运行环境要求 Node.js 18 及以上;WorkBuddy Connector 会准备 Node.js 20。
安装
npm install --global @chuangkit-labs/agent-cli安装后使用的命令名是 ckt-agent。
认证
ckt-agent auth login
ckt-agent auth status
ckt-agent auth logout在 WorkBuddy 的服务端认证模式下,auth login 创建一次性授权会话,输出浏览器授权地址和一次性验证码后退出。浏览器页面负责:
- 判断创客贴登录状态,未登录时先完成登录;
- 根据授权上下文动态展示客户端、WorkBuddy、权限和过期时间;
- 查询当前用户的脱敏 AccessKey 列表;
- 列表为空时创建一个新的 AccessKey;
- 用户选择一个 AccessKey,输入 CLI 显示的一次性验证码并确认;
ckt-agent auth status轮询授权状态,完成一次性凭证换取并保存到本地配置。
auth status 在等待授权或认证失败时返回非 0 退出码;认证成功时输出 Authenticated 并返回 0。
auth logout 清理本地凭证和未完成的授权会话,不删除创客贴账户中的 AccessKey。
已有 Skill 用户仍可通过 CHUANGKIT_AGENT_SKILL_API_KEY 提供 Bearer Token。未启用服务端认证模式时,CLI 也保留交互式 AccessKey 登录方式。
常用命令
ckt-agent asset upload --file /path/to/reference.png
ckt-agent design switch
ckt-agent message send --message "生成一张夏日饮品海报"
ckt-agent request status --request-id "<request_id>"
ckt-agent result download --request-id "<request_id>"所有命令结果均为 JSON。凭证保存在用户配置目录中,文件使用受限权限。
配置项
| 环境变量 | 说明 |
| --- | --- |
| CHUANGKIT_CLI_AUTH_MODE=server | 启用 WorkBuddy 服务端认证模式 |
| CHUANGKIT_AGENT_HOST=workbuddy | 标识发起授权的宿主,WorkBuddy Connector 已自动设置 |
| CHUANGKIT_CLI_CONFIG_DIR | 指定 CLI 配置目录 |
| CHUANGKIT_AGENT_SKILL_API_KEY | 兼容已有 Skill 的 Bearer Token |
| CHUANGKIT_AGENT_SKILL_BASE_URL | 覆盖默认 API 地址 |
| CHUANGKIT_AGENT_AUTH_BASE_URL | 覆盖认证接口地址 |
默认 Skill API 地址为 https://moni-gw.chuangkit.com/aigc,认证接口地址为 https://moni-gw.chuangkit.com/contentcopyright。
本地开发
npm test
node bin/chuangkit.js --help
npm pack --dry-run发布
在仓库根目录直接执行一键发布脚本:
./cli/release.sh脚本会自动运行测试、升级 patch 版本、同步 WorkBuddy 安装版本、检查打包内容并发布 npm。发布成功后,再提交版本变更;发布失败时会恢复自动升版产生的修改。
English documentation: README.en.md。
