si

Overview ¶

Command si works with Security Insights files in public GitHub repositories.

si fetch <target>...

Each target is one of:

owner/repo                                             discover the file's location
owner/repo/path/to/security-insights.yml               exact path
https://github.com/owner/repo/blob/<ref>/<path>        exact path
https://raw.githubusercontent.com/owner/repo/<ref>/<path>

URLs are read from the default branch: <ref> is ignored and must be a single path segment (a ref containing "/" shifts the path).

Results are written to stdout as a JSON array in input order; diagnostics go to stderr. A file that is missing or does not parse is reported in-band in its result's "status" and does not affect the exit code. Exit codes:

0  every target was processed (statuses ok, not-found or invalid)
1  the JSON could not be written
2  usage error, or at least one target has status "error" (a transport
   failure, including an unreachable parent file, so the snapshot is
   incomplete and should not be trusted)

Set GITHUB_TOKEN to raise the GitHub API rate limit.