1- # Mite-go
1+ # Mite
22
3- A [ Mite ] ( https://mite.yo.lk/en/ ) time tracking command line interface.
3+ A [ mite ] ( https://mite.yo.lk/en/ ) time tracking command line interface.
44
55## Setup
66
7- 1 . Grab a release from https://github.com/leanovate/mite-go /releases for your operating system and unpack it into your
7+ 1 . Grab a release from https://github.com/leanovate/mite/releases for your operating system and unpack it into your
88$PATH (or %PATH% on windows).
9- 2 . Setup ` mite-go ` to use your API key by:
9+ 2 . Make sure that the ` mite ` command is executable by executing ` mite version ` in your shell
10+ 3 . Setup ` mite ` to use your API key by:
1011 1 . visiting https://"your account name here".mite.yo.lk/myself and note down the API key
1112 2 . executing the following commands
12- ` mite-go config api.key="your API key here" `
13- ` mite-go config api.url=https://"your account name here".mite.yo.lk `
14- 3 . Optional: set a default project & service by:
15- 1 . retrieving the desired project & service id by executing ` mite-go projects ` and ` mite-go services ` respectively
16- 2 . configuring those id's as default by executing ` mite-go config projectId="the project id" ` and ` mite-go config serviceId="the service id" `
17- 4 . Optional: mite-go allows you to define often used project & service combinations as activities. You can configure them by:
13+ ` mite config api.key="your API key here" `
14+ ` mite config api.url=https://"your account name here".mite.yo.lk `
15+ 4 . Optional: set a default project & service by:
16+ 1 . retrieving the desired project & service id by executing ` mite projects ` and ` mite services ` respectively
17+ 2 . configuring those id's as default by executing ` mite config projectId="the project id" ` and ` mite config serviceId="the service id" `
18+ 5 . Optional: mite allows you to define often used project & service combinations as activities. You can configure them by:
1819 1 . think of a good name for the activity
19- 2 . run ` mite-go config activity."your activity name here".projectId="the project id" `
20- 3 . run ` mite-go config activity."your activity name here".serviceId=<the service id" `
20+ 2 . run ` mite config activity."your activity name here".projectId="the project id" `
21+ 3 . run ` mite config activity."your activity name here".serviceId=<the service id" `
2122 4 . the activity names can be used in the ` entries create ` and ` entries edit ` sub-commands
2223
2324# Usage
@@ -33,4 +34,4 @@ Supported sub-commands:
3334| services | list & adds services |
3435| tracker | starts, stops and shows the status of the tracker |
3536
36- For an up-to-date usage check ` mite-go help ` .
37+ For an up-to-date usage check ` mite help ` .
0 commit comments