OSS IQ

Reference

Reference¶

Look up one fact here: a flag, a column, a field or a rule. Pick the page by what you have in front of you.

For tasks, see the how-to guides. For the reasoning behind a recommendation, see Explanation.

What you type¶

Page	Look here for
Commands	Every command, with its arguments, options and exit codes
Configuration	Global flags, `OSSIQ_*` environment variables, the config file, GitHub tokens, and the hosts a scan calls

What you get back¶

Page	Look here for
Console and HTML reports	Every column, marker and `↳` row of `ossiq status`, `ossiq info` and the HTML report
JSON export and agent format	Every field of the `ossiq export` file, the `--format agent` decision, and the MCP tools

What decided it¶

Page	Look here for
Update rules	The five update strategy tiers, the version ladder, and the solver’s cooldown, CVE, peer and override rules
Constraints, overrides and aliases	The five constraint types, pip and uv constraint settings, npm `overrides` and npm package aliases

What you can build on¶

Page	Look here for
Python API	`scan()`, `ScanResult`, `ScanRecord`, `Settings` and the other types you can import
Stability guarantees	What stays the same across releases: the export schema, the CLI interface and repeatable scans

Common lookups¶

You have	Go to
An option such as `--update-strategy` or `--pin-all`	Commands
An exit status, such as 75	Exit codes
`OSSIQ_GITHUB_TOKEN`, or a question about which token a scan uses	Token precedence
A label under What’s Next	What’s Next labels
`[NO RESOLUTION]`, `↳ ⚠` or another row under a package	Sub-rows
`✗ violation` or a `missing peer` row	Peer Constraint Status
A field that is missing from your export	Profiles
A `next_action` an agent received	Agent format
A recommendation older than the latest version	Cooldown
`recommended_from_rung`, `latest_in_range`	Version ladder
`constraint_type: OVERRIDE`	The five constraint types