today

what did you do today?
git clone git://git.alexkarle.com.com/today
Log | Files | Refs | README | LICENSE

README (1784B) [raw]

      1 TODAY(1)		 General Commands Manual		TODAY(1)
      2 
      3 NAME
      4      today - what did you do today?
      5 
      6 SYNOPSIS
      7      today [-ehi] [-l [NUM]]
      8 
      9 DESCRIPTION
     10      today is a tool for quickly documenting a day's work at the end of
     11      the day.  today has primitive recall capabilities; it's easy to
     12      access yesterday's notes but more complex analysis is left to other
     13      tools like grep(1) and awk(1).  Similarly, establishing any sort of
     14      tagging system is left as an exercise for the reader.
     15 
     16      today uses ed(1) for edits.  This may add a bit of a learning
     17      curve, but the lack of a view of the file provides a distraction
     18      free, append-only mindset for recording whatever is top of mind.
     19 
     20      The options are as follows:
     21 
     22      -e	     Open the log file in your $EDITOR
     23 
     24      -h	     Display the help message and exit
     25 
     26      -i	     Initialize the today repository.
     27 
     28      -l [NUM]
     29 	     List the last NUM days-worth of entries, or all if NUM not
     30 	     given.
     31 
     32 ENVIRONMENT
     33      $TODAY_DIR	     Override the default repo location, $HOME/.today.
     34 
     35      $EDITOR	     Preferred editor for -e flag.
     36 
     37 FILES
     38      $TODAY_DIR	     Git repository
     39 
     40      $TODAY_DIR/log  Log file.	Entries are separated by [YYYY-MM-DD]
     41 		     entries.
     42 
     43 EXAMPLES
     44      One time setup:
     45 
     46 	   $ today -i
     47 
     48      Jot down what you did today:
     49 
     50 	   $ today
     51 	   ed> a
     52 	   * Learned some mdoc(7)
     53 	   * Rewrote today(1)
     54 	   .
     55 	   ed> wq
     56 
     57      View yesterday's tasks:
     58 
     59 	   $ today -l 1
     60 	   [2022-03-02]
     61 	   * wrote some code
     62 	   * went for a walk
     63 	   brag: shipped xyz big feature!
     64 
     65      Search for all brag-document worthy items:
     66 
     67 	   $ today -l | grep '^brag:'
     68 	   brag: shipped xyz big feature!
     69 
     70 SEE ALSO
     71      ed(1), git(1)
     72 
     73 AUTHORS
     74      Alex Karle <alex@alexkarle.com>
     75 
     76 OpenBSD 7.0		      March 3, 2022		     OpenBSD 7.0