@waiyat/devops v2.0 — Full enterprise DevOps automation platform now available.Install now
CLI Reference & Options

Complete CLI Command Suite

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

Running with npx:

Always append @latest when invoking via npx (e.g. npx @waiyat/devops@latest sbom) to ensure npx executes the newest v2.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
--jsonbooleanOutput raw machine-readable JSON (ideal for CI pipelines, PR bots, and dashboards).
--verbose, -vbooleanPrint full details including passed checks and actionable suggestions.
--fixbooleanAutomatically apply safe fixes during diagnostics check.
--prbooleanCI 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-runbooleanPreview changes and diff without modifying any files on disk.
--template, -tstringForce a specific workflow template: 'nextjs' | 'node' | 'docker' | 'python' | 'go' | 'rust' | 'full'.

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, -vbooleanDisplay verbose diagnostic probe outputs.

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, -tstringForce template (nextjs | node | docker | python | go | rust | full).
--output, -ostring.github/workflows/ci.ymlTarget file path for generated workflow.

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, -vbooleanPrint 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 workflow least-privilege permission checks.

Options & Flags

Option FlagTypeDefaultDescription
--jsonbooleanOutput JSON vulnerability report.

Example Usage

devops security
npx @waiyat/devops@latest security

devops secrets

security

Discover environment variables and API tokens used across source code and generate required GitHub Secrets manifest.

Options & Flags

Option FlagTypeDefaultDescription
--output, -ostringOutput format or destination file.

Example Usage

devops secrets
npx @waiyat/devops@latest secrets

devops audit

security

Live dependency vulnerability and CVE inspection against global vulnerability advisories.

Options & Flags

Option FlagTypeDefaultDescription
--strictbooleanFail with non-zero exit code on any Moderate, High, or Critical finding.

Example Usage

devops audit
npx @waiyat/devops@latest audit

devops docker

containers

Audit Dockerfiles for non-root users, multi-stage build caching, healthcheck probes, and .dockerignore parity.

Options & Flags

Option FlagTypeDefaultDescription
--fixbooleanAutomatically apply non-root user and .dockerignore remediations.

Example Usage

devops docker
npx @waiyat/devops@latest docker check

devops env

core

Validate environment variable parity between active `.env` files and public `.env.example` templates.

Options & Flags

Option FlagTypeDefaultDescription
--fixbooleanGenerate missing .env.example with sanitized placeholder keys.

Example Usage

devops env
npx @waiyat/devops@latest env --fix

devops sbom

governance

Generate real Software Bill of Materials (SBOM) in CycloneDX v1.5 JSON standard with package purl identifiers.

Options & Flags

Option FlagTypeDefaultDescription
--output, -ostringFile destination (default prints JSON to stdout).

Example Usage

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

devops policy

governance

Evaluate repository against enterprise compliance rules (POL001: lockfiles, POL003: non-root, POL005: score >= 80).

Options & Flags

Option FlagTypeDefaultDescription
--jsonbooleanOutput machine-readable compliance report.

Example Usage

devops policy
npx @waiyat/devops@latest policy check

devops diff

workflows

Detect configuration drift between local repository workflows and central upstream reusable recipes.

Options & Flags

Option FlagTypeDefaultDescription
--verbosebooleanPrint side-by-side YAML diff.

Example Usage

devops diff
npx @waiyat/devops@latest diff

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
--forcebooleanOverwrite 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-runbooleanPreview 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-runbooleanPreview version bump without committing.

Example Usage

devops release
npx @waiyat/devops@latest release