CLI

This module provides you with a common starter kit of commands that are useful in Beancount projects.

# cli.py
from roastery import make_cli, Config

config = Config.with_defaults()
roastery_cli = make_cli(config)
roastery_cli()

This will result in the following CLI:

$ ./cli.py

 Usage: ./cli.py [OPTIONS] COMMAND [ARGS]...

╭─ Options ───────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                         │
╰─────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────╮
│ edit     Edit transactions that haven't been classified yet.        │
│ fava     Start fava, the beancount web UI.                          │
│ flag     Flag an entry for later review, based on digest.           │
╰─────────────────────────────────────────────────────────────────────╯

Command reference

Todo

Reference for the default commands

API

roastery.cli.make_cli(config: Config) → Typer

Create a roastery CLI application from the given config.

This function returns a Typer instance. You can customize the the instance with your own commands. See Getting started for more information.

Parameters:

config (Config)

Return type:

Typer