Getting Started

After you complete this four (4) step guide, you will receive weekly emails of the automatically generated time entries (grouped into day and project )

1. Create account

You will need to create an account on so that the plugins have a place to send the time they log.

2. Install and configure iTimeTrack plugin with the API key

To automatically send time logs from your favorite editor, you will need to install the iTimeTrack plugin for your editor. We have plugins ( for a variety of editors including: Visual Studio, JetBrains (IntelliJ, WebStorm…), Atom, Sql Server Management Studio (SSMS) and many more plugins. As an example to install  and configure the Atom plugin, follow these steps:

  • Settings API KEYIn web browser, Copy (to clipboard) your personal API key from Settings | General (!/settings-general). Step by step directions at How to retrieve your iTimeTrack API key.
  • In Atom, install the iTimeTrack plugin by finding the plugin within Atom | Packages | Settings | Install | Search for “iTimeTrack” | Click install
  • iTimeTrack config fileOpen file USER_HOME_DIR/.itimetrack.cfg (in Windws: C:\Users\USER_NAME\.itimetrack.cfg or in Unix: ~/.itimetrack.cfg) and paste the API key right after the line “api_key=”, save file and exit
  • The Atom editor should now be configured and will send heartbeats to the iTimeTrack server.  To test, open a file in Atom, edit it and save.

3. Create Projects

Now we will configure projects in

  • iTimeTrack Settings ProjectsGo to and login | Settings | Projects and click “Add Project”
  • Type in the name of a project (ex “ProjectOne”) and click “Save”
  • Create a second project (ex. “ProjectTwo”)


4. Map Projects to directories

itt-settings-rulesNow we need to map (heartbeat) directories to projects.  We do this so that when a heartbeat is sent when you start working on a file in your editor, the server will know which project to group that in.

  • Go to and login | Settings | Rules and click “Add Rule”
  • Replace the Criteria with the directory on your local machine that contains files for project 1 (ex: “C:\Development\ClientOne\ProjectOne\”)
  • For the Action (Action – then change project to), choose “ProjectOne”
  • Click Save
  • Repeat for your second project

5. Done, while you do work, time entries are automatically generated

You are now done.  While you do your work in the editor, time entries will automatically be generated and tracked for you!

To see it work:

  • Start editing a file in the editor that has the iTimeTrack plugin configured
  • Move around the file and save a few times
  • Using a web browser login to and click “Sync”
    • The “History” tab at the top, should show a green circle with the number of heartbeats (file changes) that were sent…
    • Additionally, after the 15 minutes a time entry will be created, and assigned to the project that had the most time spent on it within that 15 minute time frame

Weekly emails will be sent if you have time entries for that week.  This can be configured in Settings | General Settings

Add other iTimeTrack Plugins to your other editors so that you can track your full 8 hours day automatically.