Install from npm

The CLI is published on the public npm registry as @orangecloud/cf-ready (latest 0.2.1).

Quick install

npx @orangecloud/cf-ready scan
npm install -g @orangecloud/cf-ready
cf-ready scan
npm install -D @orangecloud/cf-ready
npx cf-ready scan

Requirements

Maintainers — publish to npmjs.org

  1. Create an npm organization @orangecloud (or use an existing scoped org).
  2. Generate an npm Automation or Publish token at npmjs.com → Access Tokens.
  3. Add repository secret NPM_TOKEN in GitHub → Settings → Secrets → Actions.
  4. Bump version in package.json and merge to main.
  5. Publish via GitHub Release (Publish to npm workflow) or push a tag v0.2.1 matching package.json.

Manual dry run: Actions → Publish to npm → Run workflow → dry_run = true.