Skip to content
rctrl Docsrctrl Docs

CLI reference

Every rankcontrol command, grouped by area, with flags and examples.

All commands print JSON. Authenticate once with rankcontrol login or export RANKCONTROL_API_KEY. Commands marked dry run do nothing until you add --confirm. Removals and team changes print an approval link instead: the workspace owner approves them in RankControl.

Setup

Command What the command does
login Browser device authorization; saves a key with full access to your workspace to ~/.rankcontrol.
logout Remove the locally stored key.
mcp Start the MCP server on stdio, for Claude, Cursor, and other agents.

Overview and reports

Command What the command does
funnel AI pipeline, last 30 days: crawler hits, AI-referred visits.
question-movers Tracked queries whose citation rate moved most this week.
expedition The workspace’s expeditions on the Overview: the current expedition, each step’s name and whether it is done, and the next step.
report Executive summary: last 30 days vs the 30 before.
wins Biggest wins: most-cited page, cite-rate jump, ranking climb, best new backlink (spam left out).
agent-activity Recent runs per agent lane. --per-agent <n>, --since-days <n>.
jobs Recent agent runs, async job status. --limit <n>.
traffic Page views, visitors, sessions, bounce rate, scroll depth, change from the period before. --days 7|30|90. --scope site: the whole site from Google Analytics, when connected. With key events tracked, what AI visitors did.
traffic-trend Visits to your articles over time. --days 7|30|90.
traffic-pages Visits to each of your articles. --days 7|30|90.
traffic-sources Where visits to your articles came from. --days 7|30|90.
search-console Search Console totals and daily clicks and impressions. --days 7|30|90.
search-console-queries Top Search Console searches by clicks. --days 7|30|90.
search-console-trend Search Console clicks and impressions by day. --days 7|30|90.
engagement Per-page views and citations with 30-day sparklines.
rankings Google and Bing positions per keyword, Search Console clicks and impressions, and how often Google’s AI Overview shows above each keyword and names you. --scope ours|site.
movers Biggest Google position changes in the last 30 days. --scope ours|site.
google-vs-ai Every tracked question: its place in Google’s top 30 beside whether each AI engine mentioned or cited you, with the row’s state.
ai-crawling AI crawler visits: the total, each crawler’s visits with the busiest first, and each day’s visits per crawler. --days 7|30|90.

Analytics

Command What the command does
analytics-sources Per-org analytics sources: selections, qualified options, Cloudflare/plugin/embed install state.
analytics-set-source <dataType> <source> Select the writer for a data type (validated against what the setup supports).
analytics-activate <screen> Turn on the Analytics or Reports screen for this workspace.

Visibility

Command What the command does
score Composite visibility score with per-pillar subscores; lastChecked is the newest check’s day when it is over 8 days old. --topic <topic>, --engines <ids>.
visibility Daily AI visibility trend. --days 30|60|90, --topic <topic>, --engines <ids>.
sov Share of voice vs competitors. --days <n>, --topic <topic>, --engines <ids>.
competitors Tracked competitors with their other names and sites, visibility score, 30-day citations of checks, 30-day win rate, domain metrics and positioning analysis. --topic <topic>, --engines <ids>.
competitor-add <name> [websiteUrl] Track a competitor (max 10); the site is resolved from the name when omitted.
competitor-edit <competitorId> Set a tracked competitor’s other names and sites: --aliases and --sites, comma-separated, each replacing its list. Removing one waits for the owner’s approval in RankControl.
competitor-remove <competitorId> Stop tracking a competitor (waits for the owner’s approval in RankControl).
web-totals Monthly web total for your domain and every competitor you track, last 3 months, oldest month first.
footprint Web footprint (0-10) for your domain and every competitor you track, with the median peer.
sources Domains AI answers cite for your tracked queries. --days <n>, --topic <topic>, --engines <ids>. --pages lists the cited pages instead, each with its type and its answers in the last 4 weekly checks and the 4 before.
sentiment How AI answers frame your brand when cited. --days <n>, --topic <topic>, --engines <ids>.
citations Recent citation checks; branded marks one whose question names your brand. contradiction marks one whose answer contradicts one of your facts. --model chatgpt|perplexity|..., --limit <n>, --topic <topic>, --engines <ids>, --before <time> to page back. --csv prints CSV instead of JSON.
queries List the tracked queries, each with how many of the AI engines that answered it cited it in their latest check; noAnswer names an engine with no answer (Google shows an AI Overview for some questions only). branded marks a question that names your brand, which doesn’t count toward your score. --topic <topic>, --engines <ids>. --csv prints CSV instead of JSON.
query-slots Tracking slots in use and the plan’s limit.
query-add <queryText> Add a query to the pool; tracks immediately when a slot is free.
query-edit <queryId> <queryText> Edit a tracked query’s text. A spelling fix keeps its history. Any other change starts a new query in the same slot and waits for the owner’s approval.
query-track <queryId> <on|off> Pause or resume weekly checks on a query. Tracking uses one of your tracking slots; pausing frees it.
query-remove <queryId> Delete a query.
crawler-access Daily probe: is your edge or robots.txt blocking the AI search crawlers.

