KYM - Revision history

Eleutherious: Plainer prose: fewer quotes, project claims attributed, glosses folded in

2026-11-04T23:27:08Z

Plainer prose: fewer quotes, project claims attributed, glosses folded in

Eleutherious: Second check: fixes to facts, dates (UTC), glosses and attribution

2026-11-04T21:00:56Z

Second check: fixes to facts, dates (UTC), glosses and attribution

← Older revision		Revision as of 21:00, 4 November 2026
Line 13:		Line 13:

	== What it does ==		== What it does ==
	* ~~Keeps~~ a zero-based envelope budget ~~with~~ no server and no cloud custody of the finances. The README calls it a YNAB ~~alternative~~.		* It keeps a zero-based envelope budget, which gives every unit of income a spending category. The README says it has no server and no cloud custody of the finances. The README calls it an alternative to the budgeting app YNAB (You Need A Budget).
	* ~~Syncs~~ a household's budget directly between its devices over Logos Delivery, end-to-end encrypted.		* It syncs a household's budget directly between its devices over Logos Delivery. The README says the sync is end-to-end encrypted.
	* ~~Holds~~ several budgets at once. Each budget is its own household, with its own secret, topic and event log, and is shared by showing its QR code or pairing code.		* It holds several budgets at once. Each budget is its own household, with its own secret, topic and event log, and is shared by showing its QR code or pairing code.
	* ~~Records~~ money as an append-only ledger. An edit is a new event and a delete is a tombstone, so two people editing offline end up with the same budget after sync.		* It records money as an append-only ledger. An edit is a new event and a delete is recorded as a marker event (a tombstone), so two people editing offline end up with the same budget after sync.
	* ~~Runs~~ a desktop view in Basecamp (<code>kym</code>) over a core module (<code>kym_core</code>). The same core can run headless under <code>logoscore</code> as an always-on hub.		* It runs a desktop view in Basecamp (<code>kym</code>) over a core module (<code>kym_core</code>). The same core can run headless (with no interface) under <code>logoscore</code> as an always-on hub.
	* ~~Has~~ an Android companion app for logging an expense quickly, with on-device receipt OCR.		* It has an Android companion app for logging an expense quickly, with on-device receipt OCR (reading the text of a photographed receipt).
	* ~~Includes~~ a command-line budget with accounts, categories, targets, bank import, reconciliation and reports.		* It includes a command-line budget with accounts, categories, targets, bank import, reconciliation and reports.

	Stage: Almost done. The README says the engine, contract, crypto, merge and both module builds "are green and cross-checked"~~, and~~ that "The mobile Delivery transport is still being stabilised on real hardware." The README does not say whether it is an official Logos project.		Stage: Almost done. The README's status ends with "Needs real hardware to finish", followed by the phone's receive path and OCR accuracy on real receipts. It says the engine, contract, crypto, merge and both module builds "are green and cross-checked". It adds that "The mobile Delivery transport is still being stabilised on real hardware." The README does not say whether it is an official Logos project.

	== Use it ==		== Use it ==
Line 33:		Line 33:
	* <code>npm install</code> sets up the packages. <code>npm test</code> runs the engine and sync tests and <code>npm run demo</code> shows two partners editing one budget offline and then syncing.		* <code>npm install</code> sets up the packages. <code>npm test</code> runs the engine and sync tests and <code>npm run demo</code> shows two partners editing one budget offline and then syncing.
	* The Android APK is built and signed locally with <code>scripts/build-apk.sh</code>.		* The Android APK is built and signed locally with <code>scripts/build-apk.sh</code>.
	* Releases are cut by pushing a <code>module-v*</code> tag. CI then builds the portable <code>.lgx</code> and refreshes <code>repo/index.json</code>.		* Releases are cut by pushing a <code>module-v*</code> tag. CI then builds the portable <code>.lgx</code> and refreshes <code>repo/index.json</code>. The only tag so far is v0.8.0.

	== Releases ==		== Releases ==
