--- title: "SEO documentation | SEO Skill" description: "Install the SEO CLI, connect your site and run your first audit. Each report shows the pages and search data behind its recommendations." canonical: "https://seoskill.dev/docs" language: "en" --- # SEO documentation Install the SEO CLI, connect your site and run your first audit. Each report shows the pages and search data behind its recommendations. Run an SEO audit on your own computer. It crawls your site, reads the Google data you choose to connect and shows why each recommendation was made. Connect an optional research provider when you need keyword ideas, current result snapshots, domain footprints, competitor discovery or keyword gap and referring-link research. You can use it yourself in a terminal or give the same reports to an AI agent through skills, JSON, or a local MCP server. Either way, the analysis comes from the same code. ## Install the CLI and agent skill An agent gets the best result with both parts of the project: - The CLI crawls sites, connects Google, and runs consistent reports through the terminal or MCP. - The agent skill teaches the agent which report to run and what to verify before changing a site. One command installs the CLI: ```sh npm i -g seo ``` Guided setup offers the agent skill during onboarding, so there is no separate command to remember. You can also add the skill later with `seo skill install`. The CLI still works on its own for people, scripts, and CI. The skill can teach an agent about the reports, but it still needs access to the CLI to run them. ## Get your first useful report You need Node 22 or newer. With the command installed, start guided setup: ```sh seo start ``` The setup opens Google sign-in, lets you choose a Search Console property, offers optional traffic analytics for context, and saves those choices as a local project profile. Then run: ```sh seo report ``` The main report checks the data that is available, tells you which sections could not run, and points you to a small number of focused follow-ups. The [getting started guide](https://seoskill.dev/docs/getting-started) walks through the result and the local files created during setup. You can start before connecting Google. ```sh seo report --url https://example.com ``` That run crawls the site without using Search Console. Connect Google later when you want search performance and query data. ## Get to the right fix faster A technical baseline starts with a crawl. A question about underperforming page-one queries needs Search Console evidence instead. The focused report gets you to the affected queries and pages without unrelated crawl findings. The CLI includes 74 discoverable reports. They cover jobs such as: - finding low-CTR rankings on page one and realistic page-two opportunities; - checking one page before a rewrite, redirect, canonical change, or release; - finding broken URLs that still have evidence of search value; - comparing saved crawls after a deploy; - separating a real decline from a partial or unfinished data window; - inspecting technical eligibility for search and AI search features; - researching keywords, ranking pages and recurring search competitors; - filtering competitor terms through Search Console data and programmatic page patterns; - finding location-specific demand and repeated local page patterns before checking a few exact local results. Browse the [report catalog](https://seoskill.dev/docs/reports) by goal. The [crawler guide](https://seoskill.dev/docs/crawler) explains the page evidence behind technical findings. ## Add post-click context when it changes the priority Search Console provides search performance and query data. Traffic analytics is optional. Google Analytics adds sessions, engagement, conversions, geography and known referral sources. Clicky adds observed page views and landing-page visits. Analytics connections are read-only. Tokens, provider secrets, project profiles, caches, and saved crawls stay on your machine. The [Google data guide](https://seoskill.dev/docs/google) explains local Google sign-in. Optional provider packages keep their setup instructions in their package repositories. The [research provider guide](https://seoskill.dev/docs/research-providers) covers provider setup, local spend limits, caching and the reports that can use outside estimates. ## Let an agent act without redoing the analysis Agents should start with the main report, then open the affected pages or queries for the few findings that deserve action. [ Install the SEO CLI, connect Search Console, save a local project profile, and run your first useful report. Getting started ](https://seoskill.dev/docs/getting-started)[ Connect read-only Search Console and optional Google Analytics data. Google data ](https://seoskill.dev/docs/google)[ Connect one verified Bing site and review traffic trends, crawl changes and search opportunities. Bing Webmaster ](https://seoskill.dev/docs/bing)[ Connect optional providers locally, control paid work and combine keyword, domain, competitor and page estimates with Search Console data. Research providers ](https://seoskill.dev/docs/research-providers)[ Connect DataForSEO for keyword, result, domain, link and AI search research. DataForSEO ](https://seoskill.dev/docs/dataforseo)[ Connect a Semrush Version 3 key for keyword, domain, ranking-page and competitor research. Semrush ](https://seoskill.dev/docs/semrush)[ Connect an Ahrefs API v3 key for keyword, domain, competitor, Domain Rating and backlink research. Ahrefs ](https://seoskill.dev/docs/ahrefs)[ Generate and verify a local key, then submit a selected list of changed URLs. IndexNow ](https://seoskill.dev/docs/indexnow)[ Run focused SEO reports yourself, produce deterministic JSON, and reuse the same commands in scripts and CI. CLI ](https://seoskill.dev/docs/cli)[ Install the seo package in a Node app, call typed core functions, or run the same report catalog used by the CLI and MCP. TypeScript package ](https://seoskill.dev/docs/typescript)[ Crawl a site, inspect affected URLs and compare technical changes after a release. Crawler ](https://seoskill.dev/docs/crawler)[ Choose the report that answers your question and see what to do next. SEO reports ](https://seoskill.dev/docs/reports)[ Create a standalone HTML report yourself or ask an agent to design one. HTML reports ](https://seoskill.dev/docs/html-reports)[ Check technical eligibility, entity evidence, and known referrals without inventing an AI visibility score. AI search evidence ](https://seoskill.dev/docs/ai-search)[ Track fixed AI prompts, answers, mentions, citations, model changes and exact provider costs without inventing a universal score. AI visibility tracking ](https://seoskill.dev/docs/ai-visibility)[ Connect any agent that supports local stdio MCP. Guided setup covers Codex, Claude Code, Claude Desktop, and Cursor. Local MCP ](https://seoskill.dev/docs/mcp)[ Install focused instructions that teach an agent which report to run, how to read it, and what to verify next. Agent skill ](https://seoskill.dev/docs/skill)[ Help an agent choose the right report, inspect the result and verify important changes. Agent workflows ](https://seoskill.dev/docs/agents) ## Questions and bugs belong on GitHub Open a [GitHub issue](https://github.com/iannuttall/seo/issues) for ordinary questions and bugs. Leave tokens, account identifiers, private URLs, and client reports out of public issues. Suspected vulnerabilities belong in the [private security reporting flow](https://seoskill.dev/security).