Getting Started

Installation

DeployReady runs anywhere Node.js does. The fastest way to get started is with npx — no install required.

Requirements

  • Node.js 18 or later
  • macOS, Linux, or Windows (including WSL)
  • A JavaScript, TypeScript, or Python project to scan

Run with npx (recommended)

You don't need to install anything. Point DeployReady at any project directory and it will guide you through an interactive session.

terminal
npx deployready@latest ./my-app

Always up to date

Using @latest ensures you always run the newest release with the most recent security checks.

Install globally

If you run DeployReady often, install it globally so the deployready command is always available.

terminal
# npm
npm install -g deployready

# pnpm
pnpm add -g deployready

# yarn
yarn global add deployready

Then run it from any project:

terminal
deployready ./my-app

Add to a project

You can also add DeployReady as a dev dependency and wire it into your scripts.

terminal
npm install --save-dev deployready
package.json
{
  "scripts": {
    "scan": "deployready analyze ."
  }
}

Verify the installation

Confirm DeployReady is available and check the version.

terminal
deployready --version

Next step

Head to the Quick Start guide to run your first scan, read findings, and apply fixes.
NextQuick Start