BankSync

CLI reference

JSON manifest

BankSync CLI v0.1.1 exposes 52 commands. This reference is generated from the shipped oclif manifest, so command names, arguments, flags, and examples remain synchronized with the executable.

accounts

banksync accounts getGet a single account, resolving names or partial ids.

Arguments

  • bidrequiredBank id or name.
  • aidrequiredAccount id or name.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync accounts get bnk_123 acc_456
banksync accounts get Chase Checking
banksync accounts listList accounts within a bank connection, resolving a name or partial id.

Arguments

  • bidrequiredBank id or name.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync accounts list bnk_123
banksync accounts list Chase

general

banksync apiCall any BankSync API endpoint directly. A raw escape hatch for endpoints without a dedicated command.

Arguments

  • methodrequiredHTTP method (e.g. GET, POST, PUT, DELETE).
  • pathrequiredAPI path (e.g. /v1/banks).

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --data, -dRequest body: inline JSON, or @file, or - for stdin.
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --queryQuery param k=v (repeatable).
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync api GET /v1/banks
banksync api GET /v1/feeds --query dataType=transactions
banksync api POST /v1/enrichments --data @enrichment.json
echo '{"name":"..."}' | banksync api POST /v1/enrichments --data -
banksync commandsList all commands as a machine-readable catalog (for agents and scripts).

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync commands --json
banksync commands
banksync openOpen the BankSync web app in your browser.

Arguments

  • targetWhat to open.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync open
banksync open banks
banksync schemaDescribe entity fields and default columns (the --fields surface).

Arguments

  • entityEntity name (e.g. transaction, bank, feed).

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync schema
banksync schema transaction --json
banksync statusOne-screen overview: workspace, plan, banks, and feeds.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync status
banksync updateUpdate the CLI to the latest version by replacing the standalone binary in place.

Flags

  • --allow-downgradeWith --force, permit installing an older version than the current one.
  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --checkReport whether a newer version exists without installing it.
  • --forceReinstall the latest build even if already up to date.
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync update
banksync update --check
banksync update --force

apps

banksync apps installOpen the hosted consent screen to install an app. Installing requires a person to approve it.

Arguments

  • slugrequiredApp slug, as it appears in the directory URL.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync apps install acme-budget
banksync apps install acme-budget --no-input

auth

banksync auth loginAuthenticate the CLI. With no flags, opens a browser for OAuth sign-in. Pass --api-key (or set BANKSYNC_API_KEY) to use an API key instead.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-browserPrint the authorization URL instead of opening a browser (for SSH/headless).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --scopeComma-separated OAuth scopes for an explicit least-privilege login or re-consent.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync login
banksync login --api-key bsk_...
banksync login --no-browser
banksync login --scope tables:read
banksync auth logoutRemove the stored credential for the current profile.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync logout
banksync logout --profile staging
banksync auth whoamiShow the current credential, workspace, plan, and scopes.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync auth whoami
banksync auth whoami --json

balances

banksync balances getGet the live balance for an account, resolving names or partial ids.

Arguments

  • bidrequiredBank id or name.
  • aidrequiredAccount id or name.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync balances get bnk_123 acc_456
banksync balances get Chase Checking

banks

banksync banks brandsSearch banks. One row per bank, with the way we recommend connecting it.

Arguments

  • queryrequiredBank name, alias, routing number or web address.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --marketISO country code, e.g. US, AU. Banks are market-scoped.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync banks brands chase
banksync banks brands "commonwealth" --market AU
banksync banks brands chase -o json
banksync banks connectConnect a new bank via the web app, then wait for it to appear.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --institutionPre-select an institution id.
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --providerPre-select a provider (e.g. plaid, snaptrade, saltedge, fiskil).
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync banks connect
banksync banks connect --provider plaid
banksync banks connect --institution ins_123
banksync banks deleteRemove a bank connection and stop syncing its data, resolving a name or partial id.

Arguments

  • bidrequiredBank id or name.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --permanentRemove the bank for good: revoke it at the provider, destroy every row derived from it, and delete it now instead of at the next monthly cleanup. Cannot be undone. Requires the admin or owner role.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).
  • --yesSkip confirmation prompts.

Examples

banksync banks delete bnk_123
banksync banks delete Chase --yes
banksync banks delete Chase --permanent
banksync banks getGet a single bank connection, resolving a name or partial id.

Arguments

  • bidrequiredBank id or name.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync banks get bnk_123
banksync banks get Chase
banksync banks listList bank connections in the current workspace.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --scopeself | familyResource scope. `family` includes banks from every portal (admin+ only).
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync banks list
banksync banks list --scope family
banksync banks list -o json
banksync banks reauthReauthenticate a bank connection in the web app, resolving a name or partial id.

Arguments

  • bidrequiredBank id or name.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync banks reauth bnk_123
banksync banks reauth Chase
banksync banks searchSearch the institution catalog for connectable banks.

