Quickstart

From zero to transactions in your terminal in about a minute. This assumes you have already installed the CLI.

1. Log in#

banksync login

Your browser opens the BankSync authorization page. Review the workspace and permissions, then approve access. The CLI validates the resulting OAuth session and saves it encrypted for future commands.

For scripts, CI, and other headless environments, API key authentication is also supported.

Logged in to Acme Inc (profile: default).

2. List your banks#

banksync banks list

On a terminal you get an aligned table with a status column:

ID         NAME             SOURCE    TYPE      STATUSbnk_a1b2   Chase            plaid     personal  ● activebnk_c3d4   Amex             plaid     personal  ● activebnk_e5f6   CommBank         fiskil    personal  ◐ syncing
3 banks · workspace acme

3. Pull transactions#

Reference a bank by its id, or by name (partial names resolve):

banksync transactions list --bank amex

transactions list has a short alias, tx, and accepts a date range:

banksync tx list --bank amex --from 2026-01-01 --to 2026-03-31

4. Pipe to jq#

When stdout is not a terminal, the CLI emits its stable JSON envelope automatically, so pipelines just work with no flag:

banksync tx list --bank amex | jq '.data[] | {date, description, amount}'

You can also ask for JSON explicitly with --json (or -o json):

banksync banks list --json | jq '.data | length'

Where to go next#