semrush cli
Commands

Site Audit

Commands and options for site audit.

audit-campaigns

Existing Site Audit campaigns; does not start a crawl.

semrush audit-campaigns --help

MCP tool: audit_campaigns.

audit-limits

Site Audit account crawl and project limits.

semrush audit-limits --help

MCP tool: audit_limits.

audit-info

Current Site Audit configuration, status and latest summary.

semrush audit-info --help

MCP tool: audit_info.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.

audit-js-impact-guide

JavaScript rendering impact summary and changed-page examples by parameter.

semrush audit-js-impact-guide --help

MCP tool: audit_js_impact_guide.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.

audit-js-impact-changed-pages

Number of Site Audit pages changed by JavaScript rendering.

semrush audit-js-impact-changed-pages --help

MCP tool: audit_js_impact_changed_pages.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.

audit-js-impact-pages

Paginated Site Audit before/after JavaScript rendering values and filters.

semrush audit-js-impact-pages --help

MCP tool: audit_js_impact_pages.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.
--statusstring"all"Compare pages before and after JavaScript rendering. Values: "all", "changed", "unchanged".
--querystring""URL search text.
--parametersarray[]Changed parameter keys. Requires status changed.
--sortstring"desc"Values: "asc", "desc".
--pageinteger0Zero-based page number.
--limitinteger10

audit-export-js-impact

Download all matching JavaScript impact rows as native CSV or XLSX.

semrush audit-export-js-impact --help

MCP tool: audit_export_js_impact.

Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.
--statusstring"all"Compare pages before and after JavaScript rendering. Values: "all", "changed", "unchanged".
--querystring""URL search text.
--parametersarray[]Changed parameter keys. Requires status changed.
--sortstring"desc"Values: "asc", "desc".
--formatstring"csv"Values: "csv", "xlsx".

audit-status

Current Site Audit execution status.

semrush audit-status --help

MCP tool: audit_status.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.

audit-snapshots

Historical Site Audit crawl snapshots.

semrush audit-snapshots --help

MCP tool: audit_snapshots.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.

audit-snapshot

Read a specific Site Audit snapshot.

semrush audit-snapshot --help

MCP tool: audit_snapshot.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.
--snapshot-idstringRequired. Opaque snapshot ID returned by audit-start or audit-snapshots.

audit-start

Start a configured Site Audit. Consumes crawl allowance and uses its saved notification settings.

semrush audit-start --help

MCP tool: audit_start.

Use --confirm to send the change or --dry-run to preview it.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.
--confirmbooleanfalseConfirm this account mutation.
--dry-runbooleanfalsePrint the request without sending it.

audit-configure

Replace Site Audit settings without starting a crawl. Defaults to manual scheduling and no email. Supports HTTP Basic and Web Bot Auth credentials with explicit retention or disabling. Google Analytics connections require the web UI.

semrush audit-configure --help

MCP tool: audit_configure.

Use --confirm to send the change or --dry-run to preview it.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.
--domainstringRequired. Domain or subdomain, without protocol or path.
--page-limitintegerRequired. Maximum pages to crawl. Your plan limit still applies.
--schedule-dayinteger00 manual, 1-7 Monday-Sunday, 8 daily. Values: 0, 1, 2, 3, 4, 5, 6, 7, 8.
--notifybooleanfalse
--user-agent-typeinteger8Values: 0, 1, 2, 3, 7, 8, 9.
--crawl-subdomainsbooleanfalse
--crawl-source-typeinteger00 website, 1 robots sitemap, 2 custom sitemap URL, 3 uploaded URL list. Values: 0, 1, 2, 3.
--crawl-source-urlstring""Custom sitemap URL for source type 2. Leave empty for an uploaded URL list; uploads belong to the campaign.
--crawl-delayinteger1Values: 1, 2, 3.
--ignore-robots-disallowbooleanfalse
--js-renderingstring"DISABLED"Values: "DISABLED", "RENDER_ALL".
--schemestring"https"Values: "http", "https".
--allowarray[]
--disallowarray[]
--removed-parametersarray[]
--excluded-checksarray[]
--confirmbooleanfalseConfirm this account mutation.
--dry-runbooleanfalsePrint the request without sending it.
--auth-enabledbooleanEnable HTTP basic authentication. Explicitly choose true to retain existing credentials or false to disable it on a protected audit.
--auth-usernamestringHTTP basic-auth username. Supply both credential fields when changing them.
--auth-password-filefile or stdinHTTP basic-auth password. CLI reads --auth-password-file PATH, or - for stdin; never a command argument value.
--web-bot-auth-enabledbooleanEnable Web Bot Auth. Choose true to retain existing credentials, or false to explicitly disable it on an authenticated audit.
--web-bot-auth-filefile or stdinComplete native Signature-Agent, Signature-Input and Signature header values. CLI reads --web-bot-auth-file PATH or - for stdin. Supply all fields together when creating or replacing credentials.

