Go to file
Kevin Schoon eb08755797 run tests in ci 2021-07-28 20:06:45 -04:00
.github/workflows run tests in ci 2021-07-28 20:06:45 -04:00
bin improve build support 2018-02-01 16:11:44 -05:00
cmd/pomo restructure project into modules 2020-09-08 11:35:47 -05:00
docs update docs 2021-07-28 20:03:23 -04:00
pkg upgrade termui to v3 2021-07-28 18:52:20 -04:00
www fix broken docs links 2021-07-28 19:52:48 -04:00
.dockerignore add new build environment for cross compile 2019-03-17 15:10:28 -04:00
.gitignore fix missing demo on docs site 2021-07-28 19:58:25 -04:00
.gitmodules add hugo sources 2018-01-22 22:59:03 +08:00
LICENSE update license 2019-01-11 09:26:40 -05:00
Makefile rm release helpers 2021-07-28 20:00:16 -04:00
README.md rm release helpers 2021-07-28 20:00:16 -04:00
go.mod upgrade termui to v3 2021-07-28 18:52:20 -04:00
go.sum upgrade termui to v3 2021-07-28 18:52:20 -04:00
tomato-icon.png refactor run loop, add simple libnotify support, improve notifications, binpack tomato image 2018-01-21 18:35:03 +08:00

README.md

demo

🍅 pomo

pomo

pomo is a simple CLI for using the Pomodoro Technique. There are some amazing task management systems but pomo is more of a task execution or timeboxing system. pomo helps you track what you did, how long it took you to do it, and how much effort you expect it to take.

Background

The Pomodoro Technique is simple and effective:

  • Decide on a task you want to accomplish
  • Break the task into timed intervals (pomodoros), [approx. 25 min]
  • After each pomodoro take a short break [approx. 3 - 5 min]
  • Once all pomodoros are completed take a longer break [approx 15 - 20 min]
  • Repeat

Installation

Source

git clone git@github.com:kevinschoon/pomo.git
cd pomo
make

Usage

Once pomo is installed you need to initialize it's database.

pomo init

Start a 4 pomodoro session at 25 minute intervals:

pomo start -t my-project "write some codes"

Configuration

Pomo has a few configuration options which can be read from a JSON file in Pomo's state directory ~/.pomo/config.json.

colors

You can map colors to specific tags in the colors field.

Example:

{
    "colors": {
        "my-project": "hiyellow",
        "another-project": "green"
    }
}

Integrations

Status Bars

The Pomo CLI can output the current state of a running task session via the pomo status making it easy to script and embed it's output in various Linux status bars.

Polybar

You can create a module with the custom/script type and embed Pomo's status output in your Polybar:

[module/pomo]
type = custom/script
interval = 1
exec = pomo status

Roadmap

  • Generate charts/burn down
  • ??

Credits