Skip to content

User Guide

Task-oriented documentation. For the model behind these tasks, see Core Concepts; for exhaustive flag lists, see Reference.

  • Checking for updates

    The read-only report: filters, formats, streams and how to consume them.

  • Updating dependencies

    Applying changes safely: previews, selection, pin mode, hashes, backups.

  • Configuration

    Config files, environment variables and the precedence rules between them.

  • CI/CD integration

    Gating builds, opening update pull requests, and scheduled drift reports.

  • Operations

    Networking, caching, performance, security posture and diagnostics.

  • Best practices

    How to structure requirements files so depkeeper produces good answers.

  • Troubleshooting

    Symptom-indexed diagnosis and recovery.

Workflow cheat sheet

Bash
depkeeper check --outdated-only     # what moved?
depkeeper update --dry-run          # what would change?
depkeeper update --backup           # apply, keeping a copy
pip install -r requirements.txt && pytest
Bash
depkeeper check --format json | jq '.[] | select(.name == "django")'
depkeeper update -p django --dry-run
Bash
depkeeper check --format json --no-check-conflicts > report.json
jq '[.[] | select(.status == "outdated")] | length' report.json
Bash
depkeeper update --pin --backup     # freeze to exact versions
pip install -r requirements.txt
pytest
git diff requirements.txt
Bash
depkeeper update requirements/base.txt --dry-run   # follows -r includes
depkeeper check requirements/dev.txt