Command Line Reference

Reference

check

Run local environment checks. Checks cover container engines, API key environment variables, git worktree state, and (unless suppressed) the latest GitHub release version. The command passes when at least one container engine (docker or podman) works; missing API keys are warnings, while a key that is set but malformed is an error.

Optional

Emit canonical JSON.

Produce no output; the result is communicated by the exit code only.

Skip the GitHub release version check.

Usage

# Usage
overplane check [--json] [--quiet] [--no-check-upgrades]

# Examples
# Render a terminal table of local check results.
$ overplane check
# Emit machine-readable check results.
$ overplane check --json
# Run checks without contacting GitHub.
$ overplane check --no-check-upgrades