audit-create

Create Site Audit settings on an SEO project without starting a crawl. Refuses to replace an existing audit. Defaults to manual scheduling and no email.

semrush audit-create --help

MCP tool: audit_create.

Use --confirm to send the change or --dry-run to preview it.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.
--domainstringRequired. Domain or subdomain, without protocol or path.
--page-limitintegerRequired. Maximum pages to crawl. Your plan limit still applies.
--schedule-dayinteger00 manual, 1-7 Monday-Sunday, 8 daily. Values: 0, 1, 2, 3, 4, 5, 6, 7, 8.
--notifybooleanfalse
--user-agent-typeinteger8Values: 0, 1, 2, 3, 7, 8, 9.
--crawl-subdomainsbooleanfalse
--crawl-source-typeinteger00 website, 1 robots sitemap, 2 custom sitemap URL, 3 uploaded URL list. Values: 0, 1, 2, 3.
--crawl-source-urlstring""Custom sitemap URL for source type 2. Leave empty for an uploaded URL list; uploads belong to the campaign.
--crawl-delayinteger1Values: 1, 2, 3.
--ignore-robots-disallowbooleanfalse
--js-renderingstring"DISABLED"Values: "DISABLED", "RENDER_ALL".
--schemestring"https"Values: "http", "https".
--allowarray[]
--disallowarray[]
--removed-parametersarray[]
--excluded-checksarray[]
--confirmbooleanfalseConfirm this account mutation.
--dry-runbooleanfalsePrint the request without sending it.
--auth-enabledbooleanEnable HTTP basic authentication. Explicitly choose true to retain existing credentials or false to disable it on a protected audit.
--auth-usernamestringHTTP basic-auth username. Supply both credential fields when changing them.
--auth-password-filefile or stdinHTTP basic-auth password. CLI reads --auth-password-file PATH, or - for stdin; never a command argument value.
--web-bot-auth-enabledbooleanEnable Web Bot Auth. Choose true to retain existing credentials, or false to explicitly disable it on an authenticated audit.
--web-bot-auth-filefile or stdinComplete native Signature-Agent, Signature-Input and Signature header values. CLI reads --web-bot-auth-file PATH or - for stdin. Supply all fields together when creating or replacing credentials.

audit-pages

Read the current crawled-page table. Pagination is zero-based.

semrush audit-pages --help

MCP tool: audit_pages.

OptionTypeDefaultDescription
--campaign-idintegerRequired.
--pageinteger0
--limitinteger20
--sortstring"url_asc"
--filterstring
--filter-typestringValues: "url", "title", "meta_description".

audit-page

Read one crawled page and its issue details.

semrush audit-page --help

MCP tool: audit_page.

OptionTypeDefaultDescription
--campaign-idintegerRequired.
--page-idstringRequired.

audit-issue

Read affected-page rows for one issue in a snapshot. Requests use one-based pages.

semrush audit-issue --help

MCP tool: audit_issue.

OptionTypeDefaultDescription
--campaign-idintegerRequired.
--snapshot-idstringRequired.
--issue-idintegerRequired.
--pageinteger1
--limitinteger10
--sortstring"index_asc"
--visiblebooleantrue
--filterstring
--searchstring

audit-structure

Read crawl directory structure and page/issue counts.

semrush audit-structure --help

MCP tool: audit_structure.

OptionTypeDefaultDescription
--campaign-idintegerRequired.

audit-performance

Read crawl performance distributions and load-time history.

semrush audit-performance --help

MCP tool: audit_performance.

OptionTypeDefaultDescription
--campaign-idintegerRequired.

audit-linking

Read internal link distribution, depth and linking issues.

semrush audit-linking --help

MCP tool: audit_linking.

OptionTypeDefaultDescription
--campaign-idintegerRequired.

audit-history

Read paginated completed-crawl progress metrics.

semrush audit-history --help

MCP tool: audit_history.

OptionTypeDefaultDescription
--campaign-idintegerRequired.
--limitinteger7
--offsetinteger0

audit-recrawl

Recrawl one page explicitly. Consumes crawl allowance.