Arguments

  • queryrequiredInstitution name or keyword to search for.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --countryISO country code, e.g. US, AU.
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --providerproviderInstanceId, e.g. plaid:us.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync banks search chase
banksync banks search "commonwealth" --country AU
banksync banks search chase --provider plaid:us -o json

config

banksync config getGet a config value for the current profile.

Arguments

  • keyrequiredConfig key.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync config get output
banksync config listList config values for the current profile.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync config list
banksync config setSet a config value for the current profile. Keys: output, locale, tz, color, telemetry. The API environment cannot be changed.

Arguments

  • keyrequiredConfig key.
  • valuerequiredConfig value.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync config set output json
banksync config set telemetry off
banksync config unsetRemove a config value for the current profile, reverting it to the default. Keys: output, locale, tz, color, telemetry.

Arguments

  • keyrequiredConfig key.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync config unset output
banksync config unset tz

enrichments

banksync enrichments createCreate an enrichment from a JSON file. The body sets the type (any of the 16: rule, lookup, filter, split, transfer_match, dedupe, alert, monitor, budget, recurring, fees, anomaly, digest, memory, ai_categorize, ai_merchant) and its matching config block.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --file, -fJSON file with the enrichment body (type + its config block).
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync enrichments create --file rule.json
banksync enrichments create -f alert.json
banksync enrichments deleteDelete an enrichment. This cannot be undone.

Arguments

  • eidrequiredEnrichment id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).
  • --yesSkip confirmation prompts.

Examples

banksync enrichments delete enr_123
banksync enrichments delete enr_123 --yes
banksync enrichments getGet a single enrichment by id.

Arguments

  • eidrequiredEnrichment id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync enrichments get enr_123
banksync enrichments listList enrichment rules, alerts, and memory configs in the workspace.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync enrichments list
banksync enrichments list --json
banksync enrichments previewPreview enrichment output for a feed against sample records without persisting anything.

Arguments

  • fidrequiredFeed id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --records, -rJSON file with an array of sample records (1-50).
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync enrichments preview fed_123 --records samples.json
banksync enrichments updateUpdate an enrichment from a JSON file with the fields to change.

Arguments

  • eidrequiredEnrichment id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --file, -fJSON file with the enrichment fields to update.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync enrichments update enr_123 --file patch.json

feeds

banksync feeds createCreate a feed. Provide the full body via --file, or the essentials via --name/--source/--data-type.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --data-typeFinancial data type this feed produces, e.g. transactions.
  • --fieldsComma-separated columns (dot-paths) to display.
  • --file, -fPath to a JSON file with the full feed body.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --nameHuman-readable feed name.
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --sourcesync | extractor | uploadData source: sync (bank API), extractor (email/PDF), or upload (file).
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync feeds create --file feed.json
banksync feeds create --name "ANZ → Notion" --source sync --data-type transactions
banksync feeds deleteDelete a feed.

Arguments

  • fidrequiredFeed id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).
  • --yesSkip confirmation prompts.

Examples

banksync feeds delete fed_123 --yes
banksync feeds getGet a single feed.

Arguments

  • fidrequiredFeed id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync feeds get fed_123
banksync feeds learnTrigger a Memory enrichment learn cycle for a feed.

Arguments

  • fidrequiredFeed id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync feeds learn fed_123
banksync feeds listList feeds in the current workspace.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --scopeself | familyResource scope. `family` includes feeds from every portal (admin+ only).
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync feeds list
banksync feeds list --scope family
banksync feeds list -o json
banksync feeds syncTrigger a sync for a feed. Fire-and-forget by default; pass --watch to poll to completion.

Arguments

  • fidrequiredFeed id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --forceCancel any running sync first.
  • --fromStart date (YYYY-MM-DD) for a date-range sync.
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --reset-cursorsClear cursors and dedup state before fetching (full re-sync).
  • --skip-dedupBypass the per-record dedup guard for this run (backfills).
  • --toEnd date (YYYY-MM-DD) for a date-range sync.
  • --verboseLog requests to stderr (secrets redacted).
  • --watchPoll the job until it finishes, showing live progress.

Examples

banksync feeds sync fed_123
banksync feeds sync fed_123 --from 2026-01-01 --to 2026-03-31
banksync feeds sync fed_123 --force --watch
banksync feeds updateUpdate a feed from a JSON body.

Arguments

  • fidrequiredFeed id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --file, -fPath to a JSON file with the update body.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync feeds update fed_123 --file update.json

holdings

banksync holdings listList current investment holdings for an account, resolving names or partial ids.

Arguments

  • bidrequiredBank id or name.
  • aidrequiredAccount id or name.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync holdings list bnk_123 acc_456
banksync holdings list Coinbase "USD Wallet"

integrations

banksync integrations deleteRemove an integration from the workspace. This cannot be undone.

Arguments

  • iidrequiredIntegration id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).
  • --yesSkip confirmation prompts.

Examples

