Command-Line Help for `ebb`

This document contains the help content for the ebb command-line program.

Command Overview:

ebb↴
ebb balance↴
ebb cancel↴
ebb config↴
ebb config get↴
ebb config list↴
ebb config set↴
ebb daysoff↴
ebb holiday↴
ebb holiday add↴
ebb holiday edit↴
ebb holiday list↴
ebb holiday remove↴
ebb project↴
ebb project list↴
ebb project rename↴
ebb report↴
ebb restart↴
ebb sickday↴
ebb sickday add↴
ebb sickday edit↴
ebb sickday list↴
ebb sickday remove↴
ebb start↴
ebb status↴
ebb stop↴
ebb tag↴
ebb tag list↴
ebb tag remove↴
ebb tag rename↴
ebb vacation↴
ebb vacation add↴
ebb vacation edit↴
ebb vacation list↴
ebb vacation remove↴

`ebb`

Usage: ebb [OPTIONS] <COMMAND>

Subcommands:

balance — Show working hour balance
cancel — Cancel the current time tracking frame
config — Manage the configuration
daysoff — Print overview of remaining vacation and sick days
holiday — Manage holidays
project — Manage projects
report — Return the total time and time spent per project
restart — Restart the last project
sickday — Manage sick days
start — Start time tracking
status — Show current time tracking status
stop — Stop time tracking
tag — Manage tags
vacation — Manage vacation days

Options:

-c, --data-dir <DATA_DIR> — Set the directory holding the configuration and the data; defaults to $XDG_DATA_HOME/ebb, or ~/.local/share/ebb when that is not set
-f, --format <FORMAT> — Set the output format

Default value: text

Possible values: text, json

`ebb balance`

Show working hour balance

Usage: ebb balance [OPTIONS]

Options:

--from <FROM> — First date (yyyy-mm-dd); for the current day, week, month or year, use –day, –week, –month or –year
--to <TO> — Last date, included (yyyy-mm-dd); for the current day, week, month or year, use –day, –week, –month or –year
-y, --year — Report time spent in the current year
-m, --month — Report time spent in the current month
-w, --week — Report time spent in the current week
-d, --day — Report time spent on the current day
--exclude-today — End at the start of the current day, counting only finished days

`ebb cancel`

Cancel the current time tracking frame

Usage: ebb cancel

`ebb config`

Manage the configuration

Usage: ebb config config <COMMAND>

Subcommands:

get — Get a single configuration value
list — List all configuration values
set — Set a configuration value

`ebb config get`

Get a single configuration value

Usage: ebb config get <KEY>

Arguments:

<KEY>

`ebb config list`

List all configuration values

Usage: ebb config list

`ebb config set`

Set a configuration value

Usage: ebb config set <KEY> <VALUE>

Arguments:

<KEY> — Configuration key
<VALUE> — Configuration value

`ebb daysoff`

Print overview of remaining vacation and sick days

Usage: ebb daysoff [OPTIONS]

Options:

-y, --year <YEAR> — Year; defaults to the current year

`ebb holiday`

Manage holidays

Usage: ebb holiday holiday <COMMAND>

Subcommands:

add — Add a new holiday
edit — Change the description and portion of an existing holiday
list — List all holidays
remove — Remove a holiday

`ebb holiday add`

Add a new holiday

Usage: ebb holiday add [OPTIONS] <DATE> [DESCRIPTION]

Arguments:

<DATE> — Date of the holiday (yyyy-mm-dd, e.g. 2025-08-11)
<DESCRIPTION> — Name of the holiday (e.g. Mountain Day); defaults to “Holiday”

Options:

-p, --portion <PORTION> — Switch between full-day and half-day holiday

Default value: full

Possible values: full, half

`ebb holiday edit`

Change the description and portion of an existing holiday

Usage: ebb holiday edit [OPTIONS] <DATE> <DESCRIPTION>

Arguments:

<DATE> — Date of the holiday to edit
<DESCRIPTION> — New name for the holiday

Options:

-p, --portion <PORTION> — New portion; omit to keep the current value

Possible values: full, half

`ebb holiday list`

List all holidays

Usage: ebb holiday list [OPTIONS]

Options:

-y, --year <YEAR> — Filter by year

`ebb holiday remove`

Remove a holiday

Usage: ebb holiday remove <DATE>

Arguments:

<DATE> — Date of the holiday to remove

`ebb project`

Manage projects

Usage: ebb project project <COMMAND>

Subcommands:

list — List all projects
rename — Renames a project

`ebb project list`

List all projects

Usage: ebb project list

`ebb project rename`

Renames a project

Usage: ebb project rename <OLD_NAME> <NEW_NAME>

Arguments:

<OLD_NAME> — Current project name
<NEW_NAME> — New project name

`ebb report`

Return the total time and time spent per project

Usage: ebb report [OPTIONS]

Options:

