Get started

From install to your first question in six steps.

You need macOS, git and a Xero login. ownpurse builds itself with a pinned Rust toolchain. It is in early access: expect rough edges, and tell us about them.

1

Install

Clone the repository and run the installer. It builds ownpurse and its terminal UI with a pinned Rust toolchain and puts both in ~/.local/bin.

Read more
git clone https://github.com/brancusi/ownpurse
cd ownpurse
./install.sh
2

Try the demo

A scripted walkthrough in the real terminal UI over a mock database. No account, no network, nothing to configure.

Read more
ownpurse demo
3

Connect Xero

Create a free Xero app for yourself (PKCE, redirect http://localhost:8765/callback), put its client id in ownpurse.json, then log in once and tick every organisation you want.

Read more
cp ownpurse.example.json ownpurse.json
ownpurse login
ownpurse orgs
4

Sync

The first sync reads everything and may take a few minutes per organisation. Later syncs fetch only what changed, and every call is logged against the daily budget.

Read more
ownpurse sync all
ownpurse doctor
5

Ask your first question

Every read comes from the record on your disk, so ask as many as you like.

Read more
ownpurse tb roast --date 2026-09-30
ownpurse parity roast --date 2026-09-30
ownpurse tui
6

Bring your agent

The CLI is built for agents: compact output, counts, structured errors, --json everywhere. The ui bridge lets an agent read and drive the terminal UI you are looking at.

Read more
ownpurse ui --help
Questions

What people ask first.

Where does my data go?

Into one SQLite file in your project folder. Only sync and a few marked commands talk to your provider, and nothing is sent to us: there is no us to send it to.

Can it change my books?

Login asks for read access. Writes go through a manifest and a sealed package you approve, and the record keeps every attempt and result.

What about Xero’s API limits?

Reads never call Xero. Sync is incremental and shows the calls used and left for the day, per organisation.

Does it work with several businesses?

Yes. One login covers every organisation you tick; address them by alias or as a group, and match balances between them.

Which platforms?

macOS is tested. Linux should work. Windows is not supported yet.

When do other connectors arrive?

QuickBooks, bank exports, spreadsheets, portfolios and files are next. Watch the repository, or have your agent write one.

DocsDocumentationInstall, guides, the CLI reference and the developer docs.ReadThe philosophyWhy a log of facts, and why now.SourceGitHubRead the code, file an issue, write a connector.