a9sharvest's Introduction

a9sharvest

a9sharvest is a CLI tool for Harvest.

Installation

$ brew tap anynines/tap
$ brew install a9sharvest

Requirements

Before you can use a9sharvest you need a token and the account ID. You can get both by accessing the developer tools and creating a new token.

Usage

$ export ACCOUNT_ID=12345
$ export TOKEN=12345.pt.Avfe-WEFWEF...D4z

$ export LOG_LEVEL=debug # `debug`, `trace` or empty

# Either TAGS or PATTERN must exist.
# If both, TAGS and PATTERN, are set, TAGS will be applied only.
$ export TAGS="[meeting_orga_lane],[support_lane]"
$ export PATTERN="\[DS-\d+\]"

$ export SKIP_PROJECT_IDS="12345,6789" # do not skip any project by default
$ export ALLOWED_PROJECT_IDS="12345,6789" # only process projects in this list if none empty
$ export ALLOWED_USER_IDS="3344,4444" # empty by default
$ export ALLOWED_TASK_NAMES="Admin,Dev" # empty by default

$ export FROM="20200901" # 14 days ago by default
$ export TO="20200914" # today by default

$ a9sharvest download -o entries.json

$ a9sharvest group -i entries.json
          TAG         | HOURS  |   %
----------------------+--------+--------
  [meeting_orga_lane] |  97.50 | 48.75
  [support_lane]      | 100.50 | 50.25
  [unknown]           |   2.00 |  1.00

$ a9sharvest group -i entries.json -o csv
Tag,Hours,Percentage
[meeting_orga_lane],97.50,48.75
[support_lane],100.50,50.25
[unknown],2.00,1.00

Manual Release Building

git tag -a v1.1.0
GOOS=darwin GOARCH=amd64 go build -ldflags "-X github.com/anynines/a9sharvest/pkg/version.Version=v1.1.0"

Links

a9sharvest's People

Contributors

Stargazers

Watchers

a9sharvest's Issues

Read params from configuration file

When ~/.a9sharvest is present, the configuration params should be read from there.

Tags are not case insensitive

Tags are case sensitive.

Tag sales is in small letters:

➜  a9sharvest git:(add_token_documentation) export TAGS="[standard_lane][sales]"
➜  a9sharvest git:(add_token_documentation) a9sharvest group
[sales] = 0.89
[unknown] = 62.18999999999999
[standard_lane] = 0.5

Tag Sales is camel case:

➜  a9sharvest git:(add_token_documentation) export TAGS="[standard_lane][Sales]"
➜  a9sharvest git:(add_token_documentation) ./a9sharvest group
[unknown] = 64.19
[standard_lane] = 0.5