aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 5778bcd11a52f15eb0d46c1c3b5c4dc1271ae036 (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
Harvester
=========

A wrapper around [hcl][1] that provides a command line interface similar to
[Timetasker][2].


## Usage
This command will submit a time entry of 4.5 hours for the “example” project:

	$ harvester \
	>    --project example \
	>    --time 4.5 \
	>    --date 2018-01-31 \
	>    --description "Worked on Harvester"

Only the `--project` option is required. Project aliases are defined by `hcl`.
The `--time` option will default to 7 hours if not specified, and `--date` will
default to the current day.


## Requirements

* [hcl][1]
* In order to use the `--date` option, [this patch to hcl is required][3].


## Install
Mac OS X users can install Harvester with Homebrew:

	$ brew install https://raw.githubusercontent.com/teddywing/harvester/master/Homebrew/harvester.rb

On other platforms, grab the code and put the `harvester` script in your `PATH`.
Bash completion for project aliases can be added by sourcing the
`harvester.bash-completion` file in your Bash profile.


## License
Copyright © 2018 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
COPYING file).


[1]: https://github.com/zenhob/hcl
[2]: https://github.com/teddywing/timetasker
[3]: https://github.com/zenhob/hcl/pull/86