/raycast-toggl-extension

Primary LanguageJavaScript

Raycast Toggl Extension

This extension lets you start and stop Toggl Track timers from Raycast.

Raycast Gif showing extension

Dependencies

Installation instructions

Instructions on how to set up the directory and how to connect it to Raycast.

Alternatively, you can watch a video tutorial here: https://youtu.be/yAkxNUpfhkA

Set up the extension

  1. Clone or download the directory
  2. Run $ npm install to install dependencies
  3. Create an .env file in the directory
  4. Add your API Token from Toggl to the .env file
  • Go to your Toggl profile
  • Scroll down to the bottom and copy your API Token (you may need to create it first)
  • Add the API token to the .env file like this: API_TOKEN=12345678910111213141516 (where everything after the equals sign is your API Key)
  1. Update the google.js file to match your desired Toggl project
  • Rename the file if you want
  • Update the metadata to match your project (for more help with Raycast script commands, view the Raycast documentation); consider changing the following:
    • @raycast.title (what you’ll type when invoking the script)
    • @raycast.icon (you can add an https url image, an emoji, or a local image)
    • @raycast.description
  • Change PROJECT_NAME to match your project
  • Change the PROJECT_ID to match your project
    • Open the project on Toggl on the web and copy the ID from the end of the URL
    • Example: https://track.toggl.com/3428530/projects/157565167/team
    • In the case above, the project ID is 157565167

Connect project to Raycast

  • Open Raycast.
  • Open the Raycast preferences (⌘ + ,).
  • Open the Extensions tab.
  • Click the + icon and choose Add Script Directory.
  • Navigate to your directory and click Open.

Tips

  1. Add as many projects as you need by duplicating the original google.js file and updating the content as shown in step 5 above.
  2. If you add an alias to the script, after typing the alias, you can enter the optional Description field with the spacebar