wallet-rest-cli 0.0.2

wallet-rest-cli

wallet-rest-cli is a console CLI for the BudgetBakers Wallet API. Useful for debugging or provide a CLI for your AI Agents.

Warning: This CLI is unofficial and not affiliated with BudgetBakers. Use at your own risk.

Setup

Install the package from PyPI:

python -m pip install wallet-rest-cli

The CLI expects a Wallet API token from the BudgetBakers web app.

export WALLET_API_TOKEN="your-token"
wallet-rest-cli --help

If you prefer a local development workflow, you can still run it with uv:

uv run wallet-rest-cli --help

Docker

Build the container image locally:

docker build -t wallet-rest-cli .

Run the image with your Wallet API token:

docker run --rm \
  -e WALLET_API_TOKEN="$WALLET_API_TOKEN" \
  wallet-rest-cli categories --limit 200

You can also use the image published to GHCR:

docker run --rm \
  -e WALLET_API_TOKEN="$WALLET_API_TOKEN" \
  ghcr.io/hugobatista/wallet-rest-cli:latest --help

Example using the docker image and querying categories started with "Food":

docker run --rm \
  -e WALLET_API_TOKEN="$WALLET_API_TOKEN" \
  ghcr.io/hugobatista/wallet-rest-cli:latest categories --name-contains "Food"

Podman

Example using the docker image and querying categories started with "Food":

podman run --rm \
  -e WALLET_API_TOKEN="$WALLET_API_TOKEN" \
  ghcr.io/hugobatista/wallet-rest-cli:latest categories --name-contains "Food"

Commands

• categories - list categories with details.
• records - list financial records with date, amount, category, label, and text filters.
• records-by-id - fetch records by one or more record IDs.
• budgets - list budgets.
• accounts - list accounts.
• goals - list goals.
• labels - list labels.
• record-rules - list automatic categorization rules.
• standing-orders - list recurring payments.
• api-usage-stats - fetch API usage statistics.

Examples

wallet-rest-cli categories --token "$WALLET_API_TOKEN" --limit 200
wallet-rest-cli records --token "$WALLET_API_TOKEN" --record-date-from 2025-01-01 --record-date-to 2025-01-31
wallet-rest-cli records-by-id --token "$WALLET_API_TOKEN" rec_123 rec_456
wallet-rest-cli api-usage-stats --token "$WALLET_API_TOKEN" --period 30days

License

This project is licensed under the MIT License. See the LICENSE file.