Skip to content
BeanHubBeanHub docs

Quickstart

This guide creates a BeanHub account, a sample book, and opens the journal. You do not need to know Beancount yet. Read What is BeanHub if you want the model first.

1. Create an account

Section titled “1. Create an account”

Open https://app.beanhub.io/sign-up.

  1. Email (6–40 characters).
  2. Username (6–32 characters, lowercase a-z, 0-9, _ only).
  3. Password and verify password (6–40 characters).
  4. Agree to the terms of service.
  5. Click Register.
BeanHub sign up form: email, username, password, verify password, terms checkbox, Register.

Already have an account? Sign in at https://app.beanhub.io/sign-in with email or username and password.

BeanHub sign in form: email or username, password, Remember me, Sign in.

The free plan includes:

  • 1 public book
  • 1 private book
  • 1,000 entries per private book (public and paid books: 100,000)
  • Import, forms, API, and inbox
  • Bank Connect is a paid feature (10 connected banks on Pro)

See pricing and Limits and plans.

2. Create a sample book

Section titled “2. Create a sample book”

After sign-in you land on My Repositories. Click Create Repository.

Choose a repository type: Git Repository (Recommended) or Connect Repository.

Choose Git Repository (Recommended). Then:

  1. Name: lowercase letters, numbers, dash, or underscore, 1–32 characters. Example: mybook.
  2. Template: leave Sample selected. That fills the repo from the open-source cookiecutter.
  3. Visibility: Private unless you truly want the book on the public internet.
  4. Click Create.
Create Git Repository form with name, Sample template, Private visibility, and Create.

Creating a sample book runs Git and Beancount in a sandbox. It can take a short while. If the page errors, wait and refresh My Repositories.

3. Open the book

Section titled “3. Open the book”

Click the new repository name. The home page shows the file tree (main.bean, accounts.bean, books/, .beanhub/) and the README.

BeanHub repository home with file tree, Clone button, and README. Public example book beanhub/example.

The screenshot is the public example book. A sample book you create looks the same, with your username and repo name in the breadcrumb.

Left sidebar (Git books):

  • Home: files and README
  • Commits: Git history
  • Journal: every entry, newest first
  • Accounts / Commodities
  • Balance Sheet / Income Statement
  • Forms
  • Inbox (beta)
  • Import: Input Files, Upload Files, Connect Banks, Open TXNs, Pending TXNs
  • Settings

Click Journal. You should see sample transactions from the template.

Journal page listing Beancount transactions with Add Transaction.

Use Add filter in the header to limit the date range (this month, this year, custom range).

4. Optional: clone with Git

Section titled “4. Optional: clone with Git”

You need an access token with Git read (and write, if you will push).

  1. Open Account Settings in the top nav, then Manage Access Tokens, or go to https://app.beanhub.io/access-tokens/.
  2. Click create. Leave Grant All Permissions checked for a laptop.
  3. Copy the token. BeanHub shows it once.
  4. On the book home page, click Clone and copy the HTTPS URL.
Terminal window
git clone https://app.beanhub.io/repos/USERNAME/mybook.git

When Git asks for a password, paste the token. The username field can be your BeanHub username. Full detail: Git over HTTPS.

What’s next

Section titled “What’s next”

Edit

Add a transaction, edit entries, rename an account, see the commit. Edit and commit

Reports

Balance sheet and income statement. Reports

Inbox

Forward invoices to a dedicated address. Inbox