Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/coderofsalvation/timetrack.bash

passive timetracking to csv based on bash history + cronjob and patternmatching
https://github.com/coderofsalvation/timetrack.bash

Last synced: 12 days ago
JSON representation

passive timetracking to csv based on bash history + cronjob and patternmatching

Awesome Lists containing this project

README 

        
Timetrack.bash

==============

Effortless timetracking to csv based on bash history + cronjob and patternmatching.






Timetrack.bash will scan your bashhistory periodically on tags and produces a csv.

This can be very handy to get overview, when you spend a lot of time in the console.

The idea is that when you cd to a certain folder, or perform a certain command, it should end up in a timelog.



## Attention UNIX ninjas 



    Usage:



      timetrack track          # scans bash history (usually called by cron)

      timetrack show           # pretty console overview of timelog 

      timetrack add    # manually add csv-row

      timetrack createconfig   # creates config



## Install



First enable shared history of your terminals:



    $ curl https://raw.githubusercontent.com/coderofsalvation/timetrack.bash/master/.bashrc >> ~/.bashrc



Then download and run timetrack



    $ wget https://raw.githubusercontent.com/coderofsalvation/timetrack.bash/master/timetrack 

    $ chmod 755 timetrack

    $ timetrack

    created ~/.timetrack.conf



## Add patterns to scan for



Now add this line to ~/.timetrack.conf (which timetrack created) :



    patterns['git']='git / svn,version management,internal'

    patterns['opensource']='opensource work / research,opensource tooling,internal'

    patterns['eng4/v2']='working on engine v2,development,company Y'

    

## Try it:



lets create some history, the first 2 commands will fail obviously



    $ git push origin master # opensource 

    $ cd /var/www/eng4/v2

    $ vi Engine.cs

    $ CMD_IN_CSV=1 timetrack track

    $



## View the result 



    $ timetrack show 

    date      time      description                 type                client

    --------

    15/04/15  12:33:27  git / svn                   version management  internal

    15/04/15  12:33:27  opensource work / research  opensource tooling  internal

    15/04/15  15:33:28  working on engine v2        development         company Y



This is just a pretty printed version of the generated csvfiles at ~/.timetrack-mm-yyyy.csv



## What happened over there?



Timetrack scans your recent bash history, and it found a match ('git push' e.g.).

In such case it will push it to the csv and call the BashHooks (see below).



Also a comment (`# opensource`) will trigger an entry in the log.

This can be handy to indicate the switch to another project (contextswitching e.g.).



Got it?

Now lets get this baby always running in the background



## Add a cronjob



Finally put it in your cronjob (`crontab -e`):



    */15 * * * * /absolute/path/to/timetrack track 



Optionally use `CMD_IN_CSV=1 /././timetrack track` to include the matching commands as well (warning:more verbose).



## Sweet! What else?



Optionally you can manually add entries to the csv: 



    timetrack add '"deploying project","deployment","project foo",""'



This could be done from withing a git- or svn-hook for instance.



## Great! and now what?



You can import it into gnumeric or excel as a csv and impress your manager:



    $ cat ~/.timetrack-*.conf /tmp/allinone.csv



## Advanced: BashHooks



You can extend the behaviour of timetrack. Lets say you 

want to notify matches and add to a REST api as well:



    ON_MATCH='DISPLAY=:0.0 notify-send' ON_ADD="posttowebservice" timetrack track 



## Todo



* DO: more testing 

* DONTS: stats can be generated using other csv utils / spreadsheet editors



## Dependencies



* bash 4