Command Reference
peeq provides commands for inspecting Python packages, resolving dependencies, and managing the local cache. Every command works directly against a package registry — no installation required.
Commands
Inspection
-
Show package metadata with optional version history, vulnerability scan, and dependency list.
-
List available versions with filtering by specifier, limit, or yanked status.
-
Show package dependencies, with optional diff between versions.
-
List distribution artifacts — wheels and sdists — for a version.
-
Print a file from inside a package archive.
-
List file paths inside a package archive.
-
Download a package archive or extract its contents to disk.
Resolution & Security
System
-
Cache management — view stats, clear entries, check integrity.
-
Print the configuration file path.
-
Print agent skill instructions for AI agents.
Global options
These options apply to every command.
| Option | Description |
|---|---|
--format, -f |
Output format: pretty, plain, agent, json. Auto-detected by default (see below). |
--no-cache |
Bypass the cache entirely — don't read from or write to it. |
--index-url, -i |
Package index URL. Defaults to https://pypi.org. |
--backend |
Backend type override: pypi (PEP 691 JSON) or simple (PEP 503 HTML). Auto-detected by default. |
--verbose, -v |
Enable verbose logging. |
Use peeq --version to print the version number and exit.
Output format auto-detection
When --format is not specified, peeq selects a format automatically:
- Terminal (TTY) —
prettyformat with Rich panels, tables, and syntax highlighting. - Piped or redirected —
plainformat with clean text and no ANSI codes.
The agent and json formats are never auto-selected.
Use --format agent or --format json explicitly.
Version defaulting
Most commands accept a --version option to target a specific package release.
When omitted, peeq defaults to the latest non-yanked version.