proxy

Overview ¶

Command proxy runs the git-pkgs package registry proxy server.

@title git-pkgs proxy API @version 0.1.0 @description HTTP API for package enrichment, vulnerability lookup, cache stats, and source browsing. @BasePath /

The proxy caches package artifacts from upstream registries (npm, cargo, etc.) providing faster, more reliable access for development teams.

Usage:

proxy [command] [flags]

Commands:

serve    Start the proxy server (default if no command given)
stats    Show cache statistics
mirror   Pre-populate cache from PURLs, SBOMs, or registries

Serve Flags:

-config string
      Path to configuration file (YAML or JSON)
-listen string
      Address to listen on (default ":8080")
-base-url string
      Public URL of this proxy (default "http://localhost:8080")
-storage-url string
      Storage URL (file:// or s3://)
-storage-path string
      Path to artifact storage directory (deprecated, use -storage-url)
-database-driver string
      Database driver: sqlite or postgres (default "sqlite")
-database-path string
      Path to SQLite database file (default "./cache/proxy.db")
-database-url string
      PostgreSQL connection URL
-log-level string
      Log level: debug, info, warn, error (default "info")
-log-format string
      Log format: text, json (default "text")

Stats Flags:

-database-driver string
      Database driver: sqlite or postgres (default "sqlite")
-database-path string
      Path to SQLite database file (default "./cache/proxy.db")
-database-url string
      PostgreSQL connection URL
-json
      Output as JSON
-popular int
      Show top N most popular packages (default 10)
-recent int
      Show N recently cached packages (default 10)

Global Flags:

-version
      Print version and exit

Environment Variables:

PROXY_LISTEN           - Listen address
PROXY_BASE_URL         - Public URL
PROXY_STORAGE_URL      - Storage URL (file:// or s3://)
PROXY_STORAGE_PATH     - Storage directory (deprecated)
PROXY_DATABASE_DRIVER  - Database driver (sqlite or postgres)
PROXY_DATABASE_PATH    - SQLite database file path
PROXY_DATABASE_URL     - PostgreSQL connection URL
PROXY_LOG_LEVEL        - Log level
PROXY_LOG_FORMAT       - Log format

Example:

# Start with defaults
proxy

# Start with custom settings
proxy serve -listen :3000 -base-url https://proxy.example.com

# Show cache statistics
proxy stats

# Show stats as JSON
proxy stats -json