--topic takes a topic’s id or name from topics, or none for the questions with no topic. --engines takes engine ids, comma-separated (chatgpt,claude), and counts only those engines’ answers.

Content

Command What the command does
content List content pages with status.
insights Action Items: what to work on next on your site, with the evidence for each item.
insight-plan <itemId> Plan up to 3 articles that link to the item’s page. Dry run until --confirm.
insight-hide <itemId> Hide an action item. It moves under Done as Hidden and does not come back.
insight-move <itemId> Save a search no page is about for Plan Content, tagged Search Console. The item moves under Done.
plan-content Show the next batch of titles. Dry run until --confirm. --keep a,b limits it to those titles. --news: this week’s news instead of the next batch.
commit-titles Add reviewed titles to the calendar from JSON (--file or stdin): the ones plan-content returned with a runId.
remove-title <titleId> Remove a title from the next batch or this week’s news for good. It waits for the workspace owner.
capacity Remaining plan slots on the calendar.
generate <contentId> Write a planned article’s body now. Dry run until --confirm.
write Write several planned articles one after another: --next <n> or --ids a,b; --publish publishes each one once it is written. Dry run until --confirm.
write-runs Recent write runs and each article’s state.
write-stop <runId> Stop a write run. Nothing new starts; an article being written finishes as a draft.
approval <approvalId> Where a change waiting for the workspace owner stands.
publish <contentId> Publish to the connected CMS. Dry run until --confirm.
meta <contentId> Change an article’s title, meta title or meta description (--title, --meta-title, --meta-description). Dry run until --confirm.
reschedule <contentId> <date> Move a planned article to a day (YYYY-MM-DD).
delete-planned <contentId> Remove a planned title from the calendar; its search stays saved for Plan Content.
article-set <contentId> Change a planned article’s length, tone, image style or instructions.
archive <contentId> Archive an article out of the working set.
restore <contentId> Restore an archived article. Dry run until --confirm.
optimizer Published pages ranked by citability, worst first, with open fixes.
internal-links <contentId> Inbound and outbound internal links for an article.
impact <contentId> An article’s questions in AI answers: the 4 weeks before it went live against every answer since.
content-by-url <url> Your published article at this address, with the citability score the dashboard shows for it (null when it isn’t one of yours).

plan-content options: --confirm, --keep a,b, --news for this week’s news, and --subject <text> with --topics a,b for titles about one subject.

rankcontrol plan-content
rankcontrol plan-content --confirm --keep <id>,<id>
rankcontrol plan-content --topics "Travel insurance" --subject "ski trips"
rankcontrol commit-titles --file approved.json
rankcontrol write --next 3 --publish --confirm
rankcontrol publish mx7... --confirm

Article policy

Command What the command does
settings Show the article policy: per-article defaults plus scheduling mode.
settings-set Merge-patch the policy. Only flags you pass change.

