Skip to content

docs: document the new advisories init command #850

Description

@sonukapoor

The cve-lite advisories init command shipped in #847 - it creates an empty local advisory database that air-gapped users populate themselves, then scan with --offline-db. The command works and has help text, but it isn't in the docs yet, where only advisories sync is currently mentioned.

What to do

Add advisories init alongside the existing advisories sync documentation in these files:

  • website/docs/cli-reference.md - add it to the usage block (near line 10) and the advisories examples (near line 54), mirroring how advisories sync is shown.
  • website/docs/offline-advisory-db.md - this is the main doc for air-gapped users, so it's the most important one. Add a short section explaining the init then populate then --offline-db workflow for environments where sync cannot reach OSV.
  • README.md - add a one-line mention wherever advisories sync appears in the command list.

Keep the wording factual and match the surrounding style. No code changes - docs only.

Good to know

  • The command: cve-lite advisories init [--output <path>]. Defaults to the standard advisory DB path; refuses to overwrite an existing file.
  • Run npm run build in website/ to confirm the Docusaurus site still builds.

This is a docs follow-up to #847.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationfirst-timers-onlyReserved for contributors making their first contribution to this projectgood first issueGood for newcomers

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions