Skip to content

Reference

Specification-grade documentation. These pages state what is true, without tutorial framing.

  • CLI commands


    Every command, argument, flag, default and precedence rule.

  • Configuration options


    Config keys, environment variables, discovery and validation rules.

  • Exit codes


    Exit code semantics per command and scripting patterns.

  • File formats


    Accepted requirements-file syntax, encodings and rewrite rules.

  • JSON output


    The --format json schema, field by field.

  • Error reference


    Exception hierarchy and a catalogue of user-visible messages.

  • Known limitations


    Behaviours that are surprising, constrained or not yet implemented.

  • Python API


    Generated API documentation for programmatic use.


Quick reference

Bash
# Global
depkeeper [-c PATH] [-v|-vv] [--color|--no-color] [--version] [-h] COMMAND

# Read-only
depkeeper check [FILE] [--outdated-only] [-f table|simple|json]
                       [--strict-version-matching]
                       [--check-conflicts|--no-check-conflicts]

# Write
depkeeper update [FILE] [--dry-run] [-y] [--backup] [--pin]
                        [--allow-hash-removal] [-p NAME]...
                        [--strict-version-matching]
                        [--check-conflicts|--no-check-conflicts]
Constant Value
Default file requirements.txt
Default format table
Conflict checking enabled
Strict version matching disabled
Request timeout 30 s
Retries 3 (4 attempts)
Max file size 10 MB
Concurrent requests 10
Resolution passes 100
Exit codes 0 success · 1 error · 2 usage · 130 interrupted