Skip to content

Help people run your project

Add a Run on Setup button so visitors can review your recipe and start it.

Add Setup to your README

Check the badge’s project slug in the snippet.

Example preview
setup: verified v1.4.2 (verified by Setup)Run on Setup
[![Runs on Setup](https://usesetup.app/api/badge/uptime-kuma)](https://usesetup.app/run?source=https%3A%2F%2Fgithub.com%2Flouislam%2Fuptime-kuma)
[![Run on Setup](https://usesetup.app/api/badge/uptime-kuma/button)](https://usesetup.app/run?source=https%3A%2F%2Fgithub.com%2Flouislam%2Fuptime-kuma)

Keep the recipe in your repo

Save setup.json in the repository root so Setup uses your recipe.

setup.json
Download from your project page
setup-runner validate
Validate offline
setup-runner verify
Test in a temporary Docker sandboxTest sandbox removed afterwards

Who checked the recipe?

Badges reflect the last 30 days; runs on your own runners never change them.

setup: verified v1.4.2 (verified by Setup)
Green: passed on Setup’s runners
setup: ci passed v1.4.2 (reported by the project's CI, not verified by Setup)
Blue: project CI reported successCI report, not Setup verification
setup: unverified
No recent pass

Release checks

The GitHub Action and public runner releases are not published yet.

  • Recipe checks on pull requests
  • Release reports with maintainer tokens
  • Tokens report one project only
  • Shown once, revocable anytime
  • GitHub App: planned