Stream Deck - Clockify
![Clockify + Elgato Stream Deck](https://github.com/eXpl0it3r/streamdeck-clockify/raw/master/Docs/Clockify-GitHub-Banner.png)
This plugin allows you to track, start and stop Clockify timers on your Elgato Stream Deck.
Download
Until the plugin is available in the Stream Deck Store, you can download a copy from the GitHub release pages.
Setup
- Basic
- Title: Override the title being set by the plugin, leave empty otherwise
- API Key: (required) Provide your 48 characters long Clockify API Key, which is required for the plugin to work
- Workspace Name: (required) Write the name of the workspace you want to run/track timers in
- Project Name: (optional) Provide the name of an existing project to run/track a timer for
- Task Name: (optional) Set the name of the project specific task
- Timer Name: (optional) Specify a name for the timer you want to run/track
- Advanced
- Client Name: (optional) Set the client name assigned to the specified project
- Title Format: (optional) Specify the format for the title to be displayed on the button.
- This can include any of:
{workspaceName}
: The workspace name
{projectName}
: The project name
{taskName}
: The task name
{timerName}
: The timer name
{clientName}
: The client name
{timer}
: The current timer value when running. Blank when not running
- Server Url: (required) Change from the default URL to the API URL of your own/company instance
https://user-images.githubusercontent.com/920861/132741561-6f9f3ff0-a920-408d-8279-579840ce0a6b.mp4
FAQ / Troubleshooting
- Why am I getting a yellow triangle when pressing the button?
- Your API Key is likely incorrect
- If you have clients assigned to your project, make sure they're configured in the Stream Deck
- Why am I not seeing the running timer on my button?
- Make sure you haven't set a title, as this will override any other content
- Make sure the API Key, Workspace name and optional the project and timer name
- Why does the timer always start with a negative number?
- This can happen when your local computer time isn't in sync with the Clockify server time
- Make sure you synchronize your clock with a time server
- Why does it always take some seconds to show the timer running?
- Due to API rate limits, there's some magical caching going on, leading to certain delays
- Why can't I select my Workspace and Project in a dropdown menu?
- Where can I find the logs?
- Windows:
%appdata%\Elgato\StreamDeck\Plugins\dev.duerrenberger.clockify.sdPlugin\Windows\pluginlog.log
- macOS:
~/Library/Application Support/com.elgato.StreamDeck/Plugins/dev.duerrenberger.clockify.sdPlugin/macOS/pluginlog.log
- IT DOESN'T WORK, WHY?!?
Credits
- Feel free to star this repository and follow me on Twitter
- Thanks to Bar Raiders for the great tooling and community
- Shout-out to Hugh Macdonald for adding the text formatting feature!
- Took some inspirations from the Toggl plugin
- Using a CC0 licensed Timer image for the Time Tracking category
- Talking to Clockify with the Clockify.Net library
- And thanks to Clockify for providing an excellent time tracking tool for free
License
This project is licensed under the MIT License - see the LICENSE file for details