Skip to content
github-actions[bot] edited this page Oct 21, 2026 · 12 revisions

This page is copied from docs/README.md whenever it changes. To correct it, open a pull request on that file.

CloudBank guides

The wiki shows these same guides, copied from docs/ whenever they change. Corrections go to docs/, through a pull request: an edit made in the wiki is overwritten.

Start here

  • Getting started: from a fresh install to your first transactions. The administrator, a wallet, accounts, categories, the entry sheet and reconciling.
  • Migrating from HomeBank: bring a HomeBank .xhb file across in one upload, and go back whenever you like.

Using CloudBank

  • Using CloudBank, page by page: what each page is for and what it can do.
  • Importing transactions: bank CSV, QIF, OFX and CAMT.053 files. The column mapping, the review, and what to do when rows come in wrong.
  • Automatic bank sync: connecting a bank through SimpleFIN, Enable Banking or Pluggy.
  • Bank mails: reading the bank's payment notices from a mailbox, with patterns you make by selecting text in a mail, or with the AI; and what happens when the bank's own row arrives.
  • Notifications: the bell, push, email, Matrix, Telegram, Discord, Slack, ntfy, Gotify and webhooks; which events go where, and connecting Home Assistant.
  • The AI, and what it sees: setting up your own model, what each job does and sends, what stays with you, and the monthly limit.
  • CloudBank in Home Assistant: bills, this month's budget and Review as sensors, read with an API token; balances only if you ask.
  • Adding from your phone: the home-screen shortcuts, sharing a bank's notification, and scanning a receipt.
  • Ask your data: a question about your money, answered from CloudBank's own queries, with the numbers it used.
  • Schedules in your phone's calendar: Add to calendar and how to subscribe on an iPhone, in Google Calendar or in Outlook.

Running CloudBank

Extending CloudBank

  • Writing a bank import plugin: teach the importer a bank's own file format.
  • The API: every running CloudBank serves its interactive reference at /api/docs.
  • Contributing: running from source, and how changes are made.
  • Translation glossary: the words CloudBank uses in each language it speaks, and the style each translation follows.

Something missing or wrong? Open an issue.

Clone this wiki locally