Getting started

Check a repository from your terminal or CI

deploy-check is a free, open-source command that tells you whether a repository will deploy. You don't need an account. It shows:

Services: what it found, and how each one builds, starts and listens.
Blockers: anything that would stop a deploy, each with the fix.
Environment variables: the ones you'll need to supply.
Secrets: anything committed to the repository, and secret keys compiled into browser code.
Cost: what it would cost a month in your own DigitalOcean, AWS, Google Cloud or Azure account.

npx thedeploy-check                       # the git repository you're in
npx thedeploy-check github.com/you/app    # a public repository

It needs Node.js 18 or newer. To check a local folder, you also need git.

For a public repository: only the address is sent, and the result gets a shareable page.

For a local folder: it sends a git archive of your latest commit.

What's included: committed files only. Uncommitted changes, ignored files and your git history are never sent.
Who can see the result: only the run that sent it. There's no public page, badge or share card.
How long it's kept: the upload is deleted when the check finishes, and the report after seven days.

It shows secrets by kind and location, never their values, so they stay out of CI logs.

Option	What it does
`--json`	Prints the whole result as JSON
`--summary <file>`	Adds a Markdown summary to a file, such as a GitHub Actions job summary
`--fail-on <when>`	Exits with an error when the verdict is `needs-work` or `almost`, or when `secrets` are found

- uses: actions/checkout@v4
- uses: Avinash147-1193/deploy-check@v0
  with:
    fail-on: secrets

The result appears in the job summary. When the repository is ready, create a project in The Deployer to deploy it into your own cloud account.