@organizze/cli

Command-line interface for the Organizze REST API v2. Human-readable tables by default, machine JSON with --json.

Install

Standalone binaries (no Node/npm required) are published to GitHub Releases for macOS, Linux, and Windows.

macOS / Linux / WSL2

curl -fsSL https://raw.githubusercontent.com/organizze/agent-tools/main/scripts/install.sh | bash

Windows (PowerShell)

irm https://raw.githubusercontent.com/organizze/agent-tools/main/scripts/install.ps1 | iex

Homebrew (macOS / Linux)

brew install --cask organizze/tap/organizze

Scoop (Windows)

scoop bucket add organizze https://github.com/organizze/homebrew-tap
scoop install organizze

npm (any OS with Node)

npm i -g @organizze/cli

Or download a binary directly from the latest release (organizze-<os>-<arch>); checksums are in checksums.txt.

Authenticate

Generate an API key in Organizze under Configurações → Chaves de API, then:

organizze login           # prompts for e-mail + key, stores them in ~/.config/organizze/config.json
organizze status          # verify the connection

Credentials resolve with precedence flags > env vars > stored file:

| Source | Email | Key | Base URL | |---|---|---|---| | Flags | --email | --api-key | --base-url | | Env | ORGANIZZE_EMAIL | ORGANIZZE_API_KEY | ORGANIZZE_BASE_URL | | File | ~/.config/organizze/config.json (honors XDG_CONFIG_HOME) | | |

Non-interactive login (CI): organizze --email [email protected] --api-key "$KEY" login.

Usage

organizze accounts list
organizze transactions list --since 2026-01-01 --until 2026-01-31
organizze transactions list --all                 # auto-paginate every page
organizze summary --periodicity monthly
organizze credit-cards list
organizze invoices list 123
organizze budgets --year 2026 --month 6
organizze --json accounts list                     # JSON for scripts/agents

Money is always integer cents (negative = expense). Writes are explicit:

organizze transactions create --description "Mercado" --date 2026-06-18 \
  --amount-cents -5000 --account-id 1 --category-id 7
organizze accounts create --name "Reserva" --type savings
organizze invoices pay 123 456 --amount-cents 120000 --account-id 1

Commands

login · logout · status · accounts (list|get|create) · credit-cards (list|get) · invoices (list|get|pay) · categories list · transactions (list|get|create) · transfers · budgets · summary · institutions · users · entities.

Exit codes

| Code | Meaning | |---|---| | 0 | success | | 1 | generic error | | 2 | usage error | | 3 | auth (not logged in, bad key, or read-only key on a write) | | 4 | not found | | 5 | validation (422) — field errors are printed | | 6 | rate limited (429) | | 7 | network error |