settings-set flags: --auto-publish on|off, --auto-generate on|off, --images on|off, --title-in-hero on|off, --section-infographics on|off, --related-reading on|off, --youtube on|off, --emojis on|off, --internal-links <n>, --external-links <n>, --instructions <text>, --flexible-schedule on|off, --image-style <style>, --formats <list> (article formats turned on, comma-separated; replaces the current list), --confirm (needed to turn on news or trending).

Command What the command does
site-pages Pages used for in-article links and Related Reading.
detect-links <url> Scan a sitemap for site pages. --blog-root to crawl a page instead.
add-pages <urls...> Add page URLs for internal linking; dedupes, titles auto-fill.
site-page-linking <pageId> <on|off> Turn linking to a site page on or off. Off keeps the page in your list, but articles published after this don’t link to it.
site-page-remove <pageId> Remove a page from your site pages. Articles published after this don’t link to it, and scans don’t add it back; add-pages adds it again.

Repurposing

Command What the command does
repurpose [contentId] The repurpose queue, or full drafts for one article.
repurpose-generate <contentId> Draft social posts. Dry run.
repurpose-edit <draftId> Edit a draft. --body, --title.
repurpose-channels Connected Buffer and Postiz channels and their ids.
repurpose-push <draftId> Send to Buffer or Postiz. Dry run; --scheduler postiz|buffer (needed when both are connected), --channels id1,id2, --when now|schedule|draft|queue (queue is Buffer only), --date <iso>.
repurpose-mark-posted <draftId> Mark a draft posted when you published it yourself.
Command What the command does
backlinks The backlink table, newest first, with each linking site’s Domain Rating and spam verdict. --status <status>.
backlink-stats Totals plus outreach pipeline counts, with the hidden spam counted apart and the last 12 weekly checks.
outreach-prospects Prospect sites per published article, with Domain Rating (dr, drSource: whether the rating is measured or estimated), found contacts, and each prospect’s next step (nextMove) and stage. --ai-sources: only AI sources, pages AI engines cite for your tracked questions, each with the product or service it offers (needs one in Brand Kit).
outreach-stats Outreach funnel for the last 90 days by how each prospect was found: prospects, sent, replied, placed, with reply and placement rates per send.
outreach-find-contact <backlinkId> Find a contact email for a prospect.
outreach-draft-reply <backlinkId> AI-draft a reply to an inbound response. Nothing sends.
outreach-draft-email <backlinkId> Draft the first email to a prospect. Nothing sends.
outreach-form-fill <prospectId> What to type into a prospect’s contact form when no email was found: name, email, subject and message. The follow-up once it opens. Nothing sends.
outreach-form-sent <prospectId> <pageUrl> Record a message you sent through a prospect’s contact form. The first one moves it to Contacted. Dry run; --confirm.
outreach-queue <backlinkId> Queue an outreach email. Dry run; --subject, --body.
outreach-status <backlinkId> <status> Move a prospect: identified, contacted, replied, link_placed, rejected.
outreach-ai-source-product <backlinkId> <productId> Change the product or service an AI source offers, until its pitch is queued (product ids from brand).
outreach-cancel <backlinkId> Cancel a queued outreach email (first email, reply or follow-up) before it sends.

Social

Command What the command does
social Thread prospects (Reddit/X) with rules context, each thread’s next step (nextMove) and stage. --platform, --status, --stage, --age ranked|new, --ai-sources for only the threads AI engines cite for your tracked questions (needs a product or service in Brand Kit).
social-stats Thread pipeline counts.
social-status <threadId> skipped Skip a thread. The only manual status; Posted is detected automatically.
social-draft-reply <threadId> AI-draft a reply for review. --mention none|natural|founderOpen. Nothing posts.
social-open <threadId> Take the draft to the platform yourself: prints the thread URL (X: a composer link with the reply filled in) and starts the checks that mark it Posted. --text for an edited reply (X: 280 characters or fewer).
social-posted <threadId> <permalink> Record the reply you posted on a thread you opened (social-open) by its link; the thread moves to Posted. --text for the reply as posted. Dry run; --confirm.
social-x-handle <handle|clear> Optional X handle used to recognise your posted replies.
social-reddit-profile Save the Reddit account the Social tab drafts for: --karma, --age, --goal, --story, --tone, optional --username. Replaces the stored profile.

