CLI Reference & Options

Complete CLI Command Suite

All 17 official commands, options, and syntax examples provided by `@waiyat/devops` v3.0.0.

Running with npx:

Always append @latest when invoking via npx (e.g. npx @waiyat/devops@latest sbom) to ensure npx executes the newest v3.0+ CLI binary rather than a cached local version.

devops check

core

Run real-time preflight diagnostics across 6 categories and calculate a weighted 0-100 repository health score.

Options & Flags

Option FlagTypeDefaultDescription
--jsonboolean—Output raw machine-readable JSON (ideal for CI pipelines, PR bots, and dashboards).
--verbose, -vboolean—Print full details including passed checks and actionable suggestions.
--fixboolean—Automatically apply safe fixes during diagnostics check.
--prboolean—CI Pull Request mode (formats GitHub markdown table summary).

Example Usage

devops check
npx @waiyat/devops@latest check --verbose

devops fix

core

Auto-repair repository misconfigurations: creates missing CI workflows, adds .dockerignore, updates .gitignore with .env protections, and injects non-root Docker USER.

Options & Flags

Option FlagTypeDefaultDescription
--dry-runboolean—Preview changes and diff without modifying any files on disk.
--template, -tstring—Force a specific workflow template: 'nextjs' | 'node' | 'docker' | 'python' | 'go' | 'rust' | 'full'.
--issuestring—Limit auto-repair to one category: 'quality' | 'ci' | 'security' | 'docker' | 'environment' | 'observability'.

Example Usage

devops fix
npx @waiyat/devops@latest fix

devops doctor

core

Interactive diagnostic inspection with guided step-by-step auto-remediation for developers.

Options & Flags

Option FlagTypeDefaultDescription
--verbose, -vboolean—Display verbose diagnostic probe outputs.
--yesboolean—Non-interactive doctor run that applies all safe fixes without prompting.

Example Usage

devops doctor
npx @waiyat/devops@latest doctor

devops init

workflows

Intelligently detect project stack and scaffold tailor-made, production-ready CI/CD pipelines.

Options & Flags

Option FlagTypeDefaultDescription
--template, -tstring—Force template (nextjs | node | docker | python | go | rust | full | pro).
--output, -ostring.github/workflows/ci.ymlTarget file path for generated workflow.
--template prostring—Scaffold the S4 professional (enterprise) pipeline.
--forceboolean—Overwrite an existing workflow file during scaffolding.

Example Usage

devops init
npx @waiyat/devops@latest init --template nextjs

devops validate

workflows

Validate local GitHub Actions workflow syntax, trigger events, and YAML integrity before pushing to remote.

Options & Flags

Option FlagTypeDefaultDescription
--verbose, -vboolean—Print full workflow validation tree.

Example Usage

devops validate
npx @waiyat/devops@latest validate

devops security

security

Perform deep-dive DevSecOps audit, secret leak detection, and permission checks.

Example Usage

devops security
npx @waiyat/devops@latest security

devops audit

security

Fail-on-vulnerabilities dependency audit across package ecosystems (npm, pnpm, yarn, bun).

Example Usage

devops audit
npx @waiyat/devops@latest audit

devops secrets

security

Scan the repository for committed secrets and credential leaks.

Example Usage

devops secrets
npx @waiyat/devops@latest secrets

devops policy

governance

Evaluate repository policy compliance (branch protection, licensing, hygiene).

Example Usage

devops policy
npx @waiyat/devops@latest policy

devops docker check

containers

Audit Dockerfiles for non-root users, multi-stage builds, and healthchecks.

Example Usage

devops docker check
npx @waiyat/devops@latest docker check

devops docker init

containers

Scaffold a hardened, production-grade Dockerfile.

Example Usage

devops docker init
npx @waiyat/devops@latest docker init

devops sbom

governance

Generate a CycloneDX v1.5 software bill of materials for the project.

Options & Flags

Option FlagTypeDefaultDescription
--jsonboolean—Output raw JSON for programmatic consumption.

Example Usage

devops sbom
npx @waiyat/devops@latest sbom --json

devops env

core

Validate environment variable parity between `.env` and `.env.example`.

Example Usage

devops env
npx @waiyat/devops@latest env

devops list

workflows

Browse modular, reusable enterprise workflow recipes available in @waiyat/devops.

Example Usage

devops list
npx @waiyat/devops@latest list

devops add

workflows

Scaffold a specific modular recipe into your project (e.g. `security/dependency-scan`, `docker/build-push`).

Options & Flags

Option FlagTypeDefaultDescription
--forceboolean—Overwrite existing workflow without prompt.

Example Usage

devops add
npx @waiyat/devops@latest add security/dependency-scan

devops clean

maintenance

Clean local build outputs (.next, dist, coverage), stale dependency caches, and reclaim disk space.

Options & Flags

Option FlagTypeDefaultDescription
--dry-runboolean—Preview files to be deleted without deleting.

Example Usage

devops clean
npx @waiyat/devops@latest clean

devops release

governance

Automate semantic versioning bumps, conventional changelog generation, and git release tags.

Options & Flags

Option FlagTypeDefaultDescription
--dry-runboolean—Preview version bump without committing.

Example Usage

devops release
npx @waiyat/devops@latest release