Skip to content

Reference

This page provides reference documentation for hours.

hours

A minimalistic work time logger for the command line.

Usage:

hours [OPTIONS] COMMAND [ARGS]...

Options:

  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.
clients

Manage clients

Usage:

hours clients [OPTIONS] COMMAND [ARGS]...
add

Add a client

Usage:

hours clients add [OPTIONS]

Options:

  -n, --name TEXT      Client name  [required]
  -r, --rate FLOAT     Hourly rate  [required]
  -c, --currency TEXT  Currency  [required]
list

List clients

Usage:

hours clients list [OPTIONS]
remove

Remove a client

Usage:

hours clients remove [OPTIONS]

Options:

  -n, --name TEXT  Client name  [required]
update

Update a client

Usage:

hours clients update [OPTIONS]

Options:

  -n, --name TEXT      Client name  [required]
  -r, --rate FLOAT     Hourly rate
  -c, --currency TEXT  Currency
export

Create an XLS report of the work log entries

Usage:

hours export [OPTIONS]

Options:

  -c, --client TEXT      Client name  [required]
  -o, --out PATH         Output path, the default name is the year and the
                         month of the given interval
  -f, --from [%Y-%m-%d]  From day (ISO format), default: first day of the
                         previous month  [default: 2023-12-01]
  -t, --to [%Y-%m-%d]    To day (ISO format), default: first day of the actual
                         month  [default: 2024-01-01]
log

Log worked hours.

Usage:

hours log [OPTIONS]

Options:

  -c, --client TEXT      Client name
  -p, --project TEXT     Project name
  -t, --task TEXT        Task name
  -d, --date [%Y-%m-%d]  Day (ISO format)  [default: 2024-01-03]
  -h, --hours FLOAT      Task name  [default: 8.0]
  -l, --duplicate-last   Duplicate last entry for today, and overwrite values
                         if specified
remove

Remove a work log entries

Usage:

hours remove [OPTIONS] IDS...

Options:

  IDS...  Entry ids to remove  [required]
report

List work log entries

Usage:

hours report [OPTIONS]

Options:

  -c, --client TEXT      Client name
  -f, --from [%Y-%m-%d]  From day (ISO format), default: first day of the
                         month  [default: 2024-01-01]
  -t, --to [%Y-%m-%d]    To day (ISO format), default: tomorrow  [default:
                         2024-01-04]
  -a, --all              Show all entries
update

Log worked hours.

Usage:

hours update [OPTIONS]

Options:

  -i, --id INTEGER       Entry id  [required]
  -p, --project TEXT     Project name
  -t, --task TEXT        Task name
  -d, --date [%Y-%m-%d]  Day (ISO format)
  -h, --hours FLOAT      Task name