-
- Pomo
- -Pomodoro Command Line Interface
- - - - +
+ Pomo
+Pomodoro Command Line Interface
+
🍅 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] @@ -139,84 +34,49 @@
- Once all pomodoros are completed take a longer break [approx 15 - 20 min]
- Repeat
Installation
-Binaries
-Binaries are available for Linux and OSX platforms in the releases section on github.
-Installer Script
-A bash script to download and verify the latest release for Linux and OSX platforms can be run with the following command:
- -curl -L -s https://kevinschoon.github.io/pomo/install.sh | bash /dev/stdin
-Source
- - go get github.com/kevinschoon/pomo
- pomo -v
-Usage
- +curl -L -s https://kevinschoon.github.io/pomo/install.sh | bash /dev/stdin
+Source
+go get github.com/kevinschoon/pomo
+pomo -v
+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 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"
+{
+ "colors": {
+ "my-project": "hiyellow",
+ "another-project": "green"
}
}
-
-
-Integrations
-
+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
-
+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
-
+[module/pomo]
+type = custom/script
+interval = 1
+exec = pomo status
+
Roadmap
- Generate charts/burn down
- ??
-
Credits
-
- pomodoro technique
- logo by rones
@@ -225,5 +85,14 @@ exec = pomo status