Metadata-Version: 2.5
Name: openbase-cli
Version: 0.1.0
Summary: Openbase Cloud CLI — a Heroku-style command line for the Openbase Cloud PaaS (apps, logs, config, usage, workspaces) and an alternative to the web dashboard
Project-URL: Homepage, https://openbase.cloud
Project-URL: Repository, https://github.com/openbase-community/openbase-cloud-cli
Project-URL: Issues, https://github.com/openbase-community/openbase-cloud-cli/issues
Author-email: Openbase <hello@openbase.dev>
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: click>=8.1.8
Requires-Dist: httpx>=0.28.1
Requires-Dist: rich>=13.7
Provides-Extra: dev
Requires-Dist: pytest-mock>=3.14.0; extra == 'dev'
Requires-Dist: pytest>=8.3.5; extra == 'dev'
Requires-Dist: respx>=0.22; extra == 'dev'
Requires-Dist: ruff>=0.11.10; extra == 'dev'
Description-Content-Type: text/markdown

# openbase

The command line for **[Openbase Cloud](https://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

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

## Sign in

```bash
openbase login
```

Login is handled by the [Openbase Coder](https://openbase.cloud) 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.

```bash
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`.

```bash
openbase apps                       # list your apps
openbase logs -a my-app             # recent logs
openbase logs -a my-app --tail      # stream new lines (Ctrl-C to stop)
openbase ps -a my-app               # current status (alias: status)
openbase config -a my-app           # config vars (secret values hidden)
openbase releases -a my-app         # recent deploys
openbase open -a my-app             # open the app in your browser
```

## Account, projects & workspaces

```bash
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:

```bash
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.

## Development

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

## License

MIT — see [LICENSE](LICENSE).
