Usage

(If you haven’t already, start with the README first.)

yarm

yarm: Yet Another Report Maker.

yarm [OPTIONS] COMMAND [ARGS]...

Options

--version

Show the version and exit.

new

Initialize a new yarm report.

This will create a new config file and, by default, open this file in your default editor.

yarm new [OPTIONS]

Options

-e, --edit, -E, --no-edit

Open new config file in your default editor?

Default:

True

-f, --force, -F, --no-force

Force overwrite if config file already exists?

Default:

False

-p, --path <custom_config_path>

Custom path for new config file.

run

Run the report.

yarm run [OPTIONS]

Options

-d, --database, -D, --no-database

Export your tables and queries to an sqlite3 database.

Default:

False

-f, --force, -F, --no-force

If output files exist, force overwrites without asking.

Default:

False

-v, --verbose

Verbosity level.

-c, --config <config_path>

Config file for this project.