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
- Node.js 18 or newer
- Run from your project root (or pass
--cwd)
Maintainers — publish to npmjs.org
- Create an npm organization
@orangecloud(or use an existing scoped org). - Generate an npm Automation or Publish token at npmjs.com → Access Tokens.
-
Add repository secret
NPM_TOKENin GitHub → Settings → Secrets → Actions. - Bump
versioninpackage.jsonand merge tomain. -
Publish via GitHub Release (Publish to npm workflow) or push a tag
v0.2.1matchingpackage.json.
Manual dry run: Actions → Publish to npm → Run workflow → dry_run = true.