Ldgr is a command-line tool for adding, sorting and tagging transactions in your Ledger file. It's rather opinionated in that it requires you to break down your Ledger file into multiple files.
~/.config/ledger/ -> ledger.dat -> setup.dat -> transactions.dat -> accounts.dat -> commodities.dat -> budgets.dat -> aliases.dat
ldgr can't handle all the text manipulation of transactions unless it can expect the text in the file to be just transaction data. This may be addressed in the future, but for now, please ahere to this file structure. I think you'll find it works well. You can use the include directive in Ledger files to add everything into the ledger.dat file.
For maximum compatibility,
alias ledger="ledger --init-file ~/.config/ledger/ledgerrc", where the RC file contains frequently used command-line options.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install ldgr
- The CLI defaults the currency to $.
- The CLI defaults the equity to Cash.
--- :currency: ¥ :equity: My Sweet Cash Pile
**Use symbols in YAML file.
ldgr add --payee Brandon \ --amount 1000 \ --account Something \ --equity Cash \ --date 2017-02-01 \ --effective 2017-02-03 \ --cleared \ --currency ¥ ldgr clear ldgr sort ldgr tag
transaction = Ldgr::Transaction.new do |t| t.payee = 'Brandon' t.amount = '1000' t.account = 'Something' t.equity = 'Cash' t.date = Date.today + 1 t.effective = Date.today + 10 t.cleared = true t.currency = '¥' end
Ledger works with plain text files, so yes, the amount attribute should be a string.
After checking out the repo, run
bin/setup to install dependencies. Then, run
rake test to run the tests. You can also run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version number in
version.rb, and then run
bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the
.gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/brandonpittman/ldgr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.