API Reference

Generated from docstrings; the contract is the shipped API header, pkgforge/AGENTS.md. The library is pkgforge.Project plus the entry, file-DB and dump-format types -- see the pages in this section, one per module. The command line, pkgforge.cli, is not library API; it is documented in the commands guide.

Errors

pkgforge.exceptions.PkgForgeError

Bases: Exception

Base class for pkgforge's own runtime failures.

Caught by :func:pkgforge.cli.main's error boundary: prints one pkgforge: error: ... line to stderr and exits 1. Python-API callers still see it raised normally.

pkgforge.exceptions.UsageError

Bases: PkgForgeError, ValueError

An argument-shaped mistake (a bad or missing value the caller gave).

Caught by :func:pkgforge.cli.main's error boundary and mapped to exit 2, like an argparse usage error. Subclasses :class:ValueError because it reports malformed input.