🍅 Pomodoro CLI

Pomodoro is a Swift command line tool to help you implement the Pomodoro Technique from your terminal.

When I started this project, I wrote a blog post on my motivations on bootstragram.com.

Usage

pomodoro-cli usage example
➜ Usage: pomodoro-cli [options]

CLI pomodoro

Options:
  -d, --duration <value>    The duration of the pomodoro in seconds (100) or in minutes (10m) (default to 25m)
  -h, --help                Show help information
  -m, --message <value>     The intent of the pomodoro (example: email zero)

Hooks

Pomodoro can optionnaly run shell scripts when a pomodoro starts and/or finished.

Sample scripts can be found in the SampleHooks directory.

Journal

A journal of pomodoros is created in ~/.pomodoro-cli/journal.yml.

Installation

To install from sources, Swift is required.

Homebrew and Ruby/Bundler are recommended for an easy installation.

  • make install will install development dependencies;
  • make deploy will build a release binary, move it to /usr/local/bin by default, with default hooks installed;

Check out Makefile for more development convenience commands.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT