integrallis/RankCLI SEO Audit
Ship code, get ranked. Run the RankCLI SEO/GEO audit on a URL in CI and fail the build on SEO regressions.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| url | URL to audit (e.g. https://example.com or a preview deployment URL) | yes | — |
| api-key | RankCLI API key (optional). Identifies your account; the audit itself runs in this runner. Falls back to the RANKCLI_API_KEY env var. | no | — |
| github-token | Token for the PR comment (defaults to GITHUB_TOKEN; needs pull-requests: write) | no | ${{ github.token }} |
| comment-on-pr | Post the audit results as a PR comment on pull_request runs (true/false). A comment that cannot be posted is a warning, never a failure. | no | true |
| fail-on-error | Fail the step if the audit finds any error-severity issue (true/false) | no | false |
| fail-on-errors | Alias of fail-on-error (the spelling used in the RankCLI docs) | no | false |
| score-threshold | Minimum overall score (0-100) to pass. 0 disables the check. | no | 0 |
| slack-webhook | Slack incoming-webhook URL for alerts | no | — |
| discord-webhook | Discord webhook URL for alerts | no | — |
| alert-on | When to alert, comma-separated: error (any error-severity issue), failure (the step failed) | no | error |
| create-pr | Removed. | no | — |
| pr-threshold-errors | Removed. | no | — |
| pr-threshold-score | Removed. | no | — |
| pr-base-branch | Removed. | no | — |
| checks | Removed. | no | — |
Outputs
| name | description |
|---|---|
| score | Overall SEO score (0-100) |
| passed | Whether the audit passed the configured gate (true/false) |
| issues-count | Total number of issues found |
| errors-count | Number of error-severity issues |
| warnings-count | Number of warnings |
| report-json | Full audit report as JSON |
| rate-limit-remaining | Remaining RankCLI API requests today (when api-key is set) |
| rate-limit-resets-at | When the RankCLI API limit resets (ISO timestamp, when api-key is set) |