budgetbreeze-cli

Command-line interface for Budgetbreeze — sign in and view your finance dashboard from the terminal.

Install

npm install -g budgetbreeze-cli

Usage

budgetbreeze login      # device-code login in your browser
budgetbreeze whoami     # show the signed-in account
budgetbreeze dashboard  # net-worth + spending summary (default command)
budgetbreeze logout     # clear stored credentials
budgetbreeze help

Configuration

The CLI talks to a running Budgetbreeze instance. Point it at one with:

| Variable | Description | | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | URL_DOMAIN | Host of the Budgetbreeze app, e.g. app.budgetbreeze.com or localhost:3000. localhost uses http, everything else https. | | VERCEL_PROTECTION_BYPASS | Optional. Bypass token when the target is behind Vercel deployment protection. |

Environment variables are read from the current directory's .env files (via @next/env) or the process environment.

Credentials are stored under your home directory after login.

Build (maintainers)

This package bundles the CLI source from the main Budgetbreeze repo (src/cli) into a standalone ESM binary:

npm run build   # esbuild -> dist/index.js