<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
File: README
— Documentation by YARD 0.9.26
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "README";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="file_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> »
<span class="title">File: README</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><div id='filecontents'><h1 id="doing">doing</h1>
<p><strong>A command line tool for remembering what you were doing and tracking what you've done.</strong></p>
<p><em>If you're one of the rare people like me who find this useful, feel free to <a href="http://brettterpstra.com/donate/">buy me some coffee</a>.</em></p>
<!--README-->
<p>The current version of <code>doing</code> is <!--VER-->2.1.0<!--END VER-->.</p>
<p>Find all of the documentation in the <a href="https://github.com/ttscoff/doing/wiki">doing wiki</a>.</p>
<h2 id="what-and-why">What and why</h2>
<p><code>doing</code> is a basic CLI for adding and listing "what was I doing" reminders in a <a href="https://www.taskpaper.com">TaskPaper-formatted</a> text file. It allows for multiple sections/categories and flexible output formatting.</p>
<p>While I'm working, I have hourly reminders to record what I'm working on, and I try to remember to punch in quick notes if I'm unexpectedly called away from a project. I can do this just by typing <code>doing now tracking down the CG bug</code>. </p>
<p>If there's something I want to look at later but doesn't need to be added to a task list or tracker, I can type <code>doing later check out the pinboard bookmarks from macdrifter</code>. When I get back to my computer --- or just need a refresher after a distraction --- I can type <code>doing last</code> to see what the last thing on my plate was. I can also type <code>doing recent</code> (or just <code>doing</code>) to get a list of the last few entries. <code>doing today</code> gives me everything since midnight for the current day, making it easy to see what I've accomplished over a sleepless night. </p>
<p>Doing has over 30 commands for tracking your status, recording your time, and analyzing the results.</p>
<p>See <a href="https://github.com/ttscoff/doing/wiki">the wiki</a> for installation and usage instructions.</p>
<h2 id="launchbar-alfred">Launchbar/Alfred</h2>
<p>The LaunchBar action requires that <code>doing</code> be available in <code>/usr/local/bin/doing</code>. If it's not (because you're using RVM or similar), you'll need to symlink it there. Running the action with Return will show the latest 9 items from Currently, along with any time intervals recorded, and includes a submenu of Timers for each tag.</p>
<p>Pressing Spacebar and typing allows you to add a new entry to currently. You an also trigger a custom show command by typing "show [section/tag]" and hitting return. Include any command line flags at the end of the string, and if you add text in parenthesis, it will be processed as a note on the entry.</p>
<p>Point of interest, the LaunchBar Action makes use of the <code>-o json</code> flag for outputting JSON to the action's script for parsing.</p>
<!--GITHUB-->
<p>See the <a href="https://brettterpstra.com/projects/doing/">doing project on BrettTerpstra.com</a> for the download.</p>
<!--END GITHUB-->
<!--JEKYLL
download 117 %
-->
<p>Evan Lovely has <a href="http://www.evanlovely.com/blog/technology/alfred-for-terpstras-doing/">created an Alfred workflow as well</a>.</p>
<h2 id="contributing">Contributing</h2>
<p>If you <a href="https://github.com/ttscoff/doing/wiki/Creating-Plugins">create a plugin</a>, custom command, or hook you can share, please <a href="https://brettterpstra.com/contact/">let me know</a>. If I get a few plugin contributions, I'll set up a second repository for them.</p>
<p>Feel free to fork <a href="https://github.com/ttscoff/doing/">the repository</a> on GitHub and make pull requests with changes. Please target the <code>develop</code> branch with pull requests.</p>
<!--END README-->
<hr>
<p>PayPal link: <a href="https://paypal.me/ttscoff">paypal.me/ttscoff</a></p>
<h2 id="changelog">Changelog</h2>
<p>See <a href="https://github.com/ttscoff/doing/blob/master/CHANGELOG.md">CHANGELOG.md</a></p>
</div></div>
<div id="footer">
Generated on Sat Nov 27 13:57:12 2021 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.26 (ruby-3.0.1).
</div>
</div>
</body>
</html>