ownpurse docs
ownpurse keeps a local record of the facts from your financial sources, in a file you hold. It rebuilds your ledger from that record, checks it against the source to the cent, and lets you and your agents plan changes that reach your books only after you approve them. Xero is the first source; others are planned.
ownpurse is in early development. macOS is the tested platform.
Start here
Section titled “Start here”IntroductionWhat ownpurse is and how its layers fit together.
InstallBuild the CLI and terminal UI, and check your setup.
QuickstartRun the offline demo, then connect your Xero organisations.
ConceptsThe record, versions, sources, the local ledger and parity.
Guides
Section titled “Guides”ConfigurationEvery key in ownpurse.json.
ReportsTrial balance, ledger, P&L, balance sheet, parity and exports.
IntercompanyCheck that related organisations agree.
Terminal UITabs, keys, themes, walkthroughs and upgrades.
Working with agentsAXI conventions and the view-only agent bridge.
Writes and classificationManifests, sealed packages you approve, and local labels.
Developers
Section titled “Developers”ArchitectureCrates, dependencies, tests and safety rules.
Data modelThe record's layers and tables, and the direction toward facts.
Writing a connectorWhat a connector must do to bring in a new source.
ContributingBuild, test, the release gate and releases.
SecurityCredentials, tokens, writes and reporting.
Reference
Section titled “Reference”CLI referenceEvery command and option, from the binary's own help.
RoadmapWhat ships, what comes next, what is planned.
ChangelogEvery notable change, release by release.