Create a book

A book is a Git repository on BeanHub. Names are 1–32 characters: lowercase a-z, 0-9, -, _.

Open My Repositories and click Create Repository.

Git repository, sample template

This is the path for almost everyone.

1. Choose Git Repository (Recommended).
2. Name the book.
3. Template Sample.
4. Visibility Private or Public.
5. Create.

The sample is generated from beanhub-beancount-cookiecutter. It includes:

• main.bean with include of accounts, commodities, and yearly books
• .beanhub/imports.yaml with example Mercury CSV rules
• .beanhub/forms.yaml with a sample hours form
• A README that walks upload-import and forms

Use it to click through Import and Forms without designing a chart of accounts first.

Git repository, empty

Choose Empty if you already have Beancount files, or you want to write main.bean yourself.

Until the first push, the home page is an Empty repository panel. It tells you to:

git clone https://app.beanhub.io/repos/USERNAME/REPO.git

Copy your Beancount files into the folder. The main file must be named main.bean. Then:

git add .
git commit -m "Initial book"
git push origin master

You need an access token with Git write. See Git over HTTPS.

Caution

A push is rejected if main.bean is missing or Beancount cannot load it. Includes must resolve. Plugins that BeanHub does not support can also fail the check. Keep the first push small so errors are easy to read.

Cookiecutter on your laptop

If you want the sample tree without using the website template:

pip install cookiecutter
cookiecutter gh:LaunchPlatform/beanhub-beancount-cookiecutter

It asks for project_slug, username, and year. Create an Empty Git repository on BeanHub, add the generated folder as the remote, and push. Same main.bean rule as above.

Connect repository

Choose Connect Repository only if you will not host the Beancount files on BeanHub. You still get:

• Plaid bank connections (paid)
• CSV dump via bh connect dump
• Inbox email

You do not get Journal, reports, or in-browser edit. The academy walkthrough is Pull CSV with Direct Connect.

After create

• Sample Git book: open Journal.
• Empty Git book: push main.bean.
• Connect book: Connect banks.

You can deactivate a book later in Settings to free a quota slot without deleting data. Delete is irreversible. Confirm by typing the repository name.