One universal shipmoor binary serves every tier; a local license unlocks the paid commands. This page is the full surface. Narrative guides live in Community CLI and Claim Check.
Commands
| Command | What it does | Tier |
|---|---|---|
scan [path] | Structural scan → human / shipmoor.scan.v1 JSON / SARIF | Community |
scan --changed / --staged / --diff <range> / --patch <file> | Scope the scan to git changes or an unapplied patch | Community |
scan --intent / --prompt / --session | The claim check — did the change do what the task asked? | IC (intent_scan) |
scan --intent … --agent "<cmd>" | Escalate the long tail to BYO-Judge (your own agent) | IC (agent_harness) |
rules [--json] | List the rule catalog | Community |
explain <rule-or-finding-id> [--from <report>] | Explain a rule or a specific finding | Community |
resolve-intent | Resolve an intent (no scan, no probes) — same resolver as scan | IC (intent_scan) |
repair-guidance --from <report> [--json] | Repair guidance for findings in a report | IC (repair_guidance) |
skills {list,install,uninstall,status} | Install Agent Skills into your agent | IC (agent_skills) |
login / logout / whoami [--json] | Device-flow license auth and identity | — |
capabilities --json | This machine’s entitlement contract (shipmoor.capabilities.v1) | — |
upgrade [--non-interactive] | Self-update the binary (channel-aware) | — |
init | Generate a starter .shipmoor.yaml | Community |
version | Version + identity | — |
intent-scan still works as a deprecated alias for scan --intent. Team commands surface only their entitlement-gated availability today — the Team tier is coming soon.
scan flags
Scope (mutually exclusive with a positional path):
| Flag | Scope |
|---|---|
--changed | Staged + unstaged changes |
--staged | Staged only (pre-commit) |
--diff <range> | A git range; main...HEAD gates what the branch adds |
--patch <file> | A unified diff, analyzed in memory without applying |
Output:
| Flag | Effect |
|---|---|
--json / --sarif | Machine output (scan.v1 / SARIF 2.1.0) |
--output <path> | Write the report to a file (stdout otherwise) |
--markdown-summary <path> | Also write a human-readable digest (CI job pages) |
--no-color | Suppress ANSI color (also via NO_COLOR, or automatically when not a TTY) |
Gating:
| Flag | Effect |
|---|---|
--fail-on <none|critical|high|medium> | The structural threshold (default high) |
--config <path> | Explicit .shipmoor.yaml |
Claim Check (IC):
| Flag | Effect |
|---|---|
--intent "<goal>" | One-line intent source |
--prompt "<prompt>" | The agent prompt as a second source (two agreeing sources → medium confidence) |
--session <transcript> | Claude Code / Cursor session: first user turn → intent; plan → plan drift |
--verdict-policy <path> | The gating policy file (Turning on the gate) |
--would-block | Compute the gate as if enabled; always exit 0 |
--explain | Per-expectation probe detail |
--quiet-intent | Collapse the claim check to one badge line |
--agent "<cmd>" | The BYO-Judge agent command |
--judge-role <name> | Role label for the judge invocation |
--author-model-id <id> | Declare who authored the diff (judge isolation) |
--strict-judge-isolation | Author == judge becomes a hard error |
Exit codes
scan: 0 clean · 1 gate fired (report still written) · 2 usage · 3 scan failed — the full contract, including how the claim-check gate unifies with --fail-on, is in Output formats & exit codes. upgrade has its own codes (0 ok/no-op · 2 usage/platform · 20 network · 21 checksum · 22 permissions · 23 replacement failed).
Environment variables
| Variable | Effect |
|---|---|
SHIPMOOR_OFFLINE=1 | Kill switch: disables the registry lookup, BYO-Judge, and telemetry recording |
SHIPMOOR_LICENSE_TOKEN / SHIPMOOR_LICENSE_FILE | License for CI / non-interactive machines |
SHIPMOOR_INTENT_DRIFT_STAGE3=1 | Opt in to BYO-Judge |
SHIPMOOR_AUTHOR_MODEL_ID | Same as --author-model-id |
SHIPMOOR_VERSION / SHIPMOOR_CHANNEL / SHIPMOOR_INSTALL_DIR | Installer controls (pin, staging, custom path) |
NO_COLOR | Suppress color |
Next
- Configuration —
.shipmoor.yamland the policy files. - Output contracts & schemas — what
--jsonemits. - Rule catalog — every rule
ruleslists.