lunchable CLI#

lunchable --help

Usage: lunchable [OPTIONS] COMMAND [ARGS]...

  Interactions with Lunch Money via lunchable 🍱

Options:
  --version             Show the version and exit.
  --access-token TEXT   LunchMoney Developer API Access Token
  --debug / --no-debug  Enable extra debugging output
  --help                Show this message and exit.

Commands:
  http          Interact with the LunchMoney API
  plugins       Interact with Lunchable Plugins
  transactions  Interact with Lunch Money transactions

lunchable#

Interactions with Lunch Money via lunchable 🍱

Usage:

lunchable [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--version`	boolean	Show the version and exit.	`False`
`--access-token`	text	LunchMoney Developer API Access Token	None
`--debug` / `--no-debug`	boolean	Enable extra debugging output	`False`
`--help`	boolean	Show this message and exit.	`False`

Subcommands

http:
plugins:
transactions:

lunchable http#

Interact with the LunchMoney API

lunchable http /v1/transactions

Usage:

lunchable http [OPTIONS] URL

Options:

Name	Type	Description	Default
`-X`, `--request`	text	Specify request command to use	`GET`
`-d`, `--data`	text	HTTP POST data	None
`--help`	boolean	Show this message and exit.	`False`

lunchable plugins#

Interact with Lunchable Plugins

Install lunchable with the "plugins" extra to get all the known plugins

pipx install "lunchable[plugins]"

Usage:

lunchable plugins [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

primelunch:
pushlunch:
splitlunch:

lunchable plugins primelunch#

Update your Amazon LunchMoney transactions

Usage:

lunchable plugins primelunch [OPTIONS]

Options:

Name	Type	Description	Default
`-f`, `--file`	path	File Path of the Amazon Export	_required
`-w`, `--window`	integer	Allowable time window between Amazon transaction date and credit card transaction date	`7`
`-a`, `--all`	boolean	Whether to skip the confirmation step and simply update all matched transactions	`False`
`-t`, `--token`	text	LunchMoney Access Token - defaults to the LUNCHMONEY_ACCESS_TOKEN environment variable	None
`--help`	boolean	Show this message and exit.	`False`

lunchable plugins pushlunch#

Push Notifications for Lunch Money: PushLunch 📲

Usage:

lunchable plugins pushlunch [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

notify:

lunchable plugins pushlunch notify#

Send a Notification for each Uncleared Transaction

Usage:

lunchable plugins pushlunch notify [OPTIONS]

Options:

Name	Type	Description	Default
`--continuous`	boolean	Whether to continuously check for more uncleared transactions, waiting a fixed amount in between checks.	`False`
`--interval`	text	Sleep Interval in Between Tries - only applies if `continuous` is set. Defaults to 60 (minutes). Cannot be less than 5 (minutes)	None
`--user-key`	text	Pushover User Key. Defaults to `PUSHOVER_USER_KEY` env var	None
`--help`	boolean	Show this message and exit.	`False`

lunchable plugins splitlunch#

Splitwise Plugin for lunchable, SplitLunch 💲🍱

Usage:

lunchable plugins splitlunch [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

expenses:
refresh:
splitlunch:
splitlunch-direct-import:
splitlunch-import:
update-balance:

lunchable plugins splitlunch expenses#

Retrieve Splitwise Expenses

Usage:

lunchable plugins splitlunch expenses [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	text	Limit the amount of Results. 0 returns everything.	None
`--offset`	text	Number of expenses to be skipped	None
`--limit`	text	Number of expenses to be returned	None
`--group-id`	text	GroupID of the expenses	None
`--friendship-id`	text	FriendshipID of the expenses	None
`--dated-after`	text	ISO 8601 Date time. Return expenses later that this date	None
`--dated-before`	text	ISO 8601 Date time. Return expenses earlier than this date	None
`--updated-after`	text	ISO 8601 Date time. Return expenses updated after this date	None
`--updated-before`	text	ISO 8601 Date time. Return expenses updated before this date	None
`--help`	boolean	Show this message and exit.	`False`

lunchable plugins splitlunch refresh#

Import New Splitwise Transactions to Lunch Money and

This function gets all transactions from Splitwise, all transactions from your Lunch Money Splitwise account and compares the two. This also updates the account balance.

Usage:

lunchable plugins splitlunch refresh [OPTIONS]

Options:

Name	Type	Description	Default
`--dated-after`	text	ISO 8601 Date time. Return expenses later that this date	None
`--dated-before`	text	ISO 8601 Date time. Return expenses earlier than this date	None
`--allow-self-paid` / `--no-allow-self-paid`	boolean	Allow self-paid expenses to be imported (filtered out by default).	`False`
`--allow-payments` / `--no-allow-payments`	boolean	Allow payments to be imported (filtered out by default).	`False`
`--help`	boolean	Show this message and exit.	`False`

lunchable plugins splitlunch splitlunch#

Split all SplitLunch tagged transactions in half.

One of these new splits will be recategorized to Reimbursement.

Usage:

lunchable plugins splitlunch splitlunch [OPTIONS]

Options:

Name	Type	Description	Default
`--tag-transactions`	boolean	Tag the resulting transactions with a `Splitwise` tag.	`False`
`--help`	boolean	Show this message and exit.	`False`

lunchable plugins splitlunch splitlunch-direct-import#

Import SplitLunchDirectImport tagged transactions to Splitwise

Send a transaction to Splitwise and then split the original transaction in Lunch Money. One of these new splits will be recategorized to Reimbursement. Any tags will be reapplied.

Usage:

lunchable plugins splitlunch splitlunch-direct-import [OPTIONS]

Options:

Name	Type	Description	Default
`--tag-transactions`	boolean	Tag the resulting transactions with a `Splitwise` tag.	`False`
`--financial-partner-id`	integer	Splitwise ID of your financial partner.	None
`--financial-partner-email`	text	Splitwise Email Address of your financial partner.	None
`--financial-partner-group-id`	integer	Splitwise Group ID for financial partner transactions.	None
`--help`	boolean	Show this message and exit.	`False`

lunchable plugins splitlunch splitlunch-import#

Import SplitLunchImport tagged transactions to Splitwise

Send a transaction to Splitwise and then split the original transaction in Lunch Money. One of these new splits will be re-categorized to Reimbursement. Any tags will be reapplied.

Usage:

lunchable plugins splitlunch splitlunch-import [OPTIONS]

Options:

Name	Type	Description	Default
`--tag-transactions`	boolean	Tag the resulting transactions with a `Splitwise` tag.	`False`
`--financial-partner-id`	integer	Splitwise ID of your financial partner.	None
`--financial-partner-email`	text	Splitwise Email Address of your financial partner.	None
`--financial-partner-group-id`	integer	Splitwise Group ID for financial partner transactions.	None
`--help`	boolean	Show this message and exit.	`False`

lunchable plugins splitlunch update-balance#

Update the Splitwise Asset Balance

Usage:

lunchable plugins splitlunch update-balance [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

lunchable transactions#

Interact with Lunch Money transactions

Usage:

lunchable transactions [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

get:

lunchable transactions get#

Retrieve Lunch Money Transactions

Usage:

lunchable transactions get [OPTIONS]

Options:

Name	Type	Description	Default
`--start-date`	text	Denotes the beginning of the time period to fetch transactions for. Defaultsto beginning of current month. Required if end_date exists. Format: YYYY-MM-DD.	None
`--end-date`	text	Denotes the end of the time period you'd like to get transactions for. Defaults to end of current month. Required if start_date exists.Format: YYYY-MM-DD.	None
`--tag-id`	text	Filter by tag. Only accepts IDs, not names.	None
`--recurring-id`	text	Filter by recurring expense	None
`--plaid-account-id`	text	Filter by Plaid account	None
`--category-id`	text	Filter by category. Will also match category groups.	None
`--asset-id`	text	Filter by asset	None
`--group-id`	text	Filter by group_id (if the transaction is part of a specific group)	None
`--is-group`	text	Filter by group (returns transaction groups)	None
`--status`	text	Filter by status (Can be cleared or uncleared. For recurring transactions, use recurring)	None
`--offset`	text	Sets the offset for the records returned	None
`--limit`	text	Sets the maximum number of records to return. Note: The server will not respond with any indication that there are more records to be returned. Please check the response length to determine if you should make another call with an offset to fetch more transactions.	None
`--debit-as-negative`	text	Pass in true if you’d like expenses to be returned as negative amounts and credits as positive amounts. Defaults to false.	None
`--pending`	boolean	Pass in true if you’d like to include imported transactions with a pending status.	None
`--help`	boolean	Show this message and exit.	`False`