Skip to main content

openbase

The command line for Openbase Cloud — a Heroku-style tool and a fast alternative to the web dashboard. Sign in once, then manage and inspect your apps, deploys, usage, projects, and workspaces from the terminal. It speaks only HTTPS to the Openbase Cloud API.

Install

pip install openbase-cli    # provides the `openbase` command
# or:  uv tool install openbase-cli

Sign in

openbase login

Login is handled by the Openbase Coder CLI (openbase-coder), which the two tools share — openbase login runs openbase-coder login and stores credentials in ~/.openbase/auth.json, so signing in with either tool signs you in for both. Install openbase-coder first if you don't have it.

openbase whoami     # signed-in email
openbase account    # account details (balance, subscription)
openbase logout     # sign out

Apps & deploys

Address an app with -a/--app NAME, or set OPENBASE_APP.

openbase apps                       # list your apps
openbase logs -a my-app             # recent logs
openbase logs -a my-app --lines 200 # more log lines
openbase logs -a my-app --tail      # stream new lines (Ctrl-C to stop)
openbase run -a my-app python manage.py migrate   # one-off command in the web container
openbase ps -a my-app               # current status (alias: status)
openbase config -a my-app           # config vars (secret values hidden)
openbase config set -a my-app K=V   # set a plaintext var (redeploys)
openbase health-check -a my-app     # web health-check path (zero-downtime probes)
openbase releases -a my-app         # recent deploys
openbase open -a my-app             # open the app in your browser

Account, projects & workspaces

openbase usage        # this month's spend and limits
openbase projects     # your Openbase Cloud projects
openbase workspaces   # your cloud dev workspaces (devspaces) and status

Coder passthrough

Anything not covered here can be run against the Coder CLI directly:

openbase coder <args>       # runs `openbase-coder <args>`

Configuration

Variable Purpose Default
OPENBASE_APP Default app for -a —
OPENBASE_API_URL Override the Openbase Cloud base URL https://app.openbase.cloud
OPENBASE_HOST Alias for OPENBASE_API_URL —

Add --json to most commands for scripting.

Documentation

Full docs live at docs-cloud.openbase.cloud (built from docs/ with zensical). Build or serve them locally:

uvx zensical serve     # live preview
uvx zensical build     # static site into ./site

Development

uv run --extra dev pytest
uv run --extra dev ruff check .

License

MIT — see LICENSE.

Metadata

Release files for openbase-cli 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openbase-cli 0.3.0
File Size Uploaded Provenance
openbase_cli-0.3.0.tar.gz 42.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for openbase-cli 0.3.0
File Interpreter ABI Platform
openbase_cli-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 73.0 kB

Release files / openbase_cli-0.3.0.tar.gz

Download URL openbase_cli-0.3.0.tar.gz
Size 42.8 kB
Tags Source
SHA-256 checksum
How to use checksums
69052b3155614fca3bc9676d583e18f15375bcf7a87a041438af54c3109150e7
BLAKE2b-256 checksum
How to use checksums
11b5c69407eb61d91e817e2e245386558174381084494ded531c29c72662e42b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / openbase_cli-0.3.0-py3-none-any.whl

Download URL openbase_cli-0.3.0-py3-none-any.whl
Size 30.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
05df58cb234da917f5b06106116cfd2bb64e7d1036d312e66aec26d8deb49202
BLAKE2b-256 checksum
How to use checksums
aff7731995b80235e7402fbd7a764777c07962afdfc0c10d3169aa0799acc0ec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Security for openbase-cli 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page