Skip to content
Vein

CLI

The vein binary (Vein multi-ecosystem package proxy) exposes these subcommands. All accept --config <path> (default vein.toml) unless noted otherwise.

vein serve

Section titled “vein serve”

Start the proxy server.

Terminal window
vein serve --config vein.toml

vein stats

Section titled “vein stats”

Display cache statistics for the configured databases.

Terminal window
vein stats --config vein.toml

vein catalog sync

Section titled “vein catalog sync”

Sync the upstream gem catalogue immediately, rather than waiting for the scheduled refresh.

Terminal window
vein catalog sync --config vein.toml

vein health

Section titled “vein health”

Perform a health check against a running Vein instance.

Terminal window
vein health --url http://127.0.0.1:8346/up --timeout 5
  • --url defaults to http://127.0.0.1:8346/up.
  • --timeout is in seconds, defaults to 5.

vein init

Section titled “vein init”

Initialize a new vein.toml configuration file.

Terminal window
vein init --output vein.toml
vein init --output vein.toml --force   # overwrite an existing file

vein quarantine

Section titled “vein quarantine”

Supply chain protection commands. See Quarantine for the underlying policy.

Terminal window
# Show quarantine statistics
vein quarantine status --config vein.toml


# List versions currently in quarantine (default limit: 50)
vein quarantine list --config vein.toml --limit 50


# Manually promote all expired quarantines now
vein quarantine promote --config vein.toml


# Approve a version for immediate release
vein quarantine approve <gem> <version> [--platform <platform>] --reason "..."


# Block a version (marks it as yanked)
vein quarantine block <gem> <version> [--platform <platform>] --reason "..."

approve and reason default to "cli approval"; block defaults to "cli block" if --reason is omitted.

vein-admin

Section titled “vein-admin”

The admin dashboard is a separate binary. See Admin Dashboard.

Terminal window
cargo run -p vein-admin -- --config vein.toml --bind 127.0.0.1 --port 9400

Common make / just targets

Section titled “Common make / just targets”

The repository’s Makefile and justfile wrap these for local development:

Command Action
make run / just run vein serve --config $CONFIG
make stats vein stats --config $CONFIG
make admin Start the admin dashboard
just check Type-check the workspace
just clippy Lint with clippy
just test Run the workspace test suite
just qa Format check + type-check + clippy + docs + tests