Brand

Command What the command does
topics The pillar list (topic clusters), each with how many tracked questions it holds.
topics-set <topics...> Replace the full pillar list, up to 20 topics.
brand Brand profile, products, buyer profiles and brand guidelines in one read.
brand-set Update identity: --name, --industry, --description, --aliases (other spellings searched as brand mentions, comma-separated), --not-us (same-name brands to skip), or --json for authors and styleReferenceUrls. Arrays replace the stored list.
brand-profile-set Patch voice and style fields, and the Local business switch (localBusiness, serviceArea). --json '{"tone":"..."}' or --json @file.json.
brand-product Create, update, or delete a product. --json (create: name, description, category; update: productId; delete: productId plus "del": true).
brand-icp Same semantics for buyer profiles (create: title, industry, demographics).
icp-suggest Up to 8 audiences for this site from its brand, products, competitors and topics. Saves nothing. --exclude titles already shown.
icp-draft Draft one buyer profile from --describe "<sentence>" or --title/--who from icp-suggest; --json fields are kept as written. Saves nothing; save it with brand-icp.
brand-reviewed Mark the brand as reviewed (Expedition I).
objections The objections AI raises about you, with how many answers raised each and the engines (Buyer Profiles’ suggestions).
objection-add <suggestionId> <profileId> Add one to a buyer profile: first in its objections. --text saves it in your own words.
objection-dismiss <suggestionId> Dismiss one; it isn’t suggested again. Waits for the owner.
guideline-add <type> <avoid> <instead> Add a brand guideline.
guideline-on <id> Turn a brand guideline on.
guideline-off <id> Turn a brand guideline off.
guideline-remove <id> Delete a brand guideline.
facts The facts AI’s answers are checked against, and the contradictions of the last 30 days.
fact-add <type> <text> Add a fact. Types: price, plan, integration, guarantee, other.
fact-edit <id> Edit a fact. --text, --type.
fact-delete <id> Delete a fact (waits for the owner).
rankcontrol brand-profile-set --json '{"tone":"conversational"}'
rankcontrol brand-product --json '{"name":"Acme API","description":"...","category":"product"}'

Team

Command What the command does
team Members and pending invites with per-screen permissions.
team-invite <email> Invite a member. Dry run; --perms content=write,analytics=read.
team-revoke <invitationId> Revoke a pending invite.
team-remove <userId> Remove a member. Requires --confirm.

Integration helpers

Command What the command does
cloudflare-connect Print the Cloudflare OAuth URL to connect read-only crawler analytics.
cloudflare-zones List Cloudflare zones visible to the connected grant.
cloudflare-zone <zoneId> <zoneName> Pick the polled zone (a crawler source already set stays).
framer-install-embed Install site-wide tracking on the Framer project (dry run without –confirm; installing also publishes the Framer site).
webflow-custom-code Install the tracking loader via Webflow’s Custom Code API (dry run without –confirm; live on the customer’s next site publish). A new site token comes from RANKCONTROL_WEBFLOW_TOKEN, or from --token with no value (you type it). --token <value> works but stays in your shell history.

Support

Command What the command does
support <subject> Send a message or bug report to the RankControl team. --message <text> required, --page <url> optional. Capped at 3 per minute.
help-page [page] Read a help page: setup guides for each publishing destination, the crawler and our IP, the API, CLI and MCP, and the plan and pricing; without a page, list the pages.
guides <question> Search the guides on RankControl’s blog about SEO and AI search; prints the sections that best answer the question, each with its guide’s link.
billing Billing as Settings, Billing shows it: status, billing cycle, next charge, add-ons, usage and recent payments (read-only).
Navigation

Type to search…

↑↓ navigate↵ selectEsc close