99 lines
5.6 KiB
HTML
99 lines
5.6 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="generator" content="Hugo 0.85.0" />
|
|
<meta charset="utf-8">
|
|
<title>Pomo
|
|
</title>
|
|
<link rel="stylesheet" href="/css/main.css">
|
|
<link rel="stylesheet" href="/css/pure.css">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
</head>
|
|
<body>
|
|
|
|
<div class="content">
|
|
|
|
<main>
|
|
<div class="intro">
|
|
<a href="https://github.com/kevinschoon/pomo"> <img class="tomato" src="/tomato.png" /> </a>
|
|
<h1> Pomo </h1>
|
|
<h1> Pomodoro Command Line Interface </h1>
|
|
<img class="demo" src="/demo.gif" />
|
|
</div>
|
|
<div class="readme">
|
|
<!-- raw HTML omitted -->
|
|
<h1 id="-pomo">🍅 pomo</h1>
|
|
<p><img src="https://github.com/kevinschoon/pomo/workflows/pomo/badge.svg" alt="pomo"></p>
|
|
<p><code>pomo</code> is a simple CLI for using the <a href="https://en.wikipedia.org/wiki/Pomodoro_Technique">Pomodoro Technique</a>. There are <a href="https://taskwarrior.org/">some</a> <a href="https://todoist.com/">amazing</a> task management systems but <code>pomo</code> is more of a task <em>execution</em> or <a href="https://en.wikipedia.org/wiki/Timeboxing">timeboxing</a> system. <code>pomo</code> helps you track what you did, how long it took you to do it, and how much effort you expect it to take.</p>
|
|
<h2 id="background">Background</h2>
|
|
<p>The Pomodoro Technique is simple and effective:</p>
|
|
<ul>
|
|
<li>Decide on a task you want to accomplish</li>
|
|
<li>Break the task into timed intervals (pomodoros), [approx. 25 min]</li>
|
|
<li>After each pomodoro take a short break [approx. 3 - 5 min]</li>
|
|
<li>Once all pomodoros are completed take a longer break [approx 15 - 20 min]</li>
|
|
<li>Repeat</li>
|
|
</ul>
|
|
<h2 id="installation">Installation</h2>
|
|
<h3 id="binaries">Binaries</h3>
|
|
<p>Binaries are available for Linux and OSX platforms in the <a href="https://github.com/kevinschoon/pomo/releases">releases section</a> on github.</p>
|
|
<h3 id="installer-script">Installer Script</h3>
|
|
<p>A bash script to download and verify the latest release for Linux and OSX platforms can be run
|
|
with the following command:</p>
|
|
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">curl -L -s https://kevinschoon.github.io/pomo/install.sh | bash /dev/stdin
|
|
</code></pre></div><h3 id="source">Source</h3>
|
|
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">go get github.com/kevinschoon/pomo
|
|
pomo -v
|
|
</code></pre></div><h2 id="usage">Usage</h2>
|
|
<p>Once <code>pomo</code> is installed you need to initialize it’s database.</p>
|
|
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">pomo init
|
|
</code></pre></div><p>Start a 4 pomodoro session at 25 minute intervals:</p>
|
|
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">pomo start -t my-project <span style="color:#e6db74">"write some codes"</span>
|
|
</code></pre></div><h2 id="configuration">Configuration</h2>
|
|
<p>Pomo has a few configuration options which can be read from a JSON file in Pomo’s state directory <code>~/.pomo/config.json</code>.</p>
|
|
<h3 id="colors">colors</h3>
|
|
<p>You can map colors to specific tags in the <code>colors</code> field.</p>
|
|
<p>Example:</p>
|
|
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-json" data-lang="json">{
|
|
<span style="color:#f92672">"colors"</span>: {
|
|
<span style="color:#f92672">"my-project"</span>: <span style="color:#e6db74">"hiyellow"</span>,
|
|
<span style="color:#f92672">"another-project"</span>: <span style="color:#e6db74">"green"</span>
|
|
}
|
|
}
|
|
</code></pre></div><h2 id="integrations">Integrations</h2>
|
|
<h3 id="status-bars">Status Bars</h3>
|
|
<p>The Pomo CLI can output the current state of a running task session via the <code>pomo status</code>
|
|
making it easy to script and embed it’s output in various Linux status bars.</p>
|
|
<h4 id="polybarhttpsgithubcomjaagrpolybar"><a href="https://github.com/jaagr/polybar">Polybar</a></h4>
|
|
<p>You can create a module with the <code>custom/script</code> type and
|
|
embed Pomo’s status output in your Polybar:</p>
|
|
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ini" data-lang="ini"><span style="color:#66d9ef">[module/pomo]</span>
|
|
<span style="color:#a6e22e">type</span> <span style="color:#f92672">=</span> <span style="color:#e6db74">custom/script</span>
|
|
<span style="color:#a6e22e">interval</span> <span style="color:#f92672">=</span> <span style="color:#e6db74">1</span>
|
|
<span style="color:#a6e22e">exec</span> <span style="color:#f92672">=</span> <span style="color:#e6db74">pomo status</span>
|
|
</code></pre></div><h2 id="roadmap">Roadmap</h2>
|
|
<ul>
|
|
<li>Generate charts/burn down</li>
|
|
<li>??</li>
|
|
</ul>
|
|
<h2 id="credits">Credits</h2>
|
|
<ul>
|
|
<li><a href="https://cirillocompany.de/pages/pomodoro-technique/book/">pomodoro technique</a></li>
|
|
<li><a href="https://openclipart.org/detail/262421/tomato-by-rones">logo by rones</a></li>
|
|
<li><a href="http://gohugo.io/">website generate by hugo</a></li>
|
|
<li><a href="https://github.com/calintat/minimal">theme by calintat</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</main>
|
|
|
|
|
|
</div><div id="footer">
|
|
<small>
|
|
2021
|
|
</small>
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|