goclockify
goclockify copied to clipboard
A terminal-based client for Clockify time tracker
goclockify
Installation
Binary installation
Download a compatible binary for your system and rename it to
goclockify. Then move goclockify into your $PATH somewhere (e.g. /usr/local/bin).
$ mv goclockify /usr/local/bin
Also, from this page, you can download .deb and .rpm packages and install them using your package manager:
# dpkg
$ sudo dpkg -i /path/to/goclockify.deb
$ sudo apt-get install -f
# apt
$ sudo apt install /path/to/goclockify.deb
# rpm
$ sudo rpm –i /path/to/goclockify.rpm
# yum
$ sudo yum localinstall /path/to/goclockify.rpm
# dnf
$ sudo dnf localinstall /path/to/goclockify.rpm
# ...
AUR
goclockify is available on AUR: https://aur.archlinux.org/packages/goclockify/
Install it using yay
$ yay -S goclockify
or clone the git repository
$ clone https://aur.archlinux.org/goclockify.git
$ cd goclockify
$ makepkg -sirc
Via Go
You can also get goclockify via Go:
Note: Go 1.14+ required.
$ go get -u github.com/abgeo/goclockify
$ cd $GOPATH/src/github.com/abgeo/goclockify
$ go install .
Using Snap
goclockify is also available on Snap: https://snapcraft.io/goclockify
$ snap install goclockify
Setup
-
Create a Clockify API Key;
-
Running
goclockifyfor the first time, will create a default config file at~/.config/abgeo/goclockify/config;
Note: The path to the config file will be different if you installgoclockifyusing Snap. Check the error message (Config file: ...).$ goclockify -
Update the config file and set your
clockify_api_token:{ "clockify_api_token": "your_api_key" }
Usage
When everything is set up correctly you can run goclockify with the following command:
$ goclockify
Default Key Mapping
Note: You can change them in your config file.
| Key | Action |
|---|---|
a |
Workplace navigation Up |
z |
Workplace navigation Down |
k, <Up> and <MouseWheelUp> |
Time Entries navigation Up |
j, <Down> and <MouseWheelDown> |
Time Entries navigation Down |
g, <Home> |
Time Entries jump to Top |
G, <End> |
Time Entries jump to Down |
<Enter> |
Display time entry details |
<Delete> |
Delete selected Time Entry |
Ctrl + n |
Create new time entry |
Ctrl + e |
Edit the selected time entry |
<F1>, ? |
Show help message |
<Escape> |
close the 2nd level window, go to the dashboard |
Changelog
Please see CHANGELOG for details.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
Authors
- Temuri Takalandze - Initial work
License
Copyright © 2020 Temuri Takalandze.
Released under the MIT license.