semrush audit-recrawl --help

MCP tool: audit_recrawl.

Use --confirm to send the change or --dry-run to preview it.

OptionTypeDefaultDescription
--campaign-idintegerRequired.
--page-idstringRequired.
--confirmbooleanfalse
--dry-runbooleanfalse

audit-abort

Abort an active crawl and discard its in-progress results.

semrush audit-abort --help

MCP tool: audit_abort.

Use --confirm to send the change or --dry-run to preview it.

OptionTypeDefaultDescription
--campaign-idintegerRequired.
--confirmbooleanfalse
--dry-runbooleanfalse

audit-finalize

Stop an active crawl and keep results already collected.

semrush audit-finalize --help

MCP tool: audit_finalize.

Use --confirm to send the change or --dry-run to preview it.

OptionTypeDefaultDescription
--campaign-idintegerRequired.
--confirmbooleanfalse
--dry-runbooleanfalse

audit-execution

Read current crawl phases, progress and whether stopping is allowed.

semrush audit-execution --help

MCP tool: audit_execution.

OptionTypeDefaultDescription
--campaign-idsarrayRequired.

audit-export-pages

Download crawled-page data as CSV or XLSX.

semrush audit-export-pages --help

MCP tool: audit_export_pages.

Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.

OptionTypeDefaultDescription
--snapshot-idstringRequired.
--formatstring"csv"Values: "csv", "xlsx".
--relativebooleanfalse
--sortstring"url_asc"
--filterstring""

audit-export-page-issues

Download the latest campaign crawl as a page-by-issue matrix in CSV or XLSX.

semrush audit-export-page-issues --help

MCP tool: audit_export_page_issues.

Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.
--formatstring"csv"Values: "csv", "xlsx".
--relativebooleanfalse
--sortstring"url_asc"
--filterstring""

audit-export-markup

Download crawled-page markup and structured-data columns as CSV or XLSX.

semrush audit-export-markup --help

MCP tool: audit_export_markup.

Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.

OptionTypeDefaultDescription
--snapshot-idstringRequired.
--formatstring"csv"Values: "csv", "xlsx".
--relativebooleanfalse
--sortstring"url_asc"
--filterstring""

audit-export-issues

Download the snapshot issue summary as CSV or XLSX.

semrush audit-export-issues --help

MCP tool: audit_export_issues.

Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.

OptionTypeDefaultDescription
--snapshot-idstringRequired.
--formatstring"csv"Values: "csv", "xlsx".

audit-export-compare

Download a native CSV or XLSX comparison of two different Site Audit crawls.

semrush audit-export-compare --help

MCP tool: audit_export_compare.

Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.

OptionTypeDefaultDescription
--first-snapshot-idstringRequired. First comparison snapshot, normally the previous crawl.
--second-snapshot-idstringRequired. Second comparison snapshot, normally the latest crawl. Native output columns appear before the first snapshot.
--formatstring"csv"Values: "csv", "xlsx".

audit-export-issue

Download affected-page rows for one issue as CSV or XLSX.

semrush audit-export-issue --help

MCP tool: audit_export_issue.

Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.

OptionTypeDefaultDescription
--snapshot-idstringRequired.
--formatstring"csv"Values: "csv", "xlsx".
--issue-idintegerRequired.
--sortstring"index_asc"

audit-urls-upload

Upload a text or CSV crawl URL list to an SEO project. Returns a filename and count; does not configure or start an audit.

semrush audit-urls-upload --help

MCP tool: audit_urls_upload.

Use --confirm to send the change or --dry-run to preview it.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.
--contents-filefile or stdinRequired. Text or CSV URL list, one absolute or relative URL per line. CLI reads --contents-file PATH, or - for stdin.
--filenamestring"semrush-crawl-urls.txt"Upload filename, ending in .txt or .csv.
--confirmbooleanfalseConfirm this account mutation.
--dry-runbooleanfalsePrint the request without sending it.

audit-export-all

Download available Site Audit reports as a CLI-created ZIP with untouched native CSV/XLSX files and an availability manifest.

semrush audit-export-all --help

MCP tool: audit_export_all.

Pass --output <path> to save the file. Existing files are not overwritten. MCP returns an artifact resource.

OptionTypeDefaultDescription
--campaign-idintegerRequired. SEO project/campaign ID from project-enable-seo, not the folder ID.
--formatstring"csv"Values: "csv", "xlsx".
--relativebooleanfalse
--sortstring"url_asc"
--filterstring""

On this page