Skip to main content
Version: 0.1 · v0.1.0

CLI

The Mirops CLI reads an analysis report and turns it into a CI/CD gate. It has one command — mirops scan — that fetches a report, renders the full analysis as tables, and optionally fails the pipeline when the upgrade isn't safe.

mirops scan --source ./report.mirops --enforce
# exits non-zero when decision.allow == false (CRITICAL)

What it shows​

scan prints the complete report as headed tables — the verdict, score breakdown, add-on compatibility, namespace risk, workloads (deployments, standalone pods, PVCs, PDBs, deprecated APIs), and a closing verdict block. Each section explains why it matters for an upgrade. Color is used on a real terminal (disabled when piped or with NO_COLOR).

Sources​

--source accepts local and remote reports:

SchemeExample
Local file./report.mirops
HTTPhttp://<reports-service>:8084/reports/to-1-34.mirops
S3s3://bucket/clusters/prod.mirops
Azure Blobazure://account/container/prod.mirops

Cloud credentials resolve automatically (IRSA / Workload Identity / env vars / az login).

Gating​

FlagEffect
(none)Reports only — always exits 0.
--enforceFails (exit 1) when the verdict is blocked (CRITICAL).
--enforce --enforce-level warningStricter — also fails on WARNING.

Every flag has an environment-variable equivalent (MIROPS_SOURCE, MIROPS_ENFORCE, …). See the CLI reference for the full list.

Install​

Download the release binary for your platform, make it executable, and put it on your PATH. No sudo required — the same steps work on a laptop or in a CI pipeline.

# 1. Download the binary for your platform (see the table below for the name)
curl -fsSL -O https://github.com/miropshq/mirops-cli/releases/latest/download/mirops-darwin-arm64

# 2. Install it on a user-writable dir on your PATH
mkdir -p "$HOME/.local/bin"
cp mirops-darwin-arm64 "$HOME/.local/bin/mirops"
chmod +x "$HOME/.local/bin/mirops"

# 3. Ensure the dir is on your PATH (add to your shell rc to persist)
export PATH="$HOME/.local/bin:$PATH"

# 4. Verify
mirops --version

Platform binaries​

PlatformBinary
macOS (Apple Silicon)mirops-darwin-arm64
macOS (Intel)mirops-darwin-amd64
Linux (x86_64)mirops-linux-amd64
Linux (arm64)mirops-linux-arm64
Windows (x86_64)mirops-windows-amd64.exe

Swap the binary name in the curl URL for your platform.

Latest vs. pinned version​

# Always the newest release
curl -fsSL -O https://github.com/miropshq/mirops-cli/releases/latest/download/mirops-linux-amd64

# Pin a version (reproducible — recommended for CI)
curl -fsSL -O https://github.com/miropshq/mirops-cli/releases/download/v0.1.0/mirops-linux-amd64

Verify the checksum (optional)​

curl -fsSL -O https://github.com/miropshq/mirops-cli/releases/latest/download/checksums.txt
shasum -a 256 --check --ignore-missing checksums.txt # macOS
sha256sum --check --ignore-missing checksums.txt # Linux

See CI enforcement for a pipeline example.