DOCUMENTATION

Using PkgFire.

From installing the CLI to a policy for every project. Everything here describes what the service does today.

  1. 01

    Getting started

    Install the PkgFire CLI, connect it to your account with an API key, and check your first project.

  2. 02

    The install wrapper

    How pkgfire checks an install before it runs, which commands it wraps, its own flags, and what each exit code means.

  3. 03

    CI and pull requests

    Check pull requests on GitHub, Forgejo and Gitea from the dashboard, or run the CLI in any CI job with an API key.

  4. 04

    Policy reference

    The settings that turn findings into ALLOW, WARN or BLOCK - release cooldown, new-package age, licences, exceptions and baselines - with their defaults.

  5. 05

    What PkgFire checks

    The signals PkgFire reads for every package - advisories, malicious code, what a release gained, integrity, publishers, age and names - in plain words.

  6. 06

    What is uploaded

    What the CLI and the pull request checks send to PkgFire - the dependency list from your lockfile, never your source code - and what is kept.

  7. 07

    API overview

    Authenticate with an API key, submit a scan, read its verdict, and manage policies and baselines from your own automation.