CLI reference
JSON manifestBankSync CLI v0.1.1 exposes 131 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 Checkingbanksync 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 Chasegeneral
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 commandsbanksync 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 banksbanksync 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 --jsonbanksync 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 statusbanksync 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 --forceapps
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-inputauth
banksync auth loginAuthenticate the CLI. With no flags, opens a browser for OAuth sign-in. Pass --device to sign in by approving a code from any browser (SSH, containers), or --api-key (or set BANKSYNC_API_KEY) to use an API key.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--automation-outputsAlso ask to read what automation runs produced (customer content, audited). Not part of the default login.--deviceSign in by typing a short code into BankSync in any browser where you are signed in (OAuth device authorization, RFC 8628). For SSH sessions, containers and machines without a browser. You pick the workspace when you approve; the result is the same scoped, revocable sign-in as `banksync login`.--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 --device
banksync login --device --scope transactions:read
banksync login --scope tables:read
banksync login --automation-outputsbanksync 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 stagingbanksync 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 --jsonautomations
banksync automations activateRegister the active revision’s triggers. A webhook’s URL is printed once, here — store it; activating again keeps it (automations webhooks rotate mints a new one). Runs need the grant approved by a member in the app.
Arguments
automationIdrequiredAutomation 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 automations activate wf_123
banksync automations activate wf_123 -o jsonbanksync automations approvals getRead one approval: who may decide it, how many must, and the decisions so far.
Arguments
approvalIdrequiredApproval 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 automations approvals get apr_123banksync automations approvals listList approval gates, newest first: of one run, or those waiting for a decision. Deciding one is a person’s act in the app.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--automationOnly the approvals of this automation.--cursorThe next-page cursor a previous page printed.--fieldsComma-separated columns (dot-paths) to display.--jsonShorthand for --output json.--limitApprovals to return (1–100).--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.--runOnly the approvals of this run.--sortSort by field(s); prefix with - for descending.--statuspending | approved | rejected | expired | supersededOnly approvals in this state.--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).
Examples
banksync automations approvals list --status pending
banksync automations approvals list --run run_123banksync automations bindPoint a declared binding at a resource of this workspace — a table, a view, a bank, a feed, a connection or another automation.
Arguments
automationIdrequiredAutomation id.namerequiredThe binding’s declared name.targetIdrequiredThe resource’s id in this workspace.
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 automations bind wf_123 ledger tbl_456
banksync automations bind wf_123 bank bank_789banksync automations config setSet a config value the automation declares, for this workspace. The value is JSON. A value that looks like a secret is refused: put secrets in a connection.
Arguments
automationIdrequiredAutomation id.namerequiredThe config value’s declared name.valuerequiredThe value, as JSON.
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 automations config set wf_123 threshold 250
banksync automations config set wf_123 channel '"finance"'banksync automations copyCopy an automation into a new draft: no revision, no bindings and no config values carry across.
Arguments
automationIdrequiredAutomation id to copy.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--fieldsComma-separated columns (dot-paths) to display.--idempotency-keyA key a retry sends again: a retry with the same key answers what the first call made. One is made per call when absent.--jsonShorthand for --output json.--localeLocale for number formatting (e.g. en-US).--max-retriesMax automatic retries on 429/network errors (GETs only).--nameThe copy’s 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.--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).
Examples
banksync automations copy wf_123 --name "Alert on reauth (copy)"banksync automations createCreate an automation, blank (a "Run by hand" trigger) or from a flagbase.automation/1 definition. It starts as a draft.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--definitionPath to a flagbase.automation/1 definition (JSON; - for stdin).--fieldsComma-separated columns (dot-paths) to display.--folderFolder id to create it in.--idempotency-keyA key a retry sends again: a retry with the same key answers what the first call made. One is made per call when absent.--jsonShorthand for --output json.--localeLocale for number formatting (e.g. en-US).--max-retriesMax automatic retries on 429/network errors (GETs only).--nameThe automation’s 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.--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).
Examples
banksync automations create --name "Alert on reauth"
banksync automations create --name "Digest" --definition definition.jsonbanksync automations deactivateStop an automation’s triggers. Runs in flight finish.
Arguments
automationIdrequiredAutomation 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 automations deactivate wf_123banksync automations deleteMove an automation to trash. Its triggers stop at once; runs in flight finish. It can be restored.
Arguments
automationIdrequiredAutomation 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 automations delete wf_123
banksync automations delete wf_123 --yesbanksync automations dry-runDry-run the published revision (publish first; its grant need not be approved): reads run unless the node has a fixture, everything that would send or write yields its fixture or sample. Nothing is sent or written. Follow it with automations runs get <id>.
Arguments
automationIdrequiredAutomation id.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--fieldsComma-separated columns (dot-paths) to display.--idempotency-keyA key a retry sends again: a retry with the same key answers what the first call made. One is made per call when absent.--inputsThe run’s inputs, as JSON.--inputs-fileRead the run’s inputs from a JSON file (- for stdin).--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.--triggerWhich trigger to start, by its ref (an automation that starts from an event, a webhook or a poll and has several).--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).
Examples
banksync automations dry-run wf_123banksync automations editChange a draft by commands from a JSON file: { "draftVersion": 3, "spec": [...], "layout": [...] }. All the spec commands apply or none do; a stale draftVersion is refused.
Arguments
automationIdrequiredAutomation id.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--draft-versionThe draft version you read, overriding the document’s draftVersion.--file, -fPath to the edit document (JSON; - 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.--quiet, -qSuppress spinners and notices; data only.--verboseLog requests to stderr (secrets redacted).
Examples
banksync automations edit wf_123 --file commands.json
cat commands.json | banksync automations edit wf_123 --file -banksync automations exportExport an automation as a portable file: its draft and layout, with no ids of this workspace, no config values and no secrets.
Arguments
automationIdrequiredAutomation 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.--outWrite the file here instead of stdout.--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 automations export wf_123 --out reauth-alert.json
banksync automations export wf_123 > reauth-alert.jsonbanksync automations fixtureSet or clear a node’s fixture: what the node gives instead of running, in a dry run and a step test — { "outputs": { "main": <value> } }, or { "error": { … } } to rehearse a failure. Live runs never read it.
Arguments
automationIdrequiredAutomation id.nodeIdrequiredNode id in the draft.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--clearRemove the node’s fixture.--file, -fThe fixture (JSON; - 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.--quiet, -qSuppress spinners and notices; data only.--verboseLog requests to stderr (secrets redacted).
Examples
banksync automations fixture wf_123 n_fetch --file sample.json
banksync automations fixture wf_123 n_fetch --clearbanksync automations folderMake a folder for automations, at the top level or inside another.
Arguments
namerequiredThe folder’s 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.--parentThe folder to make it in. Absent, the top level.--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 automations folder "Bank alerts"
banksync automations folder "Reauth" --parent ci_456banksync automations getGet an automation: its draft, findings, status, active revision and layout. Send its draftVersion back with an edit.
Arguments
automationIdrequiredAutomation 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 automations get wf_123 -o jsonbanksync automations grants getRead a grant and what its approver is shown: every node, what changed since the previous grant, and whether bindings, config or node types moved since.
Arguments
grantIdrequiredGrant 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 automations grants get grt_123 -o jsonbanksync automations grants listList an automation’s grants, newest first, revoked and expired ones included.
Arguments
automationIdrequiredAutomation id.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--cursorThe next-page cursor a previous page printed.--fieldsComma-separated columns (dot-paths) to display.--jsonShorthand for --output json.--limitGrants to return (1–100).--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 automations grants list wf_123banksync automations grants requestCompute the active revision’s grant request again and store it for a member to approve in the app. Approving is a person’s decision and has no CLI command.
Arguments
automationIdrequiredAutomation 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 automations grants request wf_123banksync automations grants revokeRevoke a grant: the automation’s runs are refused until a new one is approved. A revoked grant is never approved again.
Arguments
grantIdrequiredGrant 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).--yesSkip confirmation prompts.
Examples
banksync automations grants revoke grt_123
banksync automations grants revoke grt_123 --yesbanksync automations importImport an automation as a new draft: a flagbase export file, an n8n automation or an Activepieces flow. Unmatched nodes arrive as placeholders; the report says what did not carry across.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--dialectflagbase | n8n | activepiecesWhere the document came from; read from the document when absent.--fieldsComma-separated columns (dot-paths) to display.--file, -fPath to the document (JSON; - for stdin).--idempotency-keyA key a retry sends again: a retry with the same key answers what the first call made. One is made per call when absent.--jsonShorthand for --output json.--localeLocale for number formatting (e.g. en-US).--max-retriesMax automatic retries on 429/network errors (GETs only).--nameThe new draft’s name (an n8n or Activepieces import).--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 automations import --file export.json
banksync automations import --file n8n.json --dialect n8n --name "From n8n"banksync automations listList the workspace’s automations with their status and blocking findings. Narrow with --search (words in the name) and --status; with --bound-to, only those bound to one table, bank or feed — its automations.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--bound-toOnly automations bound to TYPE:ID (tables.table, banksync.bank, banksync.feed).--cursorThe next-page cursor a previous page printed.--fieldsComma-separated columns (dot-paths) to display.--jsonShorthand for --output json.--limitAutomations to return (1–1000).--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.--searchOnly automations whose name contains these words.--sortSort by field(s); prefix with - for descending.--statusdraft | inactive | active | blockedOnly automations in these states, comma-separated.--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).
Examples
banksync automations list
banksync automations list --bound-to tables.table:tbl_123
banksync automations list --search invoice --status active,blocked
banksync automations list -o jsonbanksync automations moveMove an automation or a folder into a folder, or to the top level, optionally before another item. Only its place changes.
Arguments
idrequiredAutomation or folder id.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--beforePlace it before this item, in the target folder. Absent, it goes last.--fieldsComma-separated columns (dot-paths) to display.--folderThe folder to move it into.--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.--top-levelMove it out of its folder, to the top level.--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).
Examples
banksync automations move wf_123 --folder ci_456
banksync automations move wf_123 --top-level
banksync automations move wf_123 --folder ci_456 --before wf_789banksync automations nodes describeDescribe node types: ports, parameters (JSON Schema), effect and safety properties. Name each as package/operation@version.
Arguments
typesrequiredOne or more package/operation@version.
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 automations nodes describe flagbase.trigger/manual@1
banksync automations nodes describe banksync.banks/connection.needs_reauth@1 -o jsonbanksync automations nodes optionsThe choices a node’s parameter offers at design time. A table, a bank or a feed is chosen by binding instead.
Arguments
automationIdrequiredAutomation id.nodeIdrequiredNode id in the draft.
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.--paramThe parameter’s key.--paramsJSON object of the node’s parameters as you hold them, which may be ahead of the saved draft: a dependent choice reads its siblings here.--profileConfig profile to use.--queryWords to narrow the choices.--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 automations nodes options wf_123 n_rows --param status
banksync automations nodes options wf_123 n_rows --param fields --params '{"table": "tbl_1"}'banksync automations nodes searchSearch the node catalogue: every node type a BankSync automation may use, 50 to a page, with when to use each.
Arguments
searchWords to match.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--categoryOnly node types of this category.--cursorThe cursor of the previous page.--fieldsComma-separated columns (dot-paths) to display.--jsonShorthand for --output json.--limitNode types per page (1–50).--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 automations nodes search reauth
banksync automations nodes search --category triggersbanksync automations packagesList the node packages available in BankSync and how many node types each holds.
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 automations packagesbanksync automations publishPublish the draft as an immutable revision; its grant is requested at the same time, for a workspace owner or admin to approve in the app (the page is printed). Refused while the draft has blocking findings.
Arguments
automationIdrequiredAutomation 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 automations publish wf_123banksync automations renameRename an automation, set its icon, or both. The definition is not changed.
Arguments
automationIdrequiredAutomation id.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--clear-iconRemove the icon.--fieldsComma-separated columns (dot-paths) to display.--iconAn icon id (lucide:…, emoji:…).--jsonShorthand for --output json.--localeLocale for number formatting (e.g. en-US).--max-retriesMax automatic retries on 429/network errors (GETs only).--nameThe new 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.--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).
Examples
banksync automations rename wf_123 --name "Flag large payments"
banksync automations rename wf_123 --icon lucide:Flag
banksync automations rename wf_123 --clear-iconbanksync automations restoreRestore an automation from trash. It comes back inactive; activate it again.
Arguments
automationIdrequiredAutomation 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 automations restore wf_123banksync automations revisionsList an automation’s published revisions, newest first. `automations revisions get <id> <hash>` reads one with its definition.
Arguments
automationIdrequiredAutomation id.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--cursorThe next-page cursor a previous page printed.--fieldsComma-separated columns (dot-paths) to display.--jsonShorthand for --output json.--limitRevisions to return (1–100).--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 automations revisions wf_123banksync automations revisions getRead one published revision with its definition: what a run of it ran, after the draft has moved on.
Arguments
automationIdrequiredAutomation id.revisionrequiredThe revision’s hash.
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 automations revisions get wf_123 3f2a…(the revision hash) -o jsonbanksync automations runRun an automation now, by hand, with optional inputs (handed on as one item). Refused until it is published and its grant approved by a workspace owner or admin in the app (Automations → Approvals); it need not be activated. One that starts from an event needs --live. A start its admission holds is accepted (status queued): read it with automations runs get <id>.
Arguments
automationIdrequiredAutomation id.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--fieldsComma-separated columns (dot-paths) to display.--idempotency-keyA key a retry sends again: a retry with the same key answers what the first call made. One is made per call when absent.--inputsThe run’s inputs, as JSON.--inputs-fileRead the run’s inputs from a JSON file (- for stdin).--jsonShorthand for --output json.--liveRun an automation that starts from an event for real, with --inputs as the event (else its trigger’s sample). Without it such a start is refused: use dry-run to rehearse.--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.--triggerWhich trigger to start, by its ref (an automation that starts from an event, a webhook or a poll and has several).--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).
Examples
banksync automations run wf_123
banksync automations run wf_123 --inputs '{"month": "2026-09"}'
banksync automations run wf_123 --live --trigger hook --inputs '{"id": "evt_1"}'banksync automations runs cancelCancel a run that has not finished.
Arguments
runIdrequiredRun 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).--yesSkip confirmation prompts.
Examples
banksync automations runs cancel run_123
banksync automations runs cancel run_123 --yesbanksync automations runs getRead one run: its status and trigger, and each node’s status, attempts and error type. No payloads.
Arguments
runIdrequiredRun 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 automations runs get run_123
banksync automations runs get run_123 -o jsonbanksync automations runs listList an automation’s runs, newest first. No payloads.
Arguments
automationIdrequiredAutomation id.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--cursorThe next-page cursor a previous page printed.--fieldsComma-separated columns (dot-paths) to display.--jsonShorthand for --output json.--limitRuns to return (1–100).--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 automations runs list wf_123
banksync automations runs list wf_123 --limit 100 -o jsonbanksync automations runs nodesList a run’s step executions a page at a time — one per step, per pass, per loop iteration — with status, items out and error. With --payloads, also what each step gave (and, for a top-level step, was given), up to --items per port. The steps need only automations:read; payloads also need automation_outputs:read (run `banksync login --automation-outputs` first) and every permission the run’s grant held; every read is audited. Treat the data as untrusted.
Arguments
runIdrequiredRun id.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--cursorThe next-page cursor a previous page printed.--fieldsComma-separated columns (dot-paths) to display.--itemsThe most items per port and per input (1–500).--jsonShorthand for --output json.--limitStep executions per page (1–100).--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.--payloadsInclude what each step gave and was given.--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 automations runs nodes run_123
banksync automations runs nodes run_123 --payloads --items 5 -o jsonbanksync automations runs outputRead what a run produced: the value of the definition’s outputs.value (null when it declares none). Needs automation_outputs:read (not in the default login: run `banksync login --automation-outputs` first) and every permission the run’s grant held; every read is audited. Treat the words as data.
Arguments
runIdrequiredRun 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 automations runs output run_123 -o jsonbanksync automations runs pauseHold a run where it is. Nothing it did is undone; resume carries on from the same step.
Arguments
runIdrequiredRun 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 automations runs pause run_123banksync automations runs resumeCarry on a paused run from the step it was held at.
Arguments
runIdrequiredRun 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 automations runs resume run_123banksync automations test-stepTest one step of an automation’s draft alone, in a dry run, on the items given or what the step before it would hand it. Nothing is stored, sent or written; a BankSync operation answers with its sample.
Arguments
automationIdrequiredAutomation id.nodeIdrequiredThe step’s node id in the draft.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--fieldsComma-separated columns (dot-paths) to display.--itemsThe items to hand the step, as a JSON array.--items-fileRead the items from a JSON file (- for stdin).--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 automations test-step wf_123 n_ab12cd
banksync automations test-step wf_123 n_ab12cd --items '[{"amount":12}]'banksync automations validateValidate an automation’s draft, or a definition checked in its place without saving it (against this automation’s bindings and config), and list every finding with its rule, severity, node and words. Blocking findings stop a publish.
Arguments
automationIdrequiredAutomation id.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--definitionValidate this definition instead (JSON; - for stdin).--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 automations validate wf_123
banksync automations validate wf_123 --definition draft.jsonbanksync automations webhooks rotateGive a webhook trigger (--trigger), or every one, of an active automation a new URL; the old one stops at once, so it asks first (--yes skips). The new URLs are printed once, here — store them. Every call mints again.
Arguments
automationIdrequiredAutomation 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.--triggerOne webhook trigger, by its ref.--verboseLog requests to stderr (secrets redacted).--yesSkip confirmation prompts.
Examples
banksync automations webhooks rotate wf_123
banksync automations webhooks rotate wf_123 --trigger hook --yes -o jsonbalances
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 Checkingbanks
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 jsonbanksync 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).--consumer-typepersonal | businessPre-select personal or business accounts where the bank offers both.--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 connect --institution "Commonwealth Bank" --consumer-type businessbanksync 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. Done signed in to the BankSync app, not from the CLI: the API refuses it to an API key or an OAuth login, so this command stops before asking you to confirm.--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 --permanentbanksync 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 Chasebanksync 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 jsonbanksync 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 Chasebanksync 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 jsonblueprints
banksync blueprints createSave a portable template to this workspace’s library without publishing it — typically what `blueprints export` printed. It must carry no workspace ids. A workspace keeps up to 200.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--fieldsComma-separated columns (dot-paths) to display.--fileThe blueprint (or what blueprints export -o json printed); - reads stdin.--idempotency-keyA key a retry sends again: a retry with the same key answers what the first call made. One is made per call when absent.--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).--visibilityprivate | workspaceWho sees it: private (only you; needs a signed-in member, not an API key) or workspace (every member). Default workspace.
Examples
banksync blueprints create --file template.json
banksync blueprints export --title "Monthly budget" --table tbl_1 -o json | banksync blueprints create --file -
banksync blueprints create --file template.json --visibility privatebanksync blueprints deleteDelete a saved template. It can be restored with blueprints restore for 30 days; installs made from it keep everything they made.
Arguments
blueprintIdrequiredSaved blueprint id, from blueprints list.
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 blueprints delete bp_123
banksync blueprints delete bp_123 --yesbanksync blueprints exportTurn tables, feeds and enrichments of this workspace into a portable template: ids become references between them, and the bank or destination becomes an input the installer answers. Nothing is saved — pipe `-o json` into `blueprints create --file -`. At most 40 resources.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--automationAutomation id to include (repeatable).--dashboardDashboard id to include (repeatable).--descriptionWhat the template is for.--enrichmentEnrichment id to include (repeatable).--feedFeed id to include (repeatable).--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.--tableTable id to include (repeatable).--titleThe template’s title.--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).--widgetWidget id to include (repeatable).
Examples
banksync blueprints export --title "Monthly budget" --table tbl_1 --feed feed_1
banksync blueprints export --title "Spending" --feed feed_1 --enrichment enr_1 -o json > template.jsonbanksync blueprints getRead one saved template with its portable body: the resources it makes and the inputs an installer answers. `-o json` prints the body, ready for `blueprints update --file -` or `installs create --file -`.
Arguments
blueprintIdrequiredSaved blueprint id, from blueprints list.
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 blueprints get bp_123
banksync blueprints get bp_123 -o json > template.jsonbanksync blueprints listList the templates this workspace saved to its library, most recently changed first: title, the kinds of resources each makes, and its version.
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 blueprints list
banksync blueprints list --all -o jsonbanksync blueprints restoreRestore a deleted saved template within 30 days of its deletion. Refused when a live template now uses its key.
Arguments
blueprintIdrequiredThe deleted blueprint’s 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 blueprints restore bp_123banksync blueprints updateReplace a saved template’s body, change who sees it, or both. Pass the version you read with --expected-version so a newer save is refused rather than overwritten.
Arguments
blueprintIdrequiredSaved blueprint id, from blueprints list.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--expected-versionThe version you read: refused (STALE) when someone saved since.--fieldsComma-separated columns (dot-paths) to display.--fileThe new blueprint (or what blueprints get -o json printed); - reads stdin.--idempotency-keyA key a retry sends again: a retry with the same key answers what the first call made. One is made per call when absent.--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).--visibilityprivate | workspaceWho sees it: private (only its owner) or workspace (every member). Only the owner changes it.
Examples
banksync blueprints update bp_123 --file template.json --expected-version 3
banksync blueprints update bp_123 --visibility workspaceclients
banksync clients listList your firm's clients: its client portals (the firm pays) and clients' own workspaces shared with the firm (the client pays), with connection health on Professional and above. Owner/admin keys only.
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 clients list
banksync clients list -o jsonconfig
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 outputbanksync 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 listbanksync 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 offbanksync 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 tzcontent
banksync content deleteMove a folder or an item to trash; a folder’s contents move up to its parent. It can be restored. Names what depends on it before asking.
Arguments
idrequiredItem or folder id, from content tree.
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 content delete ci_456
banksync content delete ci_456 --yesbanksync content folderCreate a folder in the workspace tree, at the top level or inside another folder.
Arguments
namerequiredThe folder’s name.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--beforePlace it before this item. Absent, it goes last.--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.--parentThe folder to create it in. Absent, the top level.--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 content folder "Month end"
banksync content folder Payroll --parent ci_456banksync content iconSet a folder’s or an item’s icon, its colour, or both.
Arguments
idrequiredItem or folder id, from content tree.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--colorA colour name (teal, teal-500) or #rrggbb.--fieldsComma-separated columns (dot-paths) to display.--iconAn icon name.--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).--versionThe version you read (content tree); a change since is refused.
Examples
banksync content icon ci_456 --icon folder-open --version 2
banksync content icon wf_123 --color teal-500 --version 4banksync content moveMove a folder or an item into a folder, or to the top level, optionally before another item. Only its place changes.
Arguments
idrequiredItem or folder id, from content tree.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--beforePlace it before this item, in the target folder. Absent, it goes last.--fieldsComma-separated columns (dot-paths) to display.--folderThe folder to move it into.--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.--top-levelMove it out of its folder, to the top level.--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).--versionThe version you read; a change since is refused. Absent, it moves regardless.
Examples
banksync content move wf_123 --folder ci_456
banksync content move wf_123 --top-level
banksync content move wf_123 --folder ci_456 --before wf_789banksync content renameRename a folder or an item. Renaming an automation renames it everywhere it is shown.
Arguments
idrequiredItem or folder id, from content tree.namerequiredThe new 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).--versionThe version you read (content tree); a change since is refused.
Examples
banksync content rename wf_123 "Month end" --version 3banksync content restoreBring a folder or an item back from trash, to its folder if that is still there.
Arguments
idrequiredItem or folder id, from content tree --trash.
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 content restore ci_456banksync content starStar an item for yourself, or unstar it with --off. A star is yours, never the workspace’s.
Arguments
idrequiredItem id, from content tree.
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.--offUnstar it.--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 content star wf_123
banksync content star wf_123 --offbanksync content treeRead the workspace tree: folders and automations with their places, names and versions, and your stars. Sections of banks, feeds and other resources appear when your login may read them.
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.--trashList what is in trash instead of the live tree.--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).
Examples
banksync content tree
banksync content tree --trash
banksync content tree -o jsondashboards
banksync dashboards getShow one dashboard by id or slug, with its layout, widgets and filters.
Arguments
dashboardIdrequiredDashboard id or slug.
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 dashboards get dsh_123 -o jsonbanksync dashboards listList the dashboards in the current workspace. A private dashboard is not listed.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--fieldsComma-separated columns (dot-paths) to display.--include-draftsInclude staged draft dashboards.--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 dashboards list
banksync dashboards list --include-drafts -o jsonbanksync dashboards moveMove a dashboard into a folder, or to the top level, optionally before another dashboard. Only its place changes.
Arguments
dashboardIdrequiredDashboard id.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--beforePlace it before this dashboard, in the target folder.--fieldsComma-separated columns (dot-paths) to display.--folderThe folder to move the dashboard into.--jsonShorthand for --output json.--lastPlace it last in the target folder.--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.--top-levelMove the dashboard out of its folder, to the top level.--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).
Examples
banksync dashboards move dsh_123 --folder fld_456
banksync dashboards move dsh_123 --top-level
banksync dashboards move dsh_123 --folder fld_456 --before dsh_789
banksync dashboards move dsh_123 --folder fld_456 --lastbanksync dashboards reorderSet the order dashboards are listed in. Dashboards not listed keep their places relative to each other.
Arguments
dashboardIdrequiredDashboard ids, in their new order.
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 dashboards reorder dsh_2 dsh_1 dsh_3enrichments
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.jsonbanksync 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 --yesbanksync 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_123banksync 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 --jsonbanksync 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.jsonbanksync 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.jsonfeeds
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 transactionsbanksync 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 --yesbanksync 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_123banksync 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_123banksync 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 jsonbanksync 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 --watchbanksync 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.jsonholdings
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"installs
banksync installs createInstall a template into this workspace. It answers at once with the install `installing` and finishes in the background — follow it with installs get. Automations arrive switched off. Installing the same template twice makes two named installs.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--bindingsSlot → binding as JSON, e.g. {"bank":{"kind":"bank","bankId":"bank_1"}}. installs plan lists each slot.--bindings-fileThe bindings as a JSON file; - reads stdin.--blueprintA saved blueprint id, from blueprints list.--fieldsComma-separated columns (dot-paths) to display.--fileA blueprint document, installed inline; - reads stdin.--idempotency-keyA key a retry sends again: a retry with the same key answers what the first call made. One is made per call when absent.--jsonShorthand for --output json.--linkThe private-link token of --listing (the ?link= value of its private link): required for a listing that is not publicly listed.--listingA marketplace listing id, from marketplace search.--localeLocale for number formatting (e.g. en-US).--max-retriesMax automatic retries on 429/network errors (GETs only).--nameThe install’s name; default the template’s title, numbered when taken.--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.--presetA built-in template’s key.--profileConfig profile to use.--quiet, -qSuppress spinners and notices; data only.--releaseA specific release of --listing; default its current one.--resourceInstall only this resource (by key) and what it needs (repeatable).--separateMake a separate copy of this share group (a key from installs plan -o json `shareGroups`) instead of sharing it with the install that holds it (repeatable).--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 installs create --listing lst_123 --bindings '{"bank":{"kind":"bank","bankId":"bank_1"}}'
banksync installs create --listing lst_123 --link <private-link-token>
banksync installs create --blueprint bp_123 --name "Budget (household)"
banksync installs create --file template.json --bindings-file bindings.jsonbanksync installs getRead one install and every resource it made, adopted or linked: each one’s status (pending, created, skipped, failed, removed), its workspace id, and why it failed.
Arguments
installIdrequiredInstall id, from installs list.
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 installs get ins_123
banksync installs get ins_123 -o jsonbanksync installs listList this workspace’s installs, newest first: name, where it came from, status and generation.
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.--include-removedInclude removed installs.--jsonShorthand for --output json.--limitMaximum number of items to return.--listingOnly installs of this marketplace listing.--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 installs list
banksync installs list --listing lst_123 --include-removed -o jsonbanksync installs planCheck what installing a template would do, without changing anything: each input it needs and whether your bindings answer it, and what will be created. Answer every missing input, then run installs create with the same flags.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--bindingsSlot → binding as JSON, e.g. {"bank":{"kind":"bank","bankId":"bank_1"}}. installs plan lists each slot.--bindings-fileThe bindings as a JSON file; - reads stdin.--blueprintA saved blueprint id, from blueprints list.--fieldsComma-separated columns (dot-paths) to display.--fileA blueprint document, installed inline; - reads stdin.--jsonShorthand for --output json.--linkThe private-link token of --listing (the ?link= value of its private link): required for a listing that is not publicly listed.--listingA marketplace listing id, from marketplace search.--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.--presetA built-in template’s key.--profileConfig profile to use.--quiet, -qSuppress spinners and notices; data only.--releaseA specific release of --listing; default its current one.--resourceInstall only this resource (by key) and what it needs (repeatable).--separateMake a separate copy of this share group (a key from installs plan -o json `shareGroups`) instead of sharing it with the install that holds it (repeatable).--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 installs plan --listing lst_123
banksync installs plan --listing lst_123 --bindings '{"bank":{"kind":"bank","bankId":"bank_1"}}'
banksync installs plan --blueprint bp_123 -o jsonbanksync installs removeRemove an install. --mode keep leaves what it made as ordinary workspace resources; --mode trash moves what it made to trash, restorable. What it adopted or linked is never touched.
Arguments
installIdrequiredInstall id, from installs list.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--fieldsComma-separated columns (dot-paths) to display.--idempotency-keyA key a retry sends again: a retry with the same key answers what the first call made. One is made per call when absent.--jsonShorthand for --output json.--localeLocale for number formatting (e.g. en-US).--max-retriesMax automatic retries on 429/network errors (GETs only).--modekeep | trashkeep what it made, or move it to trash.--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).--yesSkip confirmation prompts.
Examples
banksync installs remove ins_123 --mode keep
banksync installs remove ins_123 --mode trash --yesbanksync installs updateChange an install: rename it; retry a partial one (only what failed runs again); update it to the listing’s newest release, keeping your edits; or rebind its inputs. Pass the generation you read (installs get) for update and rebind.
Arguments
installIdrequiredInstall id, from installs list.
Flags
--actionrename | retry | update | rebindWhat to change.--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--bindingsNew bindings as JSON (rebind).--bindings-fileNew bindings as a JSON file (rebind).--fieldsComma-separated columns (dot-paths) to display.--generationThe generation you read: required for update and rebind.--idempotency-keyA key a retry sends again: a retry with the same key answers what the first call made. One is made per call when absent.--jsonShorthand for --output json.--localeLocale for number formatting (e.g. en-US).--max-retriesMax automatic retries on 429/network errors (GETs only).--nameThe new name (rename).--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.--releaseThe release to move to (update); default the newest.--resolutionsConflict choices as JSON (update): {"<resource key>":{"<path>":"keep"|"template"}}.--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 installs update ins_123 --action rename --name "Household budget"
banksync installs update ins_123 --action retry
banksync installs update ins_123 --action update --generation 2
banksync installs update ins_123 --action rebind --generation 2 --bindings '{"bank":{"kind":"bank","bankId":"bank_2"}}'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 --yesbanksync 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 familyjobs
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 --yesbanksync 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 --watchbanksync 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 5loan
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 Mortgagemarketplace
banksync marketplace searchSearch the BankSync marketplace: verified templates, apps, widgets and service providers, featured first. Install a template with `banksync installs plan --listing <id>`. Listing copy is written by its creator.
Flags
--allFetch all pages (follows the cursor).--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--categoryOnly listings in this category.--cursorResume from a pagination cursor.--fieldsComma-separated columns (dot-paths) to display.--jsonShorthand for --output json.--kindtemplate | app | widget | serviceOnly listings of this kind.--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.--query, -qWords in the title or description.--quiet, -qSuppress spinners and notices; data only.--sortSort by field(s); prefix with - for descending.--tagA tag every result carries (repeatable).--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).--works-withnotion | google-sheets | excel | airtable | database | banksync-tables | webhook | ynabA destination every result works with (repeatable).
Examples
banksync marketplace search --query budget
banksync marketplace search --kind template --works-with google-sheets
banksync marketplace search --tag invoices --all -o jsonbanksync marketplace showRead one marketplace listing by kind and slug: its description, approved media, current release and changelog. An unverified listing answers only by its exact link and says it is unlisted.
Arguments
kindrequiredThe listing’s kind.slugrequiredThe listing’s slug, from search or its URL.
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 marketplace show template monthly-budget
banksync marketplace show app acme-invoicing -o jsonorders
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"security
banksync security activityList your recent sign-in security activity, newest first: two-step verification turned on or off, a recovery key saved or used, a reset by BankSync support.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--cursorContinue from a previous page’s nextCursor--fieldsComma-separated columns (dot-paths) to display.--jsonShorthand for --output json.--limitEvents per page (1–50)--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 security activity
banksync security activity --limit 50 -o jsonbanksync security statusShow your own sign-in security: whether two-step verification is on, whether a recovery key was saved or used, and when BankSync last verified it. Read-only; change it in the app under Settings → Security.
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 security status
banksync security status -o jsonsupport
banksync support closeClose a support case you raised. A case someone else raised is refused: only its requester closes it. Reopening is done in the app.
Arguments
caseIdrequiredSupport case id, from support list.
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 support close case_123banksync support getRead one support case and its messages: what was asked, what BankSync support answered, and whether a message was sent by an automation.
Arguments
caseIdrequiredSupport case id, from support list.
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 support get case_123
banksync support get case_123 -o jsonbanksync support listList your support cases with BankSync and the cases raised about this workspace, most recently active first: status, who BankSync is waiting on, and when a reply is expected.
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 support list
banksync support list -o jsonbanksync support openOpen a support case with BankSync about this workspace, as you. Support replies by email and in the app. A retry with the same --idempotency-key opens nothing new.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--fieldsComma-separated columns (dot-paths) to display.--idempotency-keyA retry with the same key opens nothing new.--jsonShorthand for --output json.--kindsupport | feedbacksupport (default): something is wrong or unclear. feedback: a suggestion.--localeLocale for number formatting (e.g. en-US).--max-retriesMax automatic retries on 429/network errors (GETs only).--messageThe opening message to BankSync support.--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.--subjectWhat the case is about, in a line.--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).
Examples
banksync support open --subject "Sync stalled" --message "Nothing has synced since Monday."
banksync support open --subject "Idea" --message "A weekly digest would help." --kind feedbackbanksync support replyReply on a support case, as you. BankSync support is notified straight away; a reply cannot be taken back. A retry with the same --idempotency-key posts nothing new.
Arguments
caseIdrequiredSupport case id, from support list.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--fieldsComma-separated columns (dot-paths) to display.--idempotency-keyA retry with the same key posts nothing new.--jsonShorthand for --output json.--localeLocale for number formatting (e.g. en-US).--max-retriesMax automatic retries on 429/network errors (GETs only).--messageThe reply to BankSync support.--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 support reply case_123 --message "Here is the log you asked for."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.jsonbanksync 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 --yesbanksync 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_123banksync 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 jsonbanksync 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 jsontrades
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-31transactions
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 --allwidgets
banksync widgets dataRead the rows a widget shows: its saved query through the same render path a dashboard uses, at most 500 rows.
Arguments
widgetIdrequiredWidget id, from `widgets list`.
Flags
--api-keyAPI key to authenticate with (or set BANKSYNC_API_KEY).--fieldsComma-separated columns (dot-paths) to display.--jsonShorthand for --output json.--limitRows to return (default 500).--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.--paramsJSON object of the values for the widget’s saved query parameters, by name.--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 widgets data wdg_123
banksync widgets data wdg_123 --limit 20 -o json
banksync widgets data wdg_123 --params '{"month": "2026-09"}'banksync widgets listList the widgets in the current workspace: id, slug, name and shape. A private widget is not listed.
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.--shapeview | controlOnly widgets of this shape.--sortSort by field(s); prefix with - for descending.--tagOnly widgets with this tag.--tzIANA time zone for timestamps (e.g. Australia/Sydney).--utcRender timestamps in UTC.--verboseLog requests to stderr (secrets redacted).
Examples
banksync widgets list
banksync widgets list --shape view -o json