Connector CLI (vernclaw-connect-cli) — Install, Login, List, Invoke
Install vernclaw-connect-cli and run the connector CLI in five commands: install, login, list connectors, describe parameters, invoke, and check job status.
Quick Start
Five commands from zero to first connector result:
npm i -g vernclaw-connect-cli # install the connector CLI
vernclaw-cli login # authenticate (browser opens)
vernclaw-cli list # list available connectors
vernclaw-cli describe seo.google-trends # inspect parameters
vernclaw-cli invoke seo.google-trends --keywords "openai" --market us # run itRequires Node.js 20 or later. The vernclaw-cli command is available globally after install.
Need a repeatable agent workflow after install? Use the MCP connector workflow guide for JSON parsing, batch tasks, and agent skills.
Install
npm i -g vernclaw-connect-cliLogin
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 API Keys (sign in → API Keys → Create API Key).
List and Describe
vernclaw-cli list # human-readable connector table
vernclaw-cli list --json # JSON catalog for scripting
vernclaw-cli describe seo.google-trends # show parameters for one connectorlist --json returns a compact JSON payload for agent and script use:
{
"status": 200,
"data": {
"command": "list",
"count": 3,
"connectors": [
{ "id": "seo.website-traffic", "category": "SEO", "status": "available" },
{ "id": "seo.google-trends", "category": "SEO", "status": "available" },
{ "id": "generate.image", "category": "AI", "status": "available" }
],
"hints": []
}
}Invoke a Connector
vernclaw-cli invoke seo.website-traffic --domain example.comSync connectors print results immediately. Async connectors (such as generate.image) return a job ID. Poll it with:
vernclaw-cli job get <jobId>Add --pretty to any invoke call for human-readable terminal output instead of compact JSON.
Check Account Status
vernclaw-cli statusPrints your current login identity, active subscription tier, and remaining credit balance.
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 connector output |
vernclaw-cli job get <jobId> | Check status of an async job |
vernclaw-cli status | Display current login, subscription, and credit status |
Output Format
All connector results use a JSON-first envelope printed to stdout:
{
"status": 200,
"data": {
"summary": "...",
"metrics": {}
}
}- Metric tools:
data.summary+data.metrics - List tools:
data.summary+data.stats+data.items - Trend tools:
data.stats+data.metrics+data.series - Extract tools:
data.document
Add --pretty to render the same JSON as readable terminal text. Errors expose errorCode at the top level and x-error-code in API response headers.
Exit Codes
| Code | Meaning |
|---|---|
0 | Success |
1 | Business rejection (e.g. insufficient credits) |
2 | Authentication failure |
3 | Invalid parameters |
4 | Upstream failure |
Provider Keys
Most CLI users only need a Vernclaw login or API key. Connector access is managed by Vernclaw, so individual CLI users do not configure separate service credentials.
Available Connector Skills
Each connector ships with a SKILL.md for AI agent integration via vernclaw-connect-cli on GitHub:
| Connector ID | Category | Mode | Skill |
|---|---|---|---|
generate.image | AI | async | vernclaw-image-generate |
seo.website-traffic | SEO | sync | vernclaw-website-traffic-get |
seo.backlinks | SEO | sync | vernclaw-backlinks-get |
seo.serp-google-organic | SEO | sync | vernclaw-serp-google-organic-get |
seo.google-trends | SEO | sync | vernclaw-google-trends-get |
seo.keyword-search-volume | SEO | sync | vernclaw-keyword-search-volume-get |
seo.keyword-suggestions | SEO | sync | vernclaw-keyword-suggestions-get |
seo.site-keywords | SEO | sync | vernclaw-site-keywords-get |
seo.site-technologies | SEO | sync | vernclaw-site-technologies-get |
seo.backlinks-summary | SEO | sync | vernclaw-backlinks-summary-get |
seo.domain-rank-overview | SEO | sync | vernclaw-domain-rank-overview-get |
seo.domain-whois | SEO | sync | vernclaw-domain-whois-get |
seo.domain-authority | SEO | sync | vernclaw-domain-authority-get |
read.x.post | Social | sync | vernclaw-x-post-read |
read.x.replies | Social | sync | vernclaw-x-post-replies-read |
read.x.article | Social | sync | vernclaw-x-article-read |
search.x | Social | sync | vernclaw-x-search |
search.youtube | Video | sync | vernclaw-youtube-search |
read.youtube.video | Video | sync | vernclaw-youtube-video-read |
search.producthunt | Product | sync | vernclaw-producthunt-search |
list.producthunt.launches | Product | sync | vernclaw-producthunt-launches-list |
search.web | Search | sync | vernclaw-web-search |
extract.url | Extract | sync | vernclaw-url-extract |
FAQ
What npm package provides the vernclaw-cli command?
The npm package is vernclaw-connect-cli. Install with npm i -g vernclaw-connect-cli. After install, the global command is vernclaw-cli.
How do I use the connector CLI without a browser (headless/CI)?
Run vernclaw-cli login --api-key YOUR_API_KEY. Generate the key at /settings/apikeys.
How do I list all available connectors as JSON?
Run vernclaw-cli list --json. The response contains a data.connectors array with each connector's id, category, and availability status.
How do I use the CLI in an AI agent workflow?
Use status → list --json → describe → invoke → job get as the stable chain. See the MCP connector workflow guide for full examples.
How do I check my credit balance or subscription status?
Run vernclaw-cli status. It prints your login identity, subscription tier, and remaining credit balance.
How do I check whether an async job finished?
Run vernclaw-cli job get <jobId> with the job ID returned by invoke. Poll until status is "ok" or "error".
Related
Backlinks Summary Tool - Aggregate Backlink Metrics
Retrieve fast backlink summary signals for a domain including total backlinks, referring domains, and top referring domain.
Domain Authority Checker API - Free DR and Domain Rank Lookup
Use Vernclaw's domain authority checker API to inspect free DR and optional rank signals before deeper domain rank, traffic, or backlink analysis.