ledger: update
This commit is contained in:
Rico Sta. Cruz
parent
d9c8e5e7d2
commit
5ee9a0793f
|
|
@ -54,6 +54,7 @@ a:hover {
|
|||
color: $base-b3;
|
||||
}
|
||||
|
||||
[aria-hidden] {
|
||||
/* prism.js adds area-hidden which it probably shouldn't */
|
||||
[aria-hidden]:not(.line-highlight) {
|
||||
display: none !important;
|
||||
}
|
||||
|
|
|
|||
324
ledger.md
324
ledger.md
|
|
@ -1,111 +1,168 @@
|
|||
---
|
||||
title: Ledger CLI
|
||||
category: Ledger
|
||||
layout: 2017/sheet
|
||||
updated: 201708
|
||||
---
|
||||
|
||||
$ ledger bal
|
||||
$ ledger reg
|
||||
### Basic usage
|
||||
|
||||
$ ledger reg grocery # show entries for grocery
|
||||
$ ledger bal assets # check if im broke
|
||||
```bash
|
||||
$ ledger bal
|
||||
$ ledger reg
|
||||
```
|
||||
|
||||
-b 01/01 # --begin
|
||||
-e 01/31 # --end
|
||||
-S date # --sort
|
||||
-S amount
|
||||
```bash
|
||||
$ ledger reg grocery # show entries for grocery
|
||||
$ ledger bal assets # check if im broke
|
||||
```
|
||||
|
||||
```bash
|
||||
-b 01/01 # --begin
|
||||
-e 01/31 # --end
|
||||
-S date # --sort
|
||||
-S amount
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
# any/all matches
|
||||
ledger bal Rent Transportation # any
|
||||
ledger bal Income and Job # all
|
||||
ledger bal Expenses and not (Drinks or Food)
|
||||
```bash
|
||||
# any/all matches
|
||||
ledger bal Rent Transportation # any
|
||||
ledger bal Income and Job # all
|
||||
ledger bal Expenses and not (Drinks or Food)
|
||||
```
|
||||
|
||||
# what did I spend on most? (--sorted)
|
||||
ledger reg Expenses -S amount
|
||||
```bash
|
||||
# what did I spend on most? (--sorted)
|
||||
ledger reg Expenses -S amount
|
||||
```
|
||||
|
||||
# how much did I have at this date? (--end)
|
||||
ledger bal -e 01/15 ^Assets ^Liabilities
|
||||
```bash
|
||||
# how much did I have at this date? (--end)
|
||||
ledger bal -e 01/15 ^Assets ^Liabilities
|
||||
```
|
||||
|
||||
# how much did I spend and earn this month?
|
||||
ledger bal ^Expenses ^Income --invert
|
||||
# how much was spent over the course of 3 days? (totalled)
|
||||
ledger reg -b 01/25 -e 01/27 --subtotal
|
||||
ledger reg -b 01/25 -e 01/27 --subtotal grocery
|
||||
```bash
|
||||
# how much did I spend and earn this month?
|
||||
ledger bal ^Expenses ^Income --invert
|
||||
```
|
||||
|
||||
```bash
|
||||
# how much was spent over the course of 3 days? (totalled)
|
||||
ledger reg -b 01/25 -e 01/27 --subtotal
|
||||
ledger reg -b 01/25 -e 01/27 --subtotal grocery
|
||||
```
|
||||
|
||||
Format
|
||||
------
|
||||
|
||||
2013/01/03 * Rent for January
|
||||
Expenses:Rent $600.00
|
||||
Assets:Savings
|
||||
### Basic format
|
||||
|
||||
* = cleared
|
||||
! = pending
|
||||
```
|
||||
2013/01/03 * Rent for January
|
||||
Expenses:Rent $600.00
|
||||
Assets:Savings
|
||||
```
|
||||
|
||||
`*` = cleared, `!` = pending
|
||||
|
||||
### Secondary dates
|
||||
|
||||
2008/01/01=2008/01/14 Client invoice ; estimated date you'll be paid
|
||||
```
|
||||
2008/01/01=2008/01/14 Client invoice
|
||||
```
|
||||
|
||||
It can mean anything you want, eg, for the estimated date you'll be paid.
|
||||
|
||||
### Balance assertions
|
||||
|
||||
2008/01/01 * KFC
|
||||
Expenses:Food $20
|
||||
Assets:Cash $-20 = $500 ; ensures cash is at $500
|
||||
```
|
||||
2008/01/01 * KFC
|
||||
Expenses:Food $20
|
||||
Assets:Cash $-20 = $500
|
||||
```
|
||||
{: data-line="3"}
|
||||
|
||||
`Cash $X = $500` ensures Cash is at $500 after the transaction.
|
||||
|
||||
### Balance assignment
|
||||
|
||||
2008/01/01 * Cash balance
|
||||
Assets:Cash = $500
|
||||
Equity:Adjustments
|
||||
```bash
|
||||
2008/01/01 * Cash balance
|
||||
Assets:Cash = $500
|
||||
Equity:Adjustments
|
||||
|
||||
2008/01/01 * KFC
|
||||
Expenses:Food $20
|
||||
Assets:Cash = $500 ; figures out what's needed to make it $500
|
||||
2008/01/01 * KFC
|
||||
Expenses:Food $20
|
||||
Assets:Cash = $500
|
||||
```
|
||||
{: data-line="2,7"}
|
||||
|
||||
`ACCOUNT = $500` figures out what's needed to make it $500.
|
||||
|
||||
### Payables
|
||||
|
||||
2008/04/25 * Rent
|
||||
(Assets:Checking) -$200
|
||||
Expenses:Rent
|
||||
```bash
|
||||
2008/04/25 * Rent
|
||||
(Assets:Checking) -$200
|
||||
Expenses:Rent
|
||||
```
|
||||
{: data-line="2"}
|
||||
|
||||
### Commodities
|
||||
|
||||
; cost per item
|
||||
2010/05/31 * Market
|
||||
Assets:Fridge 35 apples @ $0.42
|
||||
Assets:Cash
|
||||
```bash
|
||||
; cost per item
|
||||
2010/05/31 * Market
|
||||
Assets:Fridge 35 apples @ $0.42
|
||||
Assets:Cash
|
||||
```
|
||||
{: data-line="3"}
|
||||
|
||||
; total cost
|
||||
2010/05/31 * Market
|
||||
Assets:Fridge 35 apples @@ $14.70
|
||||
Assets:Cash
|
||||
```bash
|
||||
; total cost
|
||||
2010/05/31 * Market
|
||||
Assets:Fridge 35 apples @@ $14.70
|
||||
Assets:Cash
|
||||
```
|
||||
{: data-line="3"}
|
||||
|
||||
; fixed lot prices
|
||||
2010/05/31 * Gas
|
||||
Expenses:Gasoline 11 GAL {=$2.299}
|
||||
Assets:Cash
|
||||
```bash
|
||||
; fixed lot prices
|
||||
2010/05/31 * Gas
|
||||
Expenses:Gasoline 11 GAL {=$2.299}
|
||||
Assets:Cash
|
||||
```
|
||||
{: data-line="3"}
|
||||
|
||||
### Commodity definitions
|
||||
|
||||
commodity $
|
||||
note American Dollars
|
||||
format $1,000.00
|
||||
nomarket
|
||||
default
|
||||
```
|
||||
commodity $
|
||||
note American Dollars
|
||||
format $1,000.00
|
||||
nomarket
|
||||
default
|
||||
```
|
||||
|
||||
### Budgeting
|
||||
|
||||
~ Monthly
|
||||
Expenses:Rent $500
|
||||
Expenses:Food $100
|
||||
Expenses $40 ; everything else
|
||||
Assets
|
||||
```
|
||||
~ Monthly
|
||||
Expenses:Rent $500
|
||||
Expenses:Food $100
|
||||
Expenses $40 ; everything else
|
||||
Assets
|
||||
|
||||
~ Yearly
|
||||
~ Yearly
|
||||
```
|
||||
|
||||
; ledger bal --budget Expenses
|
||||
; ledger bal --unbudgeted Expenses
|
||||
```bash
|
||||
ledger bal --budget Expenses
|
||||
ledger bal --unbudgeted Expenses
|
||||
```
|
||||
{: .-setup}
|
||||
|
||||
### Comments
|
||||
|
||||
|
|
@ -115,56 +172,82 @@ Format
|
|||
| also line comment
|
||||
* also line comment
|
||||
|
||||
Querying
|
||||
--------
|
||||
|
||||
### Periods
|
||||
|
||||
[interval] [begin] [end]
|
||||
```
|
||||
[interval] [begin] [end]
|
||||
```
|
||||
|
||||
interval:
|
||||
every day|week|month|quarter|year
|
||||
every N days|weeks|...
|
||||
daily|weekly|...
|
||||
begin:
|
||||
from <spec>
|
||||
end:
|
||||
to <spec>
|
||||
spec:
|
||||
2004
|
||||
2004/10/1
|
||||
```
|
||||
interval:
|
||||
every day|week|month|quarter|year
|
||||
every N days|weeks|...
|
||||
daily|weekly|...
|
||||
```
|
||||
|
||||
$ ledger bal|reg --period "until aug"
|
||||
$ ledger bal|reg --period "last oct"
|
||||
$ ledger bal|reg --period "every week"
|
||||
```
|
||||
begin:
|
||||
from <spec>
|
||||
end:
|
||||
to <spec>
|
||||
```
|
||||
|
||||
```
|
||||
spec:
|
||||
2004
|
||||
2004/10/1
|
||||
```
|
||||
|
||||
```bash
|
||||
$ ledger bal|reg --period "until aug"
|
||||
$ ledger bal|reg --period "last oct"
|
||||
$ ledger bal|reg --period "every week"
|
||||
```
|
||||
{: .-setup}
|
||||
|
||||
### Register
|
||||
|
||||
$ ledger reg
|
||||
-D, --daily
|
||||
-W, --weekly
|
||||
-M, --monthly
|
||||
--quarterly
|
||||
-Y, --yearly
|
||||
-s, --subtotal
|
||||
--start-of-week monday
|
||||
```bash
|
||||
$ ledger reg
|
||||
```
|
||||
{: .-setup}
|
||||
|
||||
-S, --sort date
|
||||
-S, --sort amount
|
||||
```bash
|
||||
-D, --daily
|
||||
-W, --weekly
|
||||
-M, --monthly
|
||||
--quarterly
|
||||
-Y, --yearly
|
||||
-s, --subtotal
|
||||
--start-of-week monday
|
||||
```
|
||||
|
||||
```bash
|
||||
-S, --sort date
|
||||
-S, --sort amount
|
||||
```
|
||||
|
||||
### Filters
|
||||
|
||||
-b, --begin DATE
|
||||
-e, --end DATE
|
||||
```bash
|
||||
-b, --begin DATE
|
||||
-e, --end DATE
|
||||
|
||||
-d payee =~ /pioneer/
|
||||
-d payee =~ /pioneer/
|
||||
|
||||
-C, --cleared # (with *)
|
||||
-U, --uncleared # (no *)
|
||||
--pending # (with !)
|
||||
-C, --cleared # (with *)
|
||||
-U, --uncleared # (no *)
|
||||
--pending # (with !)
|
||||
|
||||
-R, --real # ignore virtual postings (eg: "(Cash) $-400")
|
||||
-L, --actual # no automated postings (eg: "= /^Income/")
|
||||
-R, --real # ignore virtual postings (eg: "(Cash) $-400")
|
||||
-L, --actual # no automated postings (eg: "= /^Income/")
|
||||
|
||||
-r, --related # show the other side
|
||||
# "reg -r savings" shows where it comes from)
|
||||
-r, --related # show the other side
|
||||
# "reg -r savings" shows where it comes from)
|
||||
```
|
||||
|
||||
### Queries
|
||||
|
||||
|
|
@ -185,27 +268,36 @@ Example:
|
|||
|
||||
### Display
|
||||
|
||||
-n, --collapse # [register] collapse entries
|
||||
# [balance] no grand total
|
||||
-s, --subtotal # [balance] show sub-accounts
|
||||
# [other] show subtotals
|
||||
--flat
|
||||
```bash
|
||||
-n, --collapse # [register] collapse entries
|
||||
# [balance] no grand total
|
||||
-s, --subtotal # [balance] show sub-accounts
|
||||
# [other] show subtotals
|
||||
--flat
|
||||
```
|
||||
|
||||
### Effective dates
|
||||
|
||||
Say you're in business. If you bill a customer, you can enter something like
|
||||
```bash
|
||||
2008/01/01=2008/01/14 Client invoice ; estimated date you'll be paid
|
||||
Assets:Accounts Receivable $100.00
|
||||
Income: Client name
|
||||
```
|
||||
{: data-line="1"}
|
||||
|
||||
2008/01/01=2008/01/14 Client invoice ; estimated date you'll be paid
|
||||
Assets:Accounts Receivable $100.00
|
||||
Income: Client name
|
||||
Say you're in business. If you bill a customer, you can enter something like above.
|
||||
Then, when you receive the payment, you change it to:
|
||||
|
||||
Then, when you receive the payment, you change it to
|
||||
```bash
|
||||
2008/01/01=2008/01/15 Client invoice ; actual date money received
|
||||
Assets:Accounts Receivable $100.00
|
||||
Income: Client name
|
||||
```
|
||||
{: data-line="1"}
|
||||
|
||||
2008/01/01=2008/01/15 Client invoice ; actual date money received
|
||||
Assets:Accounts Receivable $100.00
|
||||
Income: Client name
|
||||
## References
|
||||
{: .-one-column}
|
||||
|
||||
### See
|
||||
|
||||
* http://ledger-cli.org/3.0/doc/ledger3.html
|
||||
* https://gist.github.com/agaviria/3317397
|
||||
* <http://ledger-cli.org/3.0/doc/ledger3.html>
|
||||
* <https://gist.github.com/agaviria/3317397>
|
||||
{: .-also-see}
|
||||
|
|
|
|||
Loading…
Reference in New Issue