Documentation

Get started with GetRank

Connect GetRank to ChatGPT or Claude and ask, or install the CLI. Either way you get your first prioritized SEO report in about a minute.

Connect to ChatGPT or Claude

The fastest way to use GetRank. Add it as a tool once, then ask in plain English.

terminal
$ getrank connect claude
→ Opening browser to authorize…
✓ Connected. Now ask GetRank anything in Claude.
In Claude or ChatGPT, try: Audit acme.com and list my top 5 fixes.

Installing the CLI

For teams and automation, GetRank ships as a single command line binary. Install it globally with npm:

terminal
$ npm i -g getrank

$ getrank --version
getrank/1.0.0
Requires Node.js 18 or newer. Prefer not to install globally? Run it on demand with npx getrank.

Quickstart

Run a full audit against any domain. GetRank crawls the site, analyzes rankings, keywords and backlinks, and writes a prioritized report.

terminal
$ getrank audit acme.com

◆ Crawling acme.com … 148 pages
◆ Analyzing keywords & backlinks
✓ Report saved → getrank-report.md

audit

Run a complete technical and on page audit and produce a prioritized fix list.

getrank audit <domain>Full audit of a site
--depth <n>Max crawl depth (default: full site)
--vs <competitor>Benchmark against a competitor
--fail-on <level>Exit nonzero on high/med issues (for CI)
--format <md|json|html>Report format (default: md)

keywords

Research keywords from a seed term, with volume, difficulty and live SERP data.

getrank keywords "<seed>"Discover & score keyword ideas
--gap <competitor>Show keywords a rival ranks for and you don't
--quick-winsOnly surface page two rankings worth a push
--out <file.csv>Export the full keyword set

Map a backlink profile and surface ranked link building opportunities.

getrank backlinks <domain>Analyze the backlink profile
--vs <competitor>Backlink gap vs. a competitor
--min-dr <n>Only prospects above a domain rating
--out <file.csv>Export contactable prospects

chat

Skip the flags and just talk to the agent. Ask questions in plain English and it decides which tools to run.

terminal
$ getrank chat
 why is acme.com/pricing slow, and who outranks us for "seo tool"?

◆ Checking Core Web Vitals for /pricing…
◆ Pulling SERP for "seo tool"…
LCP is 4.1s, driven by an unoptimized 1.2MB hero image.
Top 3 are ahrefs.com, semrush.com, moz.com. You sit #14…

Output formats

Every command can emit human readable Markdown, standalone HTML, or machine readable JSON for downstream tooling.

  • --format md, a clean report to read or commit to your repo.
  • --format html, a shareable, self contained page (white label on Agency).
  • --format json, structured data for scripts, dashboards and pipelines.

Automation

Because GetRank has a CLI, it drops into any pipeline. Gate a deploy on a clean audit, or schedule a recurring report.

crontab
# weekly audit, emailed every Monday at 08:00
0 8 * * 1  getrank audit acme.com --email me@acme.com

# fail CI on any high severity regression
$ getrank audit acme.com --fail-on high
Need help wiring GetRank into your stack? Get in touch, we're happy to help.