15 releases (8 breaking)

new 0.12.1 Sep 24, 2021
0.11.0 Feb 27, 2021
0.9.1 Dec 20, 2020
0.8.0 Nov 20, 2020
0.4.1 Mar 27, 2020

#620 in Command line utilities

34 downloads per month

MIT license

45KB
1K SLoC

Stempel

Build Crates.io

Small utility to store and calculate the time spent at work.

⚠️ v0.10.0 introduces a new storage file format. Run stempel migrate to update your json database to the new format.

Usage

Example for managing one day:

# start working now
stempel start
# start a break five minutes ago
stempel break start --offset 5m-
# optional: break can be canceled:
stempel cancel
# finish break in one hour (only if not canceled above)
stempel break stop --offset 1h+
# Finish the day
stempel stop

For a detailed reference, run stempel help or stempel SUBCOMMAND --help. Available subcommands are:

  • cancels the last break, start or does nothing if no break or start in the storage,
  • break: use start or stop as subcommand to handle breaks,
  • migrate: migrate storage file from old (before 0.10.0) to new format (since v0.10.0)
  • start: start a working period, aborts if you already started previously,
  • stats prints current statistics.
  • stop: checks if a start entry is in the storage file and calculates the working time, aborts if no start entry is found,
  • configure: set some defaults for stempel and save them alongside the database file. Currently available:
    • number of months printed by the statistic command

Options:

--offset

This option allows to specify a positive or negative offset to the current time. In other words, giving the option --offset 10m+ means that the command is executed with the current time plus 10 minutes, 20s- stands for current time minus 20 seconds. The syntax allows [Xh][Xm][Xs](+-) where X can be any number and h|m|s refer to hours, minutes and seconds, respectively.

Some examples:

  • 2h30m4s+: 2 hours, 30 minutes, 4 seconds from now
  • 1h90s-: 1 hour 90 seconds before now
  • 20m30s+: 20 minutes, 30 seconds from now
  • 60s-: one minute before now

--storage

Specifiy a path to the storage file where all work entries are written to. The path defaults to $HOME/.config/stempel.json and is created on the first invocation of the start subcommand.

Features

  • Statistics:
    • statistics of last two months grouped by weeks
    • allow printing only ranges of stats, e.g. months, years...
    • display long hours
  • Tracking: allow to specify start and stop time as cli arg
  • Tracking: cancel started work
  • Specify an offset from current time when starting or stopping
  • Add more possibilities to offset
  • Add configuration options

License

MIT

Dependencies

~5–6.5MB
~135K SLoC