|
| 1 | +# Quick Start |
| 2 | + |
| 3 | +## Setup |
| 4 | + |
| 5 | +```bash |
| 6 | +cd your-project |
| 7 | +git pkgs init |
| 8 | +``` |
| 9 | + |
| 10 | +## Basic Commands |
| 11 | + |
| 12 | +```bash |
| 13 | +# Show current dependencies |
| 14 | +git pkgs list |
| 15 | + |
| 16 | +# Filter by manifest |
| 17 | +git pkgs list --manifest=Gemfile |
| 18 | + |
| 19 | +# Show dependencies at a specific point in time |
| 20 | +git pkgs list january-2025 |
| 21 | + |
| 22 | +# Show dependency changes in HEAD commit |
| 23 | +git pkgs show |
| 24 | + |
| 25 | +# Compare dependencies between refs |
| 26 | +git pkgs diff --from=HEAD~10 |
| 27 | +git pkgs diff --from=january-2025 |
| 28 | +``` |
| 29 | + |
| 30 | +## History and Blame |
| 31 | + |
| 32 | +```bash |
| 33 | +# History of a specific package |
| 34 | +git pkgs history rails |
| 35 | + |
| 36 | +# All dependency changes by an author |
| 37 | +git pkgs history --author=Andrew |
| 38 | + |
| 39 | +# Find where a package is declared |
| 40 | +git pkgs where dotenv-rails |
| 41 | +``` |
| 42 | + |
| 43 | +## Package Health |
| 44 | + |
| 45 | +```bash |
| 46 | +# Find outdated packages |
| 47 | +git pkgs outdated |
| 48 | + |
| 49 | +# Show licenses with compliance check |
| 50 | +git pkgs licenses |
| 51 | +git pkgs licenses --permissive |
| 52 | +``` |
| 53 | + |
| 54 | +## Vulnerability Scanning |
| 55 | + |
| 56 | +```bash |
| 57 | +# Show commits that introduced or fixed vulnerabilities |
| 58 | +git pkgs vulns log |
| 59 | + |
| 60 | +# Show who introduced vulnerabilities |
| 61 | +git pkgs vulns blame |
| 62 | + |
| 63 | +# Show who fixed vulnerabilities |
| 64 | +git pkgs vulns praise |
| 65 | + |
| 66 | +# Show exposure metrics over all time |
| 67 | +git pkgs vulns exposure --all-time |
| 68 | +``` |
| 69 | + |
| 70 | +## SBOM Export |
| 71 | + |
| 72 | +```bash |
| 73 | +# Export as CycloneDX (default) |
| 74 | +git pkgs sbom > sbom.json |
| 75 | + |
| 76 | +# Export as SPDX |
| 77 | +git pkgs sbom --type=spdx |
| 78 | +``` |
| 79 | + |
| 80 | +## Git Integration |
| 81 | + |
| 82 | +```bash |
| 83 | +# Install diff driver for semantic lockfile diffs |
| 84 | +git pkgs diff-driver --install |
| 85 | + |
| 86 | +# Now git diff shows dependency changes |
| 87 | +git diff HEAD~5 -- Gemfile.lock |
| 88 | +``` |
| 89 | + |
| 90 | +## Database Schema |
| 91 | + |
| 92 | +```bash |
| 93 | +# Show database schema |
| 94 | +git pkgs schema |
| 95 | +``` |
0 commit comments