summaryrefslogtreecommitdiffstats
path: root/README.markdown
blob: 7151b9266fab0212d13ab66070cc4e88934c555c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# hcl

HCl is a command-line tool for interacting with Harvest time sheets using the
[Harvest time tracking API][1].

## Quick Start

NOTE This software is nowhere near complete. Currently the only implemented
feature is a simple view of today's timesheet. To try it out:

 $ cp hcl_conf.yml.example hcl_conf.yml
 $ $EDITOR hcl_conf.yml
 $ ./bin/hcl show

### Prerequisites

This software depends on the Curb gem. To install:

 $ sudo gem install curb

## Usage

    hcl [opts] show [date]
    hcl [opts] add <project> <task> <duration> [msg]
    hcl [opts] rm [entry_id]
    hcl [opts] start <project> <task> [msg]
    hcl [opts] stop [msg]

## TODO

 * Implement time-tracking API methods:
   - display today's time sheet (done)
   - display any time sheet by date
   - get time sheet entry
   - toggle a timer
   - post a time sheet entry
   - delete a time sheet entry
   - update a time sheet entry
 * command-line configuration
 * search ~/.hcl_config for configuration
 * integrate timesheet functionality into aiaio's [harvest gem][2]

[1]: http://www.getharvest.com/api/time_tracking
[2]: http://github.com/aiaio/harvest/tree/master