https://github.com/abgeo/goclockify
A terminal-based client for Clockify time tracker
https://github.com/abgeo/goclockify
cli clockify golang time-tracker
Last synced: 2 months ago
JSON representation
A terminal-based client for Clockify time tracker
- Host: GitHub
- URL: https://github.com/abgeo/goclockify
- Owner: ABGEO
- License: mit
- Created: 2020-07-13T11:01:41.000Z (almost 5 years ago)
- Default Branch: 1.x
- Last Pushed: 2022-10-29T09:31:27.000Z (over 2 years ago)
- Last Synced: 2025-03-21T22:22:26.829Z (3 months ago)
- Topics: cli, clockify, golang, time-tracker
- Language: Go
- Homepage:
- Size: 940 KB
- Stars: 53
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# goclockify
A terminal based client for Clockify time tracker
[](https://github.com/ABGEO/goclockify/releases)
[](https://github.com/ABGEO/goclockify/blob/1.x/LICENSE)
[](https://aur.archlinux.org/packages/goclockify/)
[](https://snapcraft.io/goclockify)
## Installation
### Binary installation
[Download](https://github.com/ABGEO/goclockify/releases) a compatible binary for your system and rename it to
`goclockify`. Then move `goclockify` into your `$PATH` somewhere (e.g. `/usr/local/bin`).
```bash
$ mv goclockify /usr/local/bin
```
Also, from this page, you can download `.deb` and `.rpm` packages and install them using your package manager:
```bash
# 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
```bash
$ yay -S goclockify
```
or clone the git repository
```bash
$ 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.
```bash
$ 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
```bash
$ snap install goclockify
```
## Setup
1. Create a Clockify [API Key](https://clockify.me/user/settings);
1. Running `goclockify` for 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 install `goclockify` using Snap.
Check the error message (`Config file: ...`).
```bash
$ goclockify
```
1. Update the config file and set your `clockify_api_token`:
```json
{
"clockify_api_token": "your_api_key"
}
```
## Usage
When everything is set up correctly you can run `goclockify` with the following command:
```bash
$ goclockify
```
### Default Key Mapping
**Note**: You can change them in your config file.
| Key | Action |
|--------------------------------------|------------------------------|
| `a` | Workplace navigation Up |
| `z` | Workplace navigation Down |
| `k`, `` and `` | Time Entries navigation Up |
| `j`, `` and `` | Time Entries navigation Down |
| `g`, `` | Time Entries jump to Top |
| `G`, `` | Time Entries jump to Down |
| `` | Display time entry details |
| `` | Delete selected Time Entry |
| `Ctrl + n` | Create new time entry |
| `Ctrl + e` | Edit the selected time entry |
| ``, `?` | Show help message |
| `` | close the 2nd level window, go to the dashboard |
## Changelog
Please see [CHANGELOG](CHANGELOG.md) 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**](https://abgeo.dev) - *Initial work*
## License
Copyright © 2020 [Temuri Takalandze](https://abgeo.dev).
Released under the [MIT](LICENSE) license.