Configuration¶
The openbase CLI is configured with a few environment variables and a couple
of global flags. Credentials are stored on disk by the shared sign-in flow.
Environment Variables¶
| Variable | Purpose | Default |
|---|---|---|
OPENBASE_APP |
Default app for -a/--app, so you can omit the flag |
— |
OPENBASE_API_URL |
Override the Openbase Cloud base URL | https://app.openbase.cloud |
OPENBASE_HOST |
Alias for OPENBASE_API_URL |
— |
Set a default app for a shell session:
Credentials¶
Sign-in is delegated to the openbase-coder CLI and writes to a shared file:
Both openbase and openbase-coder read this file, so signing in with either
tool authenticates both. openbase logout removes it. See
login and logout.
Global Flags¶
| Flag | Description |
|---|---|
-V, --version |
Print the CLI version and exit |
-h, --help |
Show help for the CLI or any subcommand |
-a, --app NAME |
Target app for app-scoped commands (or OPENBASE_APP) |
--json |
Machine-readable JSON output (supported by most read commands) |
JSON Output¶
Most read commands accept --json for scripting. Secret config values are never
returned by the API; in openbase config --json they appear as null.
Talking to a Different Backend¶
Point the CLI at a non-production Openbase Cloud API (for example a staging
environment) with OPENBASE_API_URL: