up0 CLI

The up0 CLI is a Python package for streaming your organization's telemetry, querying it over a range, and managing your session from the terminal. It is a consumer of the backend API only: no resource CRUD beyond monitor-to-service binding, no provisioning.

Install

There is no PyPI release yet. Install from the monorepo:

git clone https://github.com/up0io/up0_io
cd up0_io/cli
pip install -e .

No PyPI package

pip install up0 does not exist today. The editable install above is the only supported path. Publishing to PyPI is an accepted decision, not yet built (docs/v2/cli/decisions/0006-pypi-distribution.md).

Rather not install a Python? The CLI also builds as a Docker image — see "Run it in Docker" in cli/README.md for the exact docker run invocation, including why up0 auth login cannot run inside the container.

Log in

up0 auth login
# Opens your browser to sign in via Zitadel (OIDC, PKCE, no client secret).
# The session is stored in ~/.up0/config.yaml (or the OS keyring) and
# auto-refreshed.

up0 whoami   # who you are, which profile is active, and what it points at

There is no API key and no up0 auth configure prompt — auth is browser OIDC only. See Config file and profiles for the --profile flag, the config file shape, and a trap worth knowing before your first login.

Check connectivity

up0 health
# ✓ API is healthy — status: healthy

Structured output

Most commands can print JSON instead of a Rich table or confirmation message, for scripts and agents. The flag name isn't the same on every command — see Structured output before assuming --output json works everywhere.

Commands

Command	Description
`up0 auth`	Log in / log out via browser OIDC
`up0 tokens`	Ingestion token management
`up0 ingest`	Send a synthetic OTLP payload and confirm it lands
`up0 tail`	Stream logs or traces to the terminal
`up0 metrics`	List metrics and query one as a time series
`up0 monitors`	List monitors and bind/unbind them to a service
`up0 schema`	Explain a registered Kind's manifest spec
`up0 service-accounts`	Manage additional service accounts (owner only)
`up0 deploy`	Report deployments to up0 (CI-facing)
`up0 whoami` / `up0 health` / `up0 import` / `up0 stats`	Top-level commands with no group prefix

The full generated reference lists every command's options, types, defaults and help text, regenerated straight from the CLI's own Typer app — it never drifts from what --help actually prints.

CLI overview