vernclaw-connect-cli
v0.1.7
Published
Official Vernclaw connector CLI with JSON-first output.
Readme
vernclaw-connect-cli
Official command-line interface for Vernclaw Connectors — query SEO metrics, read social media content, and generate images from your terminal with JSON-first connector output.
Install
npm i -g vernclaw-connect-cliAuthentication
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 vernclaw.com/settings/connectors (sign in → Connector Settings → Create API Key).
By default, the CLI targets https://vernclaw.com. For local or self-hosted environments, pass --api-base-url or set VERNCLAW_CLI_API_BASE_URL.
Local Development Against a Local Vernclaw App
pnpm dev:connectors:local
pnpm install:cli:local
vernclaw-cli login --api-base-url http://localhost:3000 --api-key YOUR_API_KEY
vernclaw-cli listThe login command stores the local apiBaseUrl in ~/.vernclaw-cli.json, so follow-up commands keep targeting your local app until you log in again against another environment.
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 |
list prints a human-readable connector table by default. Use vernclaw-cli list --json when an agent or script needs the structured catalog payload.
Available Connectors
| Connector ID | Category | Mode | Skill |
| --------------------------- | -------- | ----- | --------------------------------------------------------- |
| seo.domain-authority | SEO | sync | Skill |
| seo.website-traffic | SEO | sync | Skill |
| seo.backlinks | SEO | sync | Skill |
| seo.backlinks-summary | SEO | sync | Skill |
| seo.serp-google-organic | SEO | sync | Skill |
| seo.google-trends | SEO | sync | Skill |
| seo.domain-rank-overview | SEO | sync | Skill |
| seo.keyword-search-volume | SEO | sync | Skill |
| seo.keyword-suggestions | SEO | sync | Skill |
| seo.site-keywords | SEO | sync | Skill |
| seo.site-technologies | SEO | sync | Skill |
| seo.domain-whois | SEO | sync | Skill |
| read.x.post | Social | sync | Skill |
| generate.image | AI | async | Skill |
Quick Examples
# Check domain authority
vernclaw-cli invoke seo.domain-authority --domain example.com
# Estimate website traffic
vernclaw-cli invoke seo.website-traffic --domain example.com
# Expand a seed keyword
vernclaw-cli invoke seo.keyword-suggestions --keywords "openai" --market us --language english
vernclaw-cli invoke seo.keyword-suggestions --keywords "openai" --market us --limit 20
# Review a domain's keyword footprint
vernclaw-cli invoke seo.site-keywords --target openai.com --market us --language english
vernclaw-cli invoke seo.site-keywords --target openai.com --market us --all
# Inspect live Google organic results
vernclaw-cli invoke seo.serp-google-organic --keyword "openai" --market us --language english --device desktop --os windows --depth 5
# Inspect keyword trend trajectory
vernclaw-cli invoke seo.google-trends --keywords "openai" --market us --language english
vernclaw-cli invoke seo.google-trends --keywords "openai" --market us --points 50
# Fetch backlink summary snapshot
vernclaw-cli invoke seo.backlinks-summary --target openai.com
# Check domain rank overview
vernclaw-cli invoke seo.domain-rank-overview --target openai.com --market us
# Detect public technologies
vernclaw-cli invoke seo.site-technologies --target openai.com
# Inspect Whois timestamps
vernclaw-cli invoke seo.domain-whois --target openai.com
# Read an X/Twitter post
vernclaw-cli invoke read.x.post --url "https://x.com/user/status/123"
# Generate an image (async — returns a job ID)
vernclaw-cli invoke generate.image --prompt "sunset over mountains"
vernclaw-cli job get img_abc123
# Check account status
vernclaw-cli statusOutput Contract
All connector output is JSON-first: a JSON envelope is printed to stdout by default. Add --pretty to print human-readable terminal text instead. Error metadata is written to stderr as ERROR_CODE=<code>.
SEO connector output is optimized for agents: full upstream raw payloads are never printed by the CLI. List-style SEO connectors return normalized items with semantic snake_case fields and default to 10 rows; pass --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; pass --points <n> or --all to expand it.
Exit Codes
| Code | Meaning |
| ---- | ---------------------------------------------- |
| 0 | Success |
| 1 | Business rejection (e.g. insufficient credits) |
| 2 | Authentication failure |
| 3 | Invalid parameters |
| 4 | Provider failure |
Development
npm install
npm run buildCompiles src into dist.
Testing
npm test
VERNCLAW_E2E_RUN=1 VERNCLAW_E2E_API_KEY=your_key npx vitest run __tests__/e2e.production.test.ts
VERNCLAW_E2E_RUN=1 VERNCLAW_E2E_API_KEY=your_key pnpm test:e2e:cli:local
VERNCLAW_E2E_API_KEY=your_key pnpm test:e2e:cli:prodUse VERNCLAW_E2E_RUN=1 together with VERNCLAW_E2E_API_KEY and optionally VERNCLAW_E2E_API_BASE_URL to enable the live e2e smoke test. pnpm test:e2e:cli:local assumes a local app is already running on http://127.0.0.1:3000, preferably via pnpm dev:connectors:local.
pnpm test:e2e:cli:prod now runs as a production success gate: it forces VERNCLAW_E2E_RUN=1, defaults VERNCLAW_E2E_EXPECT_SUCCESS=1, and fails fast when VERNCLAW_E2E_API_KEY is missing.
Publish / Deploy
npm pack --dry-run
npm publishnpm publish triggers prepack, which rebuilds dist before publishing. dist is treated as a generated publish artifact and is not tracked in git.
Links
- Website: https://vernclaw.com
- Connector catalog: https://vernclaw.com/connectors
- Connector docs: https://vernclaw.com/docs/connectors
- CLI docs: https://vernclaw.com/docs/connectors/cli
- npm: https://www.npmjs.com/package/vernclaw-connect-cli
- GitHub: https://github.com/hekmon8/vernclaw-connect-cli
License
MIT
