ezbookkeeping

---
name: ezbookkeeping
description: ezBookkeeping is a lightweight, self-hosted personal finance app with a user-friendly interface and powerful bookkeeping features. This skill allows AI agents to add and query transactions, accounts, categories, and tags in ezBookkeeping via ezBookkeeping API Tools.
---

# ezBookkeeping API Tools

[ezBookkeeping](https://ezbookkeeping.mayswind.net/) provides a tool script called **ezBookkeeping API Tools** that allows users or AI agents to conveniently call the API endpoints from the command line using **sh** or **PowerShell**. You only need to configure two environment variables: the ezBookkeeping server address and the API token.

## Installation

Linux / macOS

```bash
curl https://raw.githubusercontent.com/mayswind/ezbookkeeping/refs/heads/main/scripts/ebktools.sh -o ebktools.sh
chmod +x ebktools.sh
```

Windows

```powershell
Invoke-WebRequest -Uri https://raw.githubusercontent.com/mayswind/ezbookkeeping/refs/heads/main/scripts/ebktools.ps1 -OutFile .\ebktools.ps1
```

## Environment Variables

| Variable | Required | Description |
| --- | --- | --- |
| `EBKTOOL_SERVER_BASEURL` | Required | ezBookkeeping server base URL (e.g., http://localhost:8080) |
| `EBKTOOL_TOKEN` | Required | ezBookkeeping API token |

## Usage

### List all supported commands

Linux / macOS

```bash
./ebktools.sh list
```

Windows

```powershell
.\ebktools.ps1 list
```

### Show help for a specific command

Linux / macOS

```bash
./ebktools.sh help <command>
```

Windows

```powershell
.\ebktools.ps1 help <command>
```

### Call API

Linux / macOS

```bash
./ebktools.sh <command> [command-options]
```

Windows

```powershell
.\ebktools.ps1 <command> [command-options]
```

## Reference

ezBookkeeping: https://ezbookkeeping.mayswind.net/