xyle

CLI for the Xyle SEO Intelligence Engine.

Install

npm install -g xyle

Requires Node.js 18+.

Quick Start

# Check API connectivity
xyle status

# Authenticate with Google (opens browser)
xyle login

# List top queries for your site
xyle queries --site example.com

# Analyze competitor pages
xyle competitors --query "best seo tools"

# Find content gaps
xyle gaps --page https://example.com/blog/seo-guide

# Get AI rewrite suggestions
xyle rewrite --url https://example.com/blog/seo-guide --type title

# Crawl a page
xyle crawl --url https://example.com/blog/seo-guide

# Full-site crawl (BFS every internal page, detect site-wide issues)
xyle site-crawl https://example.com --max-pages 500

# View snapshot history
xyle history --url https://example.com

# View score trends
xyle trends --site example.com --days 30

# Compare two snapshots
xyle diff --before <snapshot-id> --after <snapshot-id>

# Sync Search Console data
xyle sync --site https://example.com

Commands

| Command | Description | | ------------- | ---------------------------------------------- | | status | Check if the SEO API is reachable | | setup | Check backend requirements and Playwright info | | queries | List top search queries for a site | | competitors | Show competitor pages for a query | | gaps | Show content gaps for a page | | analyze | Analyze page content against competitors | | rewrite | Get AI rewrite suggestions | | crawl | Crawl a URL and extract SEO metadata | | site-crawl | Full-site BFS crawl with issue detection, link graph, and site health score | | history | View snapshot history for a URL or site | | trends | View score trends over time | | diff | Compare two snapshots side-by-side | | sync | Sync Google Search Console data | | login | Authenticate with Google OAuth | | logout | Remove stored credentials | | whoami | Show current authentication status | | seed | Add xyle agent instructions to your project |

All data commands accept --json for machine-readable output.

Playwright (Server-Side)

The Xyle API uses Playwright to crawl JS-rendered pages (SPAs). If you self-host the API backend, install Chromium once:

pip install playwright
playwright install chromium

Docker deployments handle this automatically. Skip this if using the hosted API.

Configuration

| Environment Variable | Default | Description | | -------------------- | ------------------------ | -------------------- | | SEO_BASE | https://api.xyle.app | API base URL | | AGENT_API_KEY | local-agent-secret-key | Fallback API key |

Credentials are stored in ~/.config/xyle/credentials.json (shared with the Python CLI).