Project

jog

0.0
No release in over 3 years
Low commit activity in last 3 years
Jog is a simple command-line tool that simplifies the process of logging what you've worked on, storing plain-text files in a sensible file structue.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

Jog

Simple command-line tool for logging what you've been up to in plain text files.

Create / edit log entry for today

> jog today

By default, this will create a blank file at ~/jog/YYYY/MM/DD.txt' and open it with the editor specified by your EDITOR environment variable (or vim, if none is set). If the file already exists, it will be opened in your editor.

Configuration

When run, jog will walk up your directory tree from your current working directory looking for .jogrc and .jogtemplate. If it can't find them, it will look in your home directory. If they don't exist there, it will use the built-in defaults.

To view your current configuration, run jog config:

> jog config
Config
------
{:root=>"/Users/tyson/Dropbox/log",
 :path_format=>"%Y/%B/%d.txt"}

Template
--------
---
Date: <%= Time.now.strftime( "%B %-d, %Y" ) %>
Time: <%= Time.now.strftime( "%-I:%M%P %Z" ) %>
---

.jogrc

Example:

root: ~/Dropbox/log
path_format: '%Y/%B/%d.txt'

.jogtemplate

Jog template files are processed through ERB at runtime. Example:

---
Date: <%= Time.now.strftime( "%A %B %-d, %Y" ) %>
Time: <%= Time.now.strftime( "%-I:%M%P %Z" ) %>
---

Changelog

  • 0.0.6 - Fix nil template when no .jogtemplate is provided, fix for .jogrc being used as template when .jogtemplate wasn't present.
  • 0.0.5 - Initial release.