The Tool Desk
Outbyte PC Repair FREEClear out junk files and repair common Windows errorsFree Scan →Outbyte Driver Updater FREEFix the driver behind crashes, sound loss and screen glitchesFind Drivers →There are two ways to show Cypress-related status in a GitHub README: add a Cypress Cloud project badge for test status or counts, or add a GitHub Actions badge for the workflow that runs Cypress. Choose based on what you want the badge to report; neither badge runs tests by itself.
Choose the badge that matches what you want to show
| Badge | What it reports | Branch or event selection | Availability |
|---|---|---|---|
| Cypress Cloud README badge | Simple pass/fail status, detailed passed/failed/skipped counts, or the project’s test count | Choose a branch, or leave it unset to use the latest build in the project | Cypress currently limits these badges to public projects |
| GitHub Actions workflow badge | Status of the selected GitHub Actions workflow | Defaults to the default branch; can be filtered by branch or event | Badges in private repositories are not externally accessible |
Cypress describes its README badges as a way to surface a project’s test status and test count to people viewing its README. They are distinct from Cypress Cloud’s GitHub integration status checks, which appear on commits and pull requests and can be used to help prevent merges until tests pass. A README badge is not itself a merge gate.
As an Amazon Associate I earn from qualifying purchases.
Add a Cypress Cloud project badge
Use this option when you want the README to show status or test counts from a project in Cypress Cloud. The project must have builds with results for the selected badge to display useful information.
- In Cypress Cloud, select your organization and project.
- Open the project’s Settings and find README Badges, then select Configure Badge.
- Confirm the prefilled project ID. Select the branch whose results should appear, or leave the branch unset to use the latest build in the project.
- Choose a badge style. Cypress documents five styles; Flat is the default and most commonly used.
- Select the badge type: Simple status for passing or failing, Detailed status for passed, failed, and skipped test counts, or Test count for the number of tests in the project.
- Review the preview, copy the generated Markdown, and paste it where you want the badge in your project’s
README.md.
If the README is in a private project, this native badge path is not currently available. Use a GitHub Actions badge instead if you need to show the workflow status, keeping in mind that private-repository badges are not externally accessible to readers outside the repository.
Add a GitHub Actions badge for the Cypress workflow
Choose this route when the badge should reflect the GitHub Actions workflow that runs Cypress. First make sure the repository has a workflow configured to run the tests; the badge displays workflow status, but does not create or start the workflow.
- Open the repository’s Actions tab.
- Select the workflow that runs Cypress.
- Choose Create status badge. Optionally select a branch and event.
- Copy the Markdown GitHub provides and paste it into the README.
You can also construct the Markdown directly, replacing the owner, repository, and workflow filename with your repository’s values:
To restrict the badge to a branch or event, add a query parameter to the image URL:
Without a branch filter, GitHub uses the default branch. If there are no runs on that branch, GitHub shows the most recent run across branches. Use the Markdown from the Actions tab if you want GitHub to generate the URL for your selected workflow and filters.
If you have not created the Cypress workflow
Cypress documents its official cypress-io/github-action for setting up a workflow to run tests. See the Cypress GitHub Action documentation for setup guidance. A workflow badge only becomes informative after the workflow has run and has a status to display.
Do not confuse README badges with commit checks
A README badge is a visible image for people browsing the repository. Cypress Cloud’s GitHub integration status checks are a separate commit- and pull-request-level feature. To use that integration, the project must be set up to record runs to Cypress Cloud, and the person enabling the integration must be a GitHub admin. Cypress describes GitHub Enterprise integration as included in Business and Enterprise plans; check Cypress’s current plan details before relying on that availability.
Rank #4
Or skip the browser setup
For website screenshots rather than CI status badges, ScreenshotNeo offers a one-request screenshot API. Its clean-capture steps accept cookie/consent banners and remove more than 60 known consent platforms, newsletter popups, and chat widgets; each step can be disabled. Bot checks or CAPTCHAs, blank pages, timeouts, failed loads, and cache hits cost nothing, and responses include X-Page-Verdict and X-Billed headers. It also provides an MCP server with take_screenshot, get_page_info, and capture_pdf tools for AI agents.
Example cURL request (replace the URL with the page you want to capture):
curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://stripe.com -o shot.webpSee the ScreenshotNeo API documentation for request options. ScreenshotNeo is made by Yorker Media. The Free plan includes 1,000 shots per month with no card; paid plans start at $5 for 3,000 shots. Learn about ScreenshotNeo or sign up for 1,000 free screenshots a month, no card required.
Quick Recap
Best Value
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