banksync integrations delete int_123
banksync integrations delete int_123 --yes
banksync integrations listList destination integrations connected to the workspace.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --scopeself | familyScope: self (this workspace) or family (every portal under it; admin+ only).
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync integrations list
banksync integrations list --scope family

jobs

banksync jobs cancelCancel a created or in-progress sync job, releasing the feed lock.

Arguments

  • fidrequiredFeed id.
  • jidrequiredJob id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).
  • --yesSkip confirmation prompts.

Examples

banksync jobs cancel fed_123 job_456 --yes
banksync jobs getGet a sync job, optionally polling until it finishes.

Arguments

  • fidrequiredFeed id.
  • jidrequiredJob id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).
  • --watchPoll until the job reaches a terminal state.

Examples

banksync jobs get fed_123 job_456
banksync jobs get fed_123 job_456 --watch
banksync jobs listList sync jobs for a feed.

Arguments

  • fidrequiredFeed id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --limitMaximum number of jobs to return (default 20).
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --statusFilter by job status (created, in_progress, paused, completed, failed, cancelled).
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync jobs list fed_123
banksync jobs list fed_123 --status failed --limit 5

loan

banksync loan getGet loan or liability details for an account, resolving names or partial ids.

Arguments

  • bidrequiredBank id or name.
  • aidrequiredAccount id or name.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync loan get bnk_123 acc_456
banksync loan get Chase Mortgage

orders

banksync orders listList open and pending orders for an account, resolving names or partial ids.

Arguments

  • bidrequiredBank id or name.
  • aidrequiredAccount id or name.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync orders list bnk_123 acc_456
banksync orders list Coinbase "USD Wallet"

tables

banksync tables createCreate a Table from a JSON request document.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --file, -fPath to the JSON Table creation body.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync tables create --file table.json
banksync tables deleteMove a Table to trash; it can be restored.

Arguments

  • tableIdrequiredTable id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --jsonShorthand for --output json.
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --verboseLog requests to stderr (secrets redacted).
  • --yesSkip confirmation prompts.

Examples

banksync tables delete tbl_123
banksync tables delete tbl_123 --yes
banksync tables getGet a Table by id.

Arguments

  • tableIdrequiredTable id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync tables get tbl_123
banksync tables listList Tables in the current workspace.

Flags

  • --allFetch all pages (follows the cursor).
  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --cursorResume from a pagination cursor.
  • --fieldsComma-separated columns (dot-paths) to display.
  • --jsonShorthand for --output json.
  • --limitMaximum number of items to return.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --page-sizeItems per API page.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync tables list
banksync tables list --all --page-size 100
banksync tables list -o json
banksync tables queryQuery Table rows using a JSON query document.

Arguments

  • tableIdrequiredTable id.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --file, -fPath to the JSON row-query body.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync tables query tbl_123 --file query.json
banksync tables query tbl_123 --file query.json -o json

trades

banksync trades listList investment trades for an account, resolving names or partial ids.

Arguments

  • bidrequiredBank id or name.
  • aidrequiredAccount id or name.

Flags

  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --fieldsComma-separated columns (dot-paths) to display.
  • --fromStart date (YYYY-MM-DD). Defaults to the last 90 days.
  • --jsonShorthand for --output json.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --toEnd date (YYYY-MM-DD). Defaults to today.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync trades list bnk_123 acc_456
banksync trades list Coinbase BTC --from 2026-01-01 --to 2026-03-31

transactions

banksync transactions listList transactions for a bank or a single account, resolving names or partial ids.

Arguments

  • bidBank id or name.
  • aidAccount id or name.

Flags

  • --accountAccount name or id.
  • --allFetch all pages (follows the cursor).
  • --api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).
  • --bankBank name or id (alternative to the positional bid).
  • --cursorResume from a pagination cursor.
  • --fieldsComma-separated columns (dot-paths) to display.
  • --fromStart date YYYY-MM-DD.
  • --jsonShorthand for --output json.
  • --limitMaximum number of items to return.
  • --localeLocale for number formatting (e.g. en-US).
  • --max-retriesMax automatic retries on 429/network errors (GETs only).
  • --no-colorDisable colored output.
  • --no-inputNever prompt; fail if a required value is missing.
  • --no-retryDisable automatic retries.
  • --no-truncateDo not truncate wide columns.
  • --output, -otable | json | ndjson | csv | yaml | toonOutput format.
  • --page-sizeItems per API page.
  • --profileConfig profile to use.
  • --quiet, -qSuppress spinners and notices; data only.
  • --sortSort by field(s); prefix with - for descending.
  • --toEnd date YYYY-MM-DD.
  • --tzIANA time zone for timestamps (e.g. Australia/Sydney).
  • --utcRender timestamps in UTC.
  • --verboseLog requests to stderr (secrets redacted).

Examples

banksync transactions list bnk_123
banksync tx list bnk_123 acc_456 --from 2026-01-01 --to 2026-03-31
banksync tx list --bank Chase --account Checking
banksync tx list bnk_123 acc_456 --all