Line 48:		Line 48:
	* [https://github.com/vpavlin/kym/blob/master/module/metadata.json module/metadata.json] and [https://github.com/vpavlin/kym/blob/master/kym_core/metadata.json kym_core/metadata.json], GitHub		* [https://github.com/vpavlin/kym/blob/master/module/metadata.json module/metadata.json] and [https://github.com/vpavlin/kym/blob/master/kym_core/metadata.json kym_core/metadata.json], GitHub
	* [https://github.com/vpavlin/kym/tags kym tags], GitHub		* [https://github.com/vpavlin/kym/tags kym tags], GitHub
			* [https://github.com/vpavlin/kym/blob/master/.github/workflows/release-module.yml release-module.yml] workflow, GitHub

	{{Page status\|Stub}}		{{Page status\|Stub}}

Eleutherious: New tool page, source-checked against the project README

2026-11-04T19:09:51Z

New tool page, source-checked against the project README

New page

{{Infobox tool
| name = KYM
| what = A local-first, peer-to-peer, zero-based budget on the Logos stack
| stage = Almost done
| licence = MIT or Apache-2.0
| code = https://github.com/vpavlin/kym
| use = https://github.com/vpavlin/kym#install--distribute
| build = https://github.com/vpavlin/kym#try-it
| verified_on = 4 November 2026
| verified_against = README and commit of 10 October 2026
}}
'''KYM''' (Know Your Money) is a household envelope budget that syncs between its users' own devices over [[Logos Messaging]] (Logos Delivery, also called Waku), with a [[Basecamp]] module for the desktop and an Android app. It is published by the GitHub user vpavlin.

== What it does ==
* Keeps a zero-based envelope budget with no server and no cloud custody of the finances. The README calls it a YNAB alternative.
* Syncs a household's budget directly between its devices over Logos Delivery, end-to-end encrypted.
* Holds several budgets at once. Each budget is its own household, with its own secret, topic and event log, and is shared by showing its QR code or pairing code.
* Records money as an append-only ledger. An edit is a new event and a delete is a tombstone, so two people editing offline end up with the same budget after sync.
* Runs a desktop view in Basecamp (<code>kym</code>) over a core module (<code>kym_core</code>). The same core can run headless under <code>logoscore</code> as an always-on hub.
* Has an Android companion app for logging an expense quickly, with on-device receipt OCR.
* Includes a command-line budget with accounts, categories, targets, bank import, reconciliation and reports.

Stage: Almost done. The README says the engine, contract, crypto, merge and both module builds "are green and cross-checked", and that "The mobile Delivery transport is still being stabilised on real hardware." The README does not say whether it is an official Logos project.

== Use it ==
# In Basecamp, open Settings, then Package Repositories, and add <code>https://apps.vpavlin.xyz/logos-repo.json</code>.
# Install the two packages <code>kym_core</code> (the core module) and <code>kym</code> (the view).
# For Android, install the APK from the F-Droid repository at [https://apps.vpavlin.xyz apps.vpavlin.xyz]. It is built for arm64 phones.
# To try it without Basecamp, run <code>npm install</code>, <code>npm test</code> and <code>npm run demo</code> in the repository, then drive a budget with <code>node cli/kym.mjs</code>.
The README does not name a Basecamp version.

== Build it ==
* <code>npm install</code> sets up the packages. <code>npm test</code> runs the engine and sync tests and <code>npm run demo</code> shows two partners editing one budget offline and then syncing.
* The Android APK is built and signed locally with <code>scripts/build-apk.sh</code>.
* Releases are cut by pushing a <code>module-v*</code> tag. CI then builds the portable <code>.lgx</code> and refreshes <code>repo/index.json</code>.

== Releases ==
The latest tag is v0.8.0, dated 4 August 2026. <code>module/metadata.json</code> gives the <code>kym</code> view version 0.7.0, and <code>kym_core/metadata.json</code> gives <code>kym_core</code> version 0.8.1.

== See also ==
* [[Basecamp]]
* [[Tools]]
* [[Logos Messaging]]
* [[Perun]]

== Sources ==
* [https://github.com/vpavlin/kym kym README], GitHub, last commit 10 October 2026
* [https://github.com/vpavlin/kym/blob/master/module/metadata.json module/metadata.json] and [https://github.com/vpavlin/kym/blob/master/kym_core/metadata.json kym_core/metadata.json], GitHub
* [https://github.com/vpavlin/kym/tags kym tags], GitHub

{{Page status|Stub}}

← Older revision		Revision as of 23:27, 4 November 2026
Line 10:		Line 10:
	\| verified_against = README and commit of 10 October 2026		\| verified_against = README and commit of 10 October 2026
	}}		}}
	'''KYM''' (Know Your Money) is a household envelope budget that syncs between its users' own devices over [[Logos Messaging]] (Logos Delivery, also called Waku)~~, with~~ a [[Basecamp]] module for the desktop and an Android app~~. It is published by~~ the ~~GitHub user vpavlin~~.		'''KYM''' (Know Your Money) is a household envelope budget by the GitHub user vpavlin that syncs between its users' own devices over [[Logos Messaging]] (Logos Delivery, also called Waku). It has a [[Basecamp]] module for the desktop and an Android app, and the README calls it an alternative to the budgeting app YNAB (You Need A Budget).

	== What it does ==		== What it does ==
	* It keeps a zero-based envelope budget, which gives every unit of income a spending category. ~~The~~ README ~~says~~ it has no server and no cloud custody of the finances~~. The README calls it an alternative to the budgeting app YNAB (You Need A Budget)~~.		* It keeps a zero-based envelope budget, which gives every unit of income a spending category. By the README's account, it has no server and no cloud custody of the finances.
	* It syncs a household's budget directly between its devices over Logos Delivery. The README says the sync is end-to-end encrypted.		* It syncs a household's budget directly between its devices over Logos Delivery. The README says the sync is end-to-end encrypted.
	* It holds several budgets at once. Each ~~budget~~ is its own household, with its own secret, topic and event log, and is shared by showing its QR code or pairing code.		* It holds several budgets at once. Each is its own household with its own secret, topic and event log, and is shared by showing its QR code or pairing code.
	* It records money as an append-only ledger~~. An~~ edit is a new event and a delete is ~~recorded as~~ a marker event (a tombstone)~~, so two~~ people editing offline end up with the same budget after sync.		* It records money as an append-only ledger, in which an edit is a new event and a delete is a marker event (a tombstone). Two people editing offline therefore end up with the same budget after sync.
	* ~~It runs a~~ desktop view in Basecamp (<code>kym</code>) over a core module (<code>kym_core</code>)~~. The~~ same core can run headless (with no interface) under <code>logoscore</code> as an always-on hub.		* Its desktop view in Basecamp (<code>kym</code>) runs over a core module (<code>kym_core</code>), and the same core can run headless, with no interface, under <code>logoscore</code> as an always-on hub.
	* ~~It has an~~ Android companion app ~~for logging~~ an expense quickly, with on-device ~~receipt~~ OCR ~~(reading the text of a photographed receipt)~~.		* Its Android companion app logs an expense quickly and reads photographed receipts with on-device OCR.
	* It includes a command-line budget with accounts, categories, targets, bank import, reconciliation and reports.		* It includes a command-line budget with accounts, categories, targets, bank import, reconciliation and reports.

	Stage: Almost done. The README's status ends with "Needs real hardware to finish", ~~followed by~~ the phone's receive path and OCR accuracy on real receipts~~. It says the engine, contract, crypto, merge and both module builds "are green and cross-checked"~~. It adds that ~~"The~~ mobile Delivery transport is still being stabilised on real hardware." The README does not say whether it is an official Logos project.		Stage: Almost done. The README's status says the engine, contract, crypto, merge and both module builds "are green and cross-checked". It ends with "Needs real hardware to finish", naming the phone's receive path and OCR accuracy on real receipts. It adds that the mobile Delivery transport is still being stabilised on real hardware. The README does not say whether it is an official Logos project.

	== Use it ==		== Use it ==
Line 31:		Line 31:

	== Build it ==		== Build it ==
	* <code>npm install</code> sets up the packages. <code>npm test</code> runs the engine and sync tests and <code>npm run demo</code> shows two partners editing one budget offline and then syncing.		* <code>npm install</code> sets up the packages. <code>npm test</code> runs the engine and sync tests, and <code>npm run demo</code> shows two partners editing one budget offline and then syncing.
	* The Android APK is built and signed locally with <code>scripts/build-apk.sh</code>.		* The Android APK is built and signed locally with <code>scripts/build-apk.sh</code>.
	* Releases are cut by pushing a <code>module-v*</code> tag. CI ~~then~~ builds the portable <code>.lgx</code> and refreshes <code>repo/index.json</code>. The only tag so far is v0.8.0.		* Releases are cut by pushing a <code>module-v*</code> tag, after which CI builds the portable <code>.lgx</code> and refreshes <code>repo/index.json</code>. The only tag so far is v0.8.0.

	== Releases ==		== Releases ==