CLI reference
considered init
Writes a starter .considered.yaml to the repository root. Fails if the file already exists.
considered check
Evaluates the repository against the configuration.
considered check
considered check --json
considered check --sarifconsidered instructions
Prints the configured free-form instructions, or(No instructions provided) when the property is absent.
considered variance add
Captures a metric value as an approved variance boundary and writes it to the configuration.
considered variance add \
--subject <path> \
--metric <metric> \
--kind <kind> \
--reason <reason>Add --metric-reason <reason> for an optional metric-specific explanation. Missing subject, metric, kind, and reason values are prompted for interactively.
considered version
Prints the CLI version. --version and -v are aliases.
Startup and usage errors
Running considered without a command prints usage to stderr and exits with status 2. Use considered --help orconsidered --version for a successful startup check. The bundled provider requires considered-scc --json --root <dir>; without arguments it prints --json is required and exits with status 2. These are application usage errors, not missing-executable errors.
Common flags
| Flag | Meaning |
|---|---|
--root <dir> | For init, check, instructions, and variance add. Defaults to the current directory. |
--config <file> | For check, instructions, and variance add. Defaults to<root>/.considered.yaml. An explicit relative path is resolved from the current working directory. |