Connector CLI — Install and Use vernclaw-connect-cli
Install the Vernclaw connector CLI to query SEO metrics, read social media content, and generate images from your terminal with JSON-first output.
Install
npm i -g vernclaw-connect-cliRequires Node.js 20 or later. After install the vernclaw-cli command is available globally.
Authentication
Browser login (recommended for interactive use):
vernclaw-cli loginOpens your browser for device-code authorization. Credentials are stored locally at ~/.vernclaw-cli.json.
API key login (for CI/CD and headless environments):
vernclaw-cli login --api-key YOUR_API_KEYGenerate an API key at Connector Settings (sign in → Connector Settings → Create API Key).
Local Development Workflow
When you want the CLI to hit a local Vernclaw instance instead of https://vernclaw.com:
pnpm dev:connectors:local
pnpm install:cli:local
vernclaw-cli login --api-base-url http://localhost:3000 --api-key YOUR_API_KEY
vernclaw-cli listlogin persists both the API key and apiBaseUrl into ~/.vernclaw-cli.json, so subsequent commands keep targeting your local app until you re-login elsewhere. pnpm dev:connectors:local additionally loads .dev.vars, so local invoke requests can reuse the same provider secrets you use for connector development.
Commands
| Command | Description |
|---|---|
vernclaw-cli login | Authenticate via browser or API key |
vernclaw-cli logout | Remove stored credentials |
vernclaw-cli list | List available connectors |
vernclaw-cli describe <connectorId> | Show connector details and parameters |
vernclaw-cli invoke <connectorId> [flags] | Run a connector and print JSON output |
vernclaw-cli job get <jobId> | Check status of an async job |
vernclaw-cli status | Display current login, subscription, and credit status |
Available Connector Skills
Each connector has a dedicated skill file for AI agent integration:
| Connector 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 |
Output Contract
Connector output is JSON-first: a JSON envelope with status and data is printed to stdout by default. Add --pretty to render the same JSON locally for human-readable terminal output. Error metadata is written to stderr as ERROR_CODE=<code>.
SEO connector output is compact for agent use. The CLI never prints full upstream raw payloads. List-style SEO connectors return normalized items with semantic snake_case fields and default to 10 rows; use --limit <n> for more rows or --all for all normalized rows. Google Trends returns summary metrics plus a normalized series with 20 points by default; use --points <n> or --all to expand it. Google Trends is synchronous and may wait up to 60 seconds when DataForSEO is slow, especially for graph requests over longer time windows.
Exit Codes
| Code | Meaning |
|---|---|
0 | Success |
1 | Business rejection (e.g. insufficient credits) |
2 | Authentication failure |
3 | Invalid parameters |
4 | Upstream failure |
Build, Test, and Release
pnpm build:cli
pnpm vitest run packages/vernclaw-connect-cli/__tests__
VERNCLAW_E2E_RUN=1 VERNCLAW_E2E_API_KEY=your_key pnpm test:e2e:cli:local
pnpm test:e2e:cli:prodpnpm build:clibuilds the npm package frompackages/vernclaw-connect-cli/srcintodistpnpm vitest run packages/vernclaw-connect-cli/__tests__runs the CLI unit test suitepnpm test:e2e:cli:localruns the live smoke test againsthttp://127.0.0.1:3000pnpm test:e2e:cli:prodruns the production smoke test afterbuild:clipnpm publish:clibuilds and publishes the package to npm
Related URLs
- Connector catalog: /connectors
- Connector docs: /docs/connectors
- Connector settings: /settings/connectors
- npm: vernclaw-connect-cli
- GitHub: hekmon8/vernclaw-connect-cli