Skip to content

WilfulTravesty/streamdeck-clockify

 
 

Repository files navigation

Stream Deck - Clockify

Clockify + Elgato Stream Deck

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

  • 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
StreamDeck.-.Clockify.Demo.mp4

FAQ / Troubleshooting

  • Why am I getting a yellow triangle when pressing the button?
    • Your API Key is likely incorrect
  • 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 match
  • Why can't I select my Workspace and Project in a dropdown menu?
    • Because I was lazy 😅
  • 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
  • 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

About

Clockify Action for the Elgato Stream Deck

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 58.6%
  • C# 22.9%
  • JavaScript 14.4%
  • HTML 3.0%
  • PowerShell 1.1%