连接器 CLI — 安装和使用 vernclaw-connect-cli

安装 Vernclaw 连接器 CLI，从终端查询 SEO 指标、读取社交媒体内容、生成图像，默认输出 JSON。

安装

npm i -g vernclaw-connect-cli

需要 Node.js 20 或更高版本。安装后即可全局使用 vernclaw-cli 命令。

鉴权

浏览器登录（推荐用于交互式使用）：

vernclaw-cli login

打开浏览器进行设备码授权。凭据存储在本地 ~/.vernclaw-cli.json。

API Key 登录（用于 CI/CD 和无浏览器环境）：

vernclaw-cli login --api-key YOUR_API_KEY

在连接器设置页面生成 API Key（登录 → 连接器设置 → 创建 API Key）。

命令

命令	说明
`vernclaw-cli login`	通过浏览器或 API Key 认证
`vernclaw-cli logout`	移除已存储的凭据
`vernclaw-cli list`	列出可用连接器
`vernclaw-cli describe <connectorId>`	查看连接器详情和参数
`vernclaw-cli invoke <connectorId> [flags]`	运行连接器并输出连接器结果
`vernclaw-cli job get <jobId>`	查看异步任务状态
`vernclaw-cli status`	显示当前登录状态、订阅状态与积分余额

连接器 Skill 列表

每个连接器都有专用的 skill 文件，供 AI Agent 集成参考：

连接器 ID	Skill (EN)	Skill (中文)
`seo.domain-authority`	domain-authority-get.md	domain-authority-get.zh.md
`seo.website-traffic`	website-traffic-get.md	website-traffic-get.zh.md
`read.x.post`	x-post-read.md	x-post-read.zh.md
`generate.image`	image-generate.md	image-generate.zh.md

连接器成功结果和 provider 响应采用 JSON 优先：默认向 stdout 输出包含 status 和 data 的紧凑 JSON envelope。添加 --pretty 时，CLI 会在本地把同一份 JSON 渲染为便于阅读的终端文本。本地 invoke 参数校验错误默认也返回紧凑 JSON。错误码通过顶层 errorCode 字段以及 API 响应中的 x-error-code header 提供。

连接器输出会优先适配 agent 上下文：默认 invoke 不输出 connector 元信息、输入回显、provider 名称或完整上游 raw payload。指标类工具返回 data.summary 和 data.metrics；列表类工具返回 data.summary、data.stats 和 data.items；趋势类工具返回 data.stats、data.metrics 和 data.series；抽取类工具返回 data.document。结构化目录请使用 vernclaw-cli list --json。

退出码

退出码	含义
`0`	成功
`1`	业务拒绝（如积分不足）
`2`	认证失败
`3`	参数错误
`4`	上游失败

构建、测试与发布

pnpm build:cli
pnpm vitest run packages/vernclaw-connect-cli/__tests__
pnpm test:e2e:cli:prod

pnpm build:cli：将 packages/vernclaw-connect-cli/src 构建到 dist
pnpm vitest run packages/vernclaw-connect-cli/__tests__：运行 CLI 单元测试
pnpm test:e2e:cli:prod：在 build:cli 后执行生产环境 smoke test
pnpm publish:cli：构建并发布 npm 包

连接器 CLI — 安装和使用 vernclaw-connect-cli

安装

鉴权

命令

连接器 Skill 列表

输出约定

退出码

构建、测试与发布

相关 URL

On this page