Integration for PyCharm

The ClearML PyCharm Plugin enables syncing a local execution configuration to a remote execution 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.


To install the ClearML PyCharm plugin, do the following:

  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 those settings in the ClearML configuration file.

To set ClearML configuration parameters:

  1. In PyCharm, open Settings.

  2. Click Tools.

  3. Click ClearML.

  4. 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)

  5. Add your ClearML user credentials key/secret.