Home

Getting Started

Step 1: Generate API key

1. Open your browser and navigate to https://clockify.me/tracker

2. Open profile settings

   

3. Scroll down and create an API key

   

Step 2: Add API Key to extension settings

1. In VS Code press Ctrl + Shift + P to open command palette
2. Type Clockify: Set API key and press Enter
3. Insert your API key and press Enter

Step 3: Open Clockify Explorer

1. Click the Clockify icon in the sidebar panel

   

2. You should see something like this

   

Step 4: Add Client

1. Click the Add icon on the Clients section

   

2. Enter a name for the client and press Enter

Step 5: Add Project

1. Click the Add icon on the Projects section

   

2. Enter a name for the project and press Enter

3. Select a client for the project and press Enter

4. Select a color for the project and press Enter

5. Select whether the project is public or not and press Enter

   • Public: Visible to all workspace members
   • Private: Only visible for the current user

6. Select whether the project is billable or not and press Enter

Step 6: Start tracking

1. Press Ctrl + Shift + P to open command palette
2. Type: Clockify: Start Tracking and press Enter
3. Select a workspace and press Enter
4. Select a project and press Enter
5. Enter a description and press Enter
6. Check whether the current time entry is billable or not and press Enter
7. Select tags and press Enter
8. Tracking should now have been started

Step 7: Stop tracking

1. Press Ctrl + Shift + P to open command palette
2. Type Clockify: Stop Tracking and press Enter
3. Tracking should now have been stopped