git.defcon.no Git - trk/blob - concept.txt

   1 trk start <project> (if tracking project: stop-and-start, aka switch)
   2 trk start at <YYYY-MM-DD hh:mm> <project>
   3 trk on <project> (alias for start)
   4
   5   Starts tracking of a project. If 'at' is given, start-time
   6   is overridden to the given time.
   7
   8   Future expansion:
   9   If a project was already tracking, that project will be stopped
  10   at the startingpoint of the new tracking, i.e. implicitly switching.
  11
  12 trk note Comment will be timestamped
  13
  14   Adds a comment/note to the tracking. The note will not
  15   affect tracked time, but will be included in detailed reports.
  16
  17 trk activity <task>
  18 trk activity at <YYYY-MM-DD hh:mm> <task>
  19
  20   Starts tracking of an activity within the project; think task
  21   or sub-projects. Activities will be tallied within the project
  22   like the "main project", while time counts to both activity
  23   and project.
  24
  25   Future:
  26   Only one activity can be ongoing at the same time,
  27   so starting a new activity while one is ongoing stops the current
  28   and starts the new one.
  29
  30 trk main
  31 trk main at <YYYY-MM-DD hh:mm>
  32
  33   Stops tracking ongoing activity, and keeps tracking project.
  34
  35 trk pause <optional description>
  36 trk back
  37
  38   Adds an activity to the project that is not counted on
  39   the project. Pauses will be listed on detailed reports,
  40   but not on terse, standard and verbose reports.
  41
  42 trk charge <customer>
  43
  44   Will set a customer name as meta-information. Setting the
  45   charged customer will replace any previously set value.
  46
  47 trk status
  48
  49   Displays current project, charged customer (if any),
  50   start time for this session, time spent on this session,
  51   time spent on project total,
  52   current activity with start time and time spent this session.
  53
  54 trk stop
  55 trk stop at <YYYY-MM-DD hh:mm>
  56 trk off (alias for stop)
  57
  58   Stops tracking of project, with implicit stopping of any
  59   current activity.
  60
  61 trk report terse <project>
  62 trk report <project>
  63 trk report verbose <project>
  64 tkr report details <project>
  65
  66    Gives a tracking report for the given project.
  67
  68    Terse reports include:
  69      * project name
  70      * charged customer
  71      * total time accumulated
  72
  73    Standard reports include:
  74      * project name
  75      * charged customer
  76      * session start and end datetimes and time elapsed on session
  77      * total time accumulated
  78
  79    Verbose reports include:
  80      * project name
  81      * charged customer
  82      * session start and end datetimes and time elapsed on session
  83      * activity start and end datetimes and time elapesd on activity
  84      * note texts w/datetime
  85      * time accumulated per named task
  86      * total time accumulated
  87
  88    Detailed reports include:
  89      * project name
  90      * charged customer
  91      * session start and end datetimes and time elapsed on session
  92      * activity start and end datetimes and time elapesd on activity
  93      * pauses with start, end, comment and elapsed time
  94      * note texts w/datetime
  95      * time accumulated per named task
  96      * total time accumulated
  97
  98 trk projects
  99
 100    Lists all known project names
 101
 102