Skip to main content

Integration for PyCharm

The ClearML PyCharm plugin enables syncing a local execution configuration to a remote executor machine:

  • Sync local repository information to a remote debug machine.

  • Multiple users can use the same resource for execution without compromising private credentials.

  • Run the ClearML Agent on default VMs/Containers.


  1. Download the latest plugin version from the Releases page.

  2. Install the plugin in PyCharm from local disk:


Optional: ClearML Configuration Parameters#


If you set ClearML configuration parameters (ClearML Server and ClearML credentials) in the plugin, they will override the settings in the ClearML configuration file.

To set ClearML configuration parameters:

  1. In PyCharm, open Settings > Tools > ClearML.

  2. Configure your ClearML server information:

    1. API server (for example: http://localhost:8008)
    2. Web server (for example: http://localhost:8080)
    3. File server (for example: http://localhost:8081)
  3. Add ClearML user credentials key/secret.