CLI reference¶
The complete help output is generated from the installed CLI. Run
uv-packsize --help locally for the same reference. If the console script is
not on PATH, use the module entry point instead:
Usage: uv-packsize [OPTIONS] [PACKAGE_NAMES]...
Report the size of a Python package and its dependencies using uv.
Options:
--version Show the version and exit.
--prefix PATH Analyze an existing prefix without running or
changing it.
--project PATH Analyze one explicit pyproject.toml with an
explicit uv.lock.
--lockfile PATH Explicit uv.lock used with --project.
--workspace-member TEXT Select the explicit workspace member by
normalized package name.
--group TEXT Include one explicit dependency group
(repeatable).
--all-groups Include all validated dependency groups.
--extra TEXT Include one explicit extra (repeatable).
--baseline PATH Read a baseline JSON file and report its diff
from a fresh or project analysis.
--write-baseline PATH Atomically write the fresh or project analysis
JSON to PATH.
--overwrite-baseline Replace an existing --write-baseline target
explicitly.
--site-packages REL Relative site-packages directory inside
--prefix (repeatable).
--case-rule [sensitive|insensitive]
Target filesystem case rule required with
--prefix.
--bin Text output only: display RECORD-owned scripts
separately without changing the total.
--allow-build Allow source builds during installation;
disabled by default.
--prerelease [disallow|allow|if-necessary|explicit|if-necessary-or-explicit]
Pre-release resolution policy for package
requests. The default allows pre-releases only
when necessary. [default: (if-necessary)]
--json Write the versioned analysis result as JSON to
stdout.
--comparison-json Write the versioned baseline comparison result
as JSON to stdout.
--report [standard|rich] Text report layout. Rich shows a redacted
primary top-five summary; ignored with --json
or --comparison-json. [default: rich]
--quiet Suppress progress messages without changing
final output or errors.
--color [auto|always|never] Color human-readable final reports; JSON and
diagnostics remain plain. [default: auto]
--budget-config PATH Read budget policy from [tool.uv-
packsize.budget] in PATH.
--max-total BYTES Maximum canonical global logical size in
bytes. [0<=x<=9223372036854775807]
--max-increase BYTES Maximum canonical global logical-size increase
in bytes. [0<=x<=9223372036854775807]
--incomplete-policy [fail|allow-partial]
Budget handling for incomplete measurements.
--explain Text output only: show installed-metadata
dependency paths and attribution. Unavailable
with --prefix or --project.
--breakdown Text output only: show global file-category
and dependency-role sizes. Unavailable with
--prefix or --project.
--contributions Text output only: show non-split requested-
root byte contributions. Unavailable with
--prefix or --project.
-p, --python TEXT Specify the Python version for the virtual
environment.
--help Show this message and exit.
See the task-oriented guides for examples and behavior details: