SEOgent — Getting Started

SEOgent helps you find and fix SEO issues across your entire site. You can run scans from the dashboard or from the command line — both use the same engine and produce the same results.

Quick start for AI coding agents: Download the SEOgent SEO Skill to give your AI agent built-in SEO scanning capabilities — no manual setup required.

1. Create an API Token

You need an API token to use the CLI or API. Dashboard scans don't require one.

Log in to your SEOgent account
Navigate to Settings > API Tokens (/settings/api-tokens)
Enter a name for your token (e.g., "My CLI Token") and click Create
Copy the token immediately — it will only be shown once

Keep your token secure. Treat it like a password.

2. Run Your First Scan

From the dashboard

Click New Scan in the dashboard, enter a domain or paste specific URLs, choose your scan options (SEO analysis, Core Web Vitals, link checking, accessibility), and hit Start Scan. You can monitor progress in real time and drill into per-page results once the scan completes. See the Dashboard Guide for a full walkthrough.

From the CLI

Install the CLI globally, authenticate, and start a scan:

npm install -g seogent
seogent auth <your-api-token>
seogent scan https://example.com

This returns a scan ID immediately. Use it to check progress and retrieve results:

seogent status <scan_id>
seogent results <scan_id>

You can add optional flags to extend the scan:

--performance — Include Core Web Vitals (LCP, CLS, INP)
--link-check — Detect dead links and broken images
--a11y — Run WCAG 2.1 AA accessibility checks
--max-pages <n> — Cap the number of pages discovered

Combine them as needed:

seogent scan https://example.com --performance --link-check --a11y --max-pages 100

For every command and flag, see the CLI Reference. For direct HTTP API usage, see the API Reference.

3. Understand Your Results

Every scanned page receives a 0–100 SEO score and a letter grade. Results are grouped into categories — meta tags, indexability, crawlability, content quality, and (optionally) performance and accessibility.

Dashboard — Visual score breakdowns, top issues across your site, per-page drill-downs, and historical comparisons. See the Dashboard Guide.
API — JSON responses you can integrate into any workflow. See the API Reference.
CLI — Pipe-friendly JSON output for jq, CI/CD pipelines, and scripting. Use --issues-only and --min-severity high to focus on what matters. See the CLI Reference.

4. Authentication Options (CLI)

The CLI supports three ways to provide your API token:

Config file (recommended for daily use): seogent auth <your-api-token> — stores in ~/.seogent/config.json
Environment variable (recommended for CI/CD and agents): export SEOGENT_API_KEY=<your-api-token>
Inline flag (one-off commands): seogent scan https://example.com --api-key <your-api-token>

Priority order: --api-key flag > environment variable > config file.

5. Managing Your Tokens

You can manage your API tokens at any time from the SEOgent dashboard:

Create additional tokens for different environments (development, CI, production)
Revoke a token if it's compromised or no longer needed
Monitor when each token was last used

Navigate to Settings > API Tokens to manage your tokens.

Next Steps

Dashboard Guide — Learn every screen in the SEOgent dashboard
API Reference — Full REST API endpoint and response documentation
CLI Reference — CLI command and flag reference
Agent Skill Guide — Set up AI coding agents to scan and fix SEO issues automatically

Download the SEO Skill for AI Agents

Want to get started even faster? Download the SEOgent SEO Skill — a ready-made skill package that lets AI coding agents like Claude Code run SEO scans directly. Just drop it into your project and your agent can start scanning.