cleartrans-cli(1)

πŸ’– cleartrans-cli πŸ’–

ok so bestie, welcome to the General Commands Manual page for cleartrans-cli β€” yes, that manual, and yes, it's about to be cute and correct. we're clearing transactions in a ledger file, interactively, and it's giving main character energy fr fr ✨


✨ NAME ✨

cleartrans-cli β€” interactively clear transactions in a ledger file 🧚


🌸 SYNOPSIS 🌸

cleartrans

like. that's it. that's the whole vibe. πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

cleartrans-cli is a text program for quickly clearing transactions in a ledger file. no cap.

so here's the tea: this program looks for all uncleared transactions in the ledger file whose effective date is not in the future. (future ones? not invited. not today. πŸ™ˆ)

for each one of those transactions, it asks you whether the transaction should be cleared, and then it prompts for an effective date for that transaction.

then the resulting ledger is written to a new file, and atomically renamed to the original filename. this prevents accidental loss of data β€” and honestly? iconic protective behaviour. we love a program that doesn't let you accidentally nuke your ledger. πŸ”₯

⚠️ real talk though: the program must be supplied with the location of the ledger file it's going to work with. no file, no slay.

the location of the file is determined using the following mechanisms, in this order. the first mechanism which yields a result, wins. periodt.


🌈 ENVIRONMENT 🌈

the following environment variable is recognized by this program:

  • LEDGER_FILE β€” path to ledger file to work with. 🫢

πŸŽ€ FILES πŸŽ€

the config file for ledger(1) β€” namely the file .ledgerrc in the user's home directory β€” is scanned looking for the following option:

  • --file FILE β€” path to ledger file to work with. πŸ’–

πŸ‘‘ SEE ALSO πŸ‘‘

go read these too, bestie, they're the whole friend group:


and that's the page!! πŸŽ‰ this was cleartrans-cli(1) from the General Commands Manual, dated November 11 2022. mwah. go clear some transactions, you got this πŸ’œβœ¨

πŸ“¦ where this page comes from