cnvrg CLI tool is very easy to use inside a terminal session, but not only.
it can be used in many platforms, one of them is PyCharm.
First we need to install BashSupport plugin for PyCharm, this will enable us to run bash command directly from PyCharm. 

Install BashSupport Plugin:

  1. In PyCharm, Open the Settings dialog
  2. In the left-hand pane, select Plugins.
  3. On the Plugins page that opens in the right-hand part of the dialog, click the Install JetBrains plugin or the Browse repositories button.
  4. In the dialog that opens search for BashSupport, and select Download and Install.
  5. Confirm your intention to download and install the selected plugin.
  6. Click Close.
  7. Click OK in the Settings dialog and restart IntelliJ IDEA for the changes to take effect.

After PyCharm restarts you are ready to create cnvrg-cli running configuration.

Create cnvrg-cli running configuration:

  1. Open Run menu
  2. Click on Edit Configurations
  3. On the left panel click on the + button(add new configuration and choose Bash:

You will see the following screen:

4. Under Name - give the configuration a name that will indicate you using cnvrg cli. i.e. run via cnvrg

For Linux / Mac users:


5, Under Script:

  • if you wish to run cnvrg locally, set: cnvrg run -l python script_name.py
  • if you wish to run cnvrg remotely, i.e. on  a cloud machine set: cnvrg run python script_name.py

6. Under interpreter path set /bin/bash or any other interpreter you're using (can be zsh and so on)
7. Under Interpreter options set -c -l (this will load environment variables)
8. Click on Apply and OK

For Windows users:


5, Under Script:

  • To run cnvrg remotely, set:  python script_name.py

6. Under interpreter path set: C:\Ruby25-x6d\bin\cnvrg.bat
(The path could change according to the installation path of the ruby for windows shell)
7. Under Interpreter options set: run
8. Click on Apply and OK

Now you're ready to run cnvrg-cli configuration!

Running cnvrg-cli configuration:

  1. Open Run menu
  2. Click on Run 'cnvrg-cli' (or any other name that you set for the configuration)
  3. cnvrg-cli will run your python script!

Did this answer your question?