Core documentation
CLI reference
Generated from the executable’s Rust argument definitions and doc comments.
For installation and removal commands provided by npm and the archive installer, see Getting started.
§opcore
Lean ASP check providers and deterministic agent verification
Usage: opcore <COMMAND>
Commands:
run Run Verify, Sense, and configured native checks for post-edit, pre-commit, or CI
check Evaluate a local Git source view
sense Analyze exact local dependency changes and introduced runtime cycles
status Report effective configuration and workflow settings without evaluating source
doctor Diagnose CLI setup, workflow prerequisites, and agent integrations
rules Render the exact built-in rule and policy manifest
serve Serve the ASP Core check provider over NDJSON stdio
manifest Render an installed ASP manifest for an absolute binary path
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
Start with: opcore doctor --repo .
Then run: opcore check --repo . --all
Without a selection flag, check compares current worktree changes with HEAD.
Exit status: 0 accepted or nothing checked; 1 findings, coverage, or runtime failure;
2 argument-parsing errors (installed hooks also use 2 for intervention).§opcore run
Run Verify, Sense, and configured native checks for post-edit, pre-commit, or CI
Usage: opcore run [OPTIONS] <WORKFLOW>
Arguments:
<WORKFLOW>
Post-edit checks worktree changes; pre-commit checks the full index; CI checks a commit
Possible values:
- post-edit: Fast Verify and Sense against the current worktree
- pre-commit: Staged Verify and selected native checks, plus introduced Sense; defaults to all findings
- ci: Immutable-commit Verify and native checks, plus Sense against a base; defaults to all findings
Options:
--repo <REPO>
Repository directory; nested paths resolve to the Git worktree root
[default: .]
--tree <REF>
CI target commit or tree (default: HEAD); never reads worktree overlays
--base <REF>
CI baseline for Sense and introduced Verify/native findings; supply the intended commit
--json
Emit one structured report containing every selected check
--allow-unsandboxed-native
Authorize selected native tools to execute trusted repository code with host access
--comparison <MODE>
Select introduced or all Verify and native diagnostics; defaults to all
Possible values:
- introduced: Report diagnostics introduced since the exact baseline
- all: Report every diagnostic in the selected current provider workspace
-h, --help
Print help (see a summary with '-h')§opcore check
Evaluate a local Git source view
Usage: opcore check [OPTIONS]
Options:
--repo <REPO>
Git repository or a directory inside it (default: current directory)
[default: .]
--changed
Check worktree changes against HEAD, including non-ignored untracked source (the default)
--staged
Check the staged index against HEAD; ignore unstaged and untracked worktree changes
--all
Check the complete selected view, including existing findings; combine with --staged or --tree
--committed
Check the committed HEAD tree without index or worktree overlays
--files <FILES>
Check comma-separated literal paths relative to the repository root; no globs
--base <REF>
Compare changed or staged content against this Git ref
--tree <REF>
Check an immutable committed tree, optionally against --base
--json
Print the structured assessment as JSON, including coverage and evidence
--advisory
Report findings without returning a blocking exit status
--native
Also run Cargo Check through the unsandboxed local ASP host. Requires explicit consent
--providers <PROVIDER>
Run an explicit comma-separated provider set through the private local ASP host
Possible values:
- all: Every applicable bundled provider; inapplicable profiles are reported as skipped
- fast: Built-in parsing and deterministic source checks; never executes repository code
- rust-native: Cargo Check in private scratch; requires trusted code or an external sandbox
- node-native: Locked, offline project-local TypeScript checking in private scratch
- python-native: Host Pyright or mypy with the selected Python interpreter in private scratch
--allow-unsandboxed-native
Confirm that selected native tools may run repository code with host access
--comparison <MODE>
Select introduced or all diagnostics in the selected provider view
Possible values:
- introduced: Report diagnostics introduced since the exact baseline
- all: Report every diagnostic in the selected current provider workspace
--roots <PATH>
Focus each provider on comma-separated subfolders while retaining required project context
--workflow <WORKFLOW>
Apply this workflow's settings to the explicitly selected source view
Possible values:
- post-edit: Fast Verify and Sense against the current worktree
- pre-commit: Staged Verify and selected native checks, plus introduced Sense; defaults to all findings
- ci: Immutable-commit Verify and native checks, plus Sense against a base; defaults to all findings
-h, --help
Print help (see a summary with '-h')§opcore sense
Analyze exact local dependency changes and introduced runtime cycles
Usage: opcore sense [OPTIONS]
Options:
--repo <REPO>
Git repository or a directory inside it (default: current directory)
[default: .]
--json
Print the structured dependency report, findings, and coverage as JSON
--advisory
Report findings without blocking. Incomplete or partial coverage still blocks
--allow-partial
Accept explicitly reported partial dependency coverage with a successful exit status
--allow-node-builtins
Accept explicit `node:` built-in boundaries, but no other partial coverage
--staged
Compare the complete HEAD tree with the complete stage-0 index, ignoring worktree bytes
--hypothetical <FILE>
Apply a strict in-memory change request to the current worktree (`-` reads stdin)
--workflow <WORKFLOW>
Apply this workflow's shared settings and exclusions
Possible values:
- post-edit: Fast Verify and Sense against the current worktree
- pre-commit: Staged Verify and selected native checks, plus introduced Sense; defaults to all findings
- ci: Immutable-commit Verify and native checks, plus Sense against a base; defaults to all findings
--tree <REF>
Read source, configuration and documents from an immutable Git target
--base <REF>
Compare the target tree with this base tree (required for CI regression checks)
-h, --help
Print help (see a summary with '-h')§opcore status
Report effective configuration and workflow settings without evaluating source
Usage: opcore status [OPTIONS]
Options:
--repo <REPO>
Repository directory; nested directories resolve to their Git worktree root
[default: .]
--json
Emit the stable machine-readable JSON report
--workflow <WORKFLOW>
Inspect effective settings for this workflow; defaults to its usual Git view
Possible values:
- post-edit: Fast Verify and Sense against the current worktree
- pre-commit: Staged Verify and selected native checks, plus introduced Sense; defaults to all findings
- ci: Immutable-commit Verify and native checks, plus Sense against a base; defaults to all findings
--staged
Inspect staged configuration rather than worktree settings
--tree <REF>
Inspect configuration from this immutable commit or tree
-h, --help
Print help (see a summary with '-h')§opcore doctor
Diagnose CLI setup, workflow prerequisites, and agent integrations
Usage: opcore doctor [OPTIONS]
Options:
--repo <REPO>
Repository directory; nested directories resolve to their Git worktree root
[default: .]
--json
Emit the stable machine-readable JSON report
--workflow <WORKFLOW>
Inspect effective settings for this workflow; defaults to its usual Git view
Possible values:
- post-edit: Fast Verify and Sense against the current worktree
- pre-commit: Staged Verify and selected native checks, plus introduced Sense; defaults to all findings
- ci: Immutable-commit Verify and native checks, plus Sense against a base; defaults to all findings
--staged
Inspect staged configuration rather than worktree settings
--tree <REF>
Inspect configuration from this immutable commit or tree
-h, --help
Print help (see a summary with '-h')§opcore rules
Render the exact built-in rule and policy manifest
Usage: opcore rules [OPTIONS]
Options:
--schema
Print the repository configuration JSON Schema for editor completion and validation
-h, --help
Print help§opcore serve
Serve the ASP Core check provider over NDJSON stdio
Usage: opcore serve [OPTIONS]
Options:
--stdio
Use standard input/output as the JSON-RPC transport
--profile <PROFILE>
Select the bundled provider process identity
Possible values:
- fast: Fast Verify: built-in parsing and deterministic source checks
- rust-native: Rust-native: fixed Cargo Check over the captured Cargo workspace
- node-native: Node-native: locked, offline TypeScript checking with the project's compiler
- python-native: Python-native: host Pyright, with host mypy as the fallback
[default: fast]
-h, --help
Print help (see a summary with '-h')§opcore manifest
Render an installed ASP manifest for an absolute binary path
Usage: opcore manifest [OPTIONS] --executable <EXECUTABLE>
Options:
--executable <EXECUTABLE>
Absolute path to the installed executable whose bytes the manifest binds
--profile <PROFILE>
Select the bundled provider manifest
Possible values:
- fast: Fast Verify: built-in parsing and deterministic source checks
- rust-native: Rust-native: fixed Cargo Check over the captured Cargo workspace
- node-native: Node-native: locked, offline TypeScript checking with the project's compiler
- python-native: Python-native: host Pyright, with host mypy as the fallback
[default: fast]
-h, --help
Print help (see a summary with '-h')