https://github.com/yphillip/goodbudget_cli
Command line tools to interact with Goodbudget
https://github.com/yphillip/goodbudget_cli
automation cli finance goodbudget personal-finance selenium-python
Last synced: 3 months ago
JSON representation
Command line tools to interact with Goodbudget
- Host: GitHub
- URL: https://github.com/yphillip/goodbudget_cli
- Owner: yphillip
- License: mit
- Created: 2023-01-18T01:05:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-06T01:44:51.000Z (over 3 years ago)
- Last Synced: 2025-12-15T08:44:25.273Z (6 months ago)
- Topics: automation, cli, finance, goodbudget, personal-finance, selenium-python
- Language: Python
- Homepage:
- Size: 40 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# goodbudget_cli
Command line tool to enter transactions into your [Goodbudget](https://goodbudget.com/) account.
## Installation
### Dependencies
- Selenium Chrome Webdriver ([example of installation instructions](https://cloudbytes.dev/snippets/run-selenium-and-chrome-on-wsl2))
### Install with pipx (or pip)
```
$ pipx install goodbudget-cli
```
### Initialize and edit the configuration file
1. Run `gb` to initially create a `~/.config/goodbudget_cli/config.json` file.
2. Edit the `config.json` file to set the `webdriver_path` to the location of your Chrome webdriver.
3. Edit the `config.json` file to set the `Envelopes` using the name of your Goodbudget envelopes using the format of `{ENVELOPE_NAME: [LIST OF ALIASES]}`.
## Usage
To enter an expense:
```
$ gb {Goodbudget household username or email}
```
To enter income:
```
$ gb {Goodbudget household username or email} --income
```
## Demo
```
$ gb foo@bar.com
Enter your Goodbudget password:
Logging in. Please wait...
Logged in.
Date of transaction (today / yesterday / mm/dd/yyyy): today
Payee: QFC
Amount: 40
Envelope (or type in 'remind'): groceries
Notes (optional):
Summary of your expense:
Date: 01/28/2023
Payee: QFC
Amount: $40
Envelope: Groceries (based on your alias of 'groceries')
Notes:
Is everything correct? (Y/n) Y
Entering expense. Please wait...
Success! Your transaction was entered into Goodbudget.
Do you want to enter another transaction? (Y/n) n
Thank you for using goodbudget_cli! See you next time!
```