Connector CLI — Install and Use vernclaw-connect-cli

Install the Vernclaw connector CLI to query SEO metrics, including website traffic, backlink rows, and domain authority, read social media content, and generate images from your terminal with Markdown-first output.

Install

npm i -g vernclaw-connect-cli

Requires Node.js 20 or later. After install the vernclaw-cli command is available globally.

Authentication

Browser login (recommended for interactive use):

vernclaw-cli login

Opens 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_KEY

Generate 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 list

login 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 Markdown 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. The SEO connectors below use fixed credits defined on each connector page, and the related DataForSEO SEO docs pages are linked below.

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
`seo.backlinks`	backlinks-get.md	backlinks-get.zh.md
`read.x.post`	x-post-read.md	x-post-read.zh.md
`seo.keyword-search-volume`	keyword-search-volume-get.md	keyword-search-volume-get.zh.md
`seo.keyword-suggestions`	keyword-suggestions-get.md	keyword-suggestions-get.zh.md
`seo.site-keywords`	site-keywords-get.md	site-keywords-get.zh.md
`seo.serp-google-organic`	serp-google-organic-get.md	serp-google-organic-get.zh.md
`seo.site-technologies`	site-technologies-get.md	site-technologies-get.zh.md
`seo.domain-whois`	domain-whois-get.md	domain-whois-get.zh.md
`generate.image`	image-generate.md	image-generate.zh.md

Output Contract

All connector output is Markdown-first: structured Markdown is printed to stdout. Error metadata is written to stderr as ERROR_CODE=<code>.

Exit Codes

Code	Meaning
`0`	Success
`1`	Business rejection (e.g. insufficient credits)
`2`	Authentication failure
`3`	Invalid parameters
`4`	Provider 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:prod

pnpm build:cli builds the npm package from packages/vernclaw-connect-cli/src into dist
pnpm vitest run packages/vernclaw-connect-cli/__tests__ runs the CLI unit test suite
pnpm test:e2e:cli:local runs the live smoke test against http://127.0.0.1:3000
pnpm test:e2e:cli:prod runs the production smoke test after build:cli
pnpm publish:cli builds and publishes the package to npm

Connector catalog: /connectors
Connector docs: /docs/connectors
Connector settings: /settings/connectors
npm: vernclaw-connect-cli
GitHub: hekmon8/vernclaw-connect-cli

Connector CLI — Install and Use vernclaw-connect-cli

On this page