Skip to content

Hbbb/budgeted

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Budgeted

A command line tool to import budget data into Google Sheets.

Getting Started

To start using budgeted, you'll need a few things:

  1. A Plaid Developer Account
  2. A Google Sheets Account
  3. An existing spreadsheet with at least the required raw data sheet in the first position of the workbook.

Setting up the Sheet

Budgeted is opinionated about the way it writes data to the spreadsheet. The idea is that you create a sheet that budgeted will write raw transaction data to, but isn't useful to humans. Then, you can create additional sheets with different views of the data, visualizations, pivot tables to map account IDs to human-readable strings, etc.

The headers for the raw sheet should look like this:

Transaction ID	Account ID	Date	Name  Amount	City

It is important that the raw data sheet is in the first position in the workbook!

Commands

bdgt config

Configure Plaid API keys and Google Spreadsheet ID

Synopsis

Find your Plaid API keys and secrets here: https://dashboard.plaid.com/overview/development Find your spreadsheet ID in the URL of your Google Sheet e.g. https://docs.google.com/spreadsheets/d/<SPREADSHEET_ID>/

bdgt config [flags]

Options

  -h, --help   help for config

bdgt serve

start a local webserver that hosts the Plaid authentication UI

Synopsis

start a local webserver that hosts the Plaid authentication UI

bdgt serve [flags]

Options

  -h, --help   help for serve

bdgt add

adds bank to manifest for transaction fetching

Synopsis

adds bank to manifest for transaction fetching

bdgt add [bankName] [publicToken] [flags]

Options

  -h, --help   help for add

bdgt remove

removes bank from manifest

Synopsis

removes bank from manifest

bdgt remove [bankName] [flags]

Options

  -h, --help   help for remove

bdgt fetch

Fetch transactions

Synopsis

Fetch transactions

bdgt fetch [flags]

Options

      --end string      end date formatted YYYY-MM-DD (default "2020-03-07")
  -h, --help            help for fetch
  -o, --output string   output file path
      --start string    start date formatted YYYY-MM-DD (default "2020-03-06")

bdgt write

write the contents of a JSON file of transaction data to a Google Sheet

Synopsis

write the contents of a JSON file of transaction data to a Google Sheet

bdgt write [flags]

Options

  -f, --file string             filepath to transaction data; generate the file by writing the output of the fetch command to a file
  -h, --help                    help for write
      --spreadsheet-id string   the ID of spreadsheet to write transaction data to; defaults to preconfigured spreadsheet id

bdgt import

writes transactions directly to a Google Sheet

Synopsis

writes transactions directly to a Google Sheet

bdgt import [flags]

Options

      --end string              end date formatted YYYY-MM-DD (default "2020-03-07")
  -h, --help                    help for import
  -s, --spreadsheet-id string   the ID of spreadsheet to write transaction data to; defaults to SPREADSHEET_ID env var
      --start string            start date formatted YYYY-MM-DD (default "2020-03-06")

SEE ALSO

  • bdgt - Bdgt is a tool to pull your bank transactions into a Google Spreadsheet
Auto generated by spf13/cobra on 6-Mar-2020