--from <FROM> — Start date or time (yyyy-mm-dd, hh:mm, hh:mm:ss, yyyy-mm-dd hh:mm, yyyy-mm-dd hh:mm:ss, or ISO 8601); for the current day, week, month or year, use –day, –week, –month or –year
--to <TO> — End date or time (yyyy-mm-dd, hh:mm, hh:mm:ss, yyyy-mm-dd hh:mm, yyyy-mm-dd hh:mm:ss, or ISO 8601); a date includes that day; for the current day, week, month or year, use –day, –week, –month or –year
-y, --year — Report time spent in the current year
-m, --month — Report time spent in the current month
-w, --week — Report time spent in the current week
-d, --day — Report time spent on the current day
-p, --project <PROJECT> — Filter by project
-t, --tag <TAG> — Filter by tag

`ebb restart`

Restart the last project

Usage: ebb restart [OPTIONS]

Options:

--at <AT> — Time at which the project is restarted (hh:mm, hh:mm:ss, yyyy-mm-dd hh:mm, yyyy-mm-dd hh:mm:ss, or ISO 8601); if omitted, the current time is used
--ago <AGO> — How long ago the project was restarted, e.g. 30m or “1h 30m”; resolves to the time –at would name
-G, --no-gap — Set the start time to the end time of the last saved frame

`ebb sickday`

Manage sick days

Usage: ebb sickday sickday <COMMAND>

Subcommands:

add — Add one or more sick days
edit — Change the description and portion of an existing sick day
list — List all sick days
remove — Remove one or more sick days

`ebb sickday add`

Add one or more sick days.

A range spans at most a year. Days without working hours, full-day holidays and days that already have a sick day are skipped.

Usage: ebb sickday add [OPTIONS] <START_DATE> [END_DATE] [DESCRIPTION]

Arguments:

<START_DATE> — Start date (yyyy-mm-dd)
<END_DATE> — End date, inclusive (yyyy-mm-dd); defaults to the start date for a single day
<DESCRIPTION> — Description of the day off

Options:

-p, --portion <PORTION> — Switch between full-day and half-day

Default value: full

Possible values: full, half

`ebb sickday edit`

Change the description and portion of an existing sick day

Usage: ebb sickday edit [OPTIONS] <DATE> <DESCRIPTION>

Arguments:

<DATE> — Date of the sick day to edit
<DESCRIPTION> — New description for the sick day

Options:

-p, --portion <PORTION> — New portion; omit to keep the current value

Possible values: full, half

`ebb sickday list`

List all sick days

Usage: ebb sickday list [OPTIONS]

Options:

-y, --year <YEAR> — Filter by year

`ebb sickday remove`

Remove one or more sick days.

A range spans at most a year.

Usage: ebb sickday remove <START_DATE> [END_DATE]

Arguments:

<START_DATE> — Start date (yyyy-mm-dd)
<END_DATE> — End date, inclusive (yyyy-mm-dd); defaults to the start date for a single day

`ebb start`

Start time tracking

Usage: ebb start [OPTIONS] <PROJECT> [TAGS]...

Arguments:

<PROJECT> — Name of the project
<TAGS> — Any number of additional tags; quote a tag that contains spaces

Options:

--at <AT> — Time at which the project is started and a running frame is stopped (hh:mm, hh:mm:ss, yyyy-mm-dd hh:mm, yyyy-mm-dd hh:mm:ss, or ISO 8601); if omitted, the current time is used
--ago <AGO> — How long ago the project was started, e.g. 30m or “1h 30m”; resolves to the time –at would name
-G, --no-gap — Set the start time to the end time of the last saved frame

`ebb status`

Show current time tracking status

Usage: ebb status

`ebb stop`

Stop time tracking

Usage: ebb stop [OPTIONS]

Options:

--at <AT> — Time at which the project is stopped (hh:mm, hh:mm:ss, yyyy-mm-dd hh:mm, yyyy-mm-dd hh:mm:ss, or ISO 8601); if omitted, the current time is used
--ago <AGO> — How long ago the project was stopped, e.g. 30m or “1h 30m”; resolves to the time –at would name

`ebb tag`

Manage tags

Usage: ebb tag tag <COMMAND>

Subcommands:

list — List all tags
remove — Remove a tag
rename — Renames a tag

List all tags

Usage: ebb tag list

`ebb tag remove`

Remove a tag

Usage: ebb tag remove <TAG>

Arguments:

<TAG> — Name of the tag

`ebb tag rename`

Renames a tag

Usage: ebb tag rename <OLD_NAME> <NEW_NAME>

Arguments:

<OLD_NAME> — Current tag name
<NEW_NAME> — New tag name

`ebb vacation`

Manage vacation days

Usage: ebb vacation vacation <COMMAND>

Subcommands:

add — Add one or more vacation days
edit — Change the description and portion of an existing vacation day
list — List all vacation days
remove — Remove one or more vacation days

`ebb vacation add`

Add one or more vacation days.

A range spans at most a year. Days without working hours, full-day holidays and days that already have a vacation day are skipped.

Usage: ebb vacation add [OPTIONS] <START_DATE> [END_DATE] [DESCRIPTION]

Arguments:

<START_DATE> — Start date (yyyy-mm-dd)
<END_DATE> — End date, inclusive (yyyy-mm-dd); defaults to the start date for a single day
<DESCRIPTION> — Description of the day off