Commands Overview
Command structure:
openbase [OPTIONS] COMMAND [ARGS]
Many of these operations also have equivalents in the
Openbase Cloud dashboard; the CLI is the fast
terminal path to the same account and apps.
Global Options
| Option |
Description |
-V, --version |
Print CLI version and exit |
-h, --help |
Show help |
-a, --app NAME |
Target app for app-scoped commands (or set OPENBASE_APP) |
--json |
JSON output (most read commands) |
Account
| Command |
Description |
login |
Sign in to Openbase Cloud (delegates to openbase-coder login) |
logout |
Sign out and remove the shared credentials |
whoami |
Show the signed-in account email |
account |
Account details: balance, subscription, verification |
Apps & Deploys
| Command |
Description |
apps |
List Openbase Cloud apps you can access |
open |
Open an app's primary URL in your browser |
logs |
Display and tail recent app logs |
ps |
Show an app's current stack status (alias: status) |
config |
List an app's config vars (secrets hidden) |
releases |
List recent deploy runs (releases) for an app |
Account-Wide Resources
| Command |
Description |
usage |
This month's spend and usage limits |
projects |
List your Openbase Cloud projects |
workspaces |
List your cloud dev workspaces (devspaces) |
Escape Hatch
| Command |
Description |
coder |
Run any openbase-coder command: openbase coder <args> |
Common Examples
# Sign in and confirm
openbase login
openbase whoami
# List and inspect apps
openbase apps
openbase ps -a my-app
openbase logs -a my-app --tail
openbase config -a my-app
openbase releases -a my-app
# Account-wide
openbase usage
openbase projects
openbase workspaces
# Scripting
openbase apps --json