Command-line interface | PyCharm Documentation

Launcher for a standalone instance

The installation directory contains batch scripts and executables for launching PyCharm, formatting the source code, and running inspections. To use them from the Command Prompt cmd.exe, add the location of the PyCharm bin folder to the PATH environment variable. For example, if you installed PyCharm to C:\Program Files\JetBrains\PyCharm, you can use the following command:

set PATH=%PATH%;C:\Program Files\JetBrains\PyCharm\bin

This command changes the PATH environment variable for the current shell only (the current instance of cmd.exe). If you want to update it permanently for the current user, run setx:

setx PATH "%PATH%;C:\Program Files\JetBrains\PyCharm\bin"

To update it system-wide for all users, run setx /M instead of setx.

After you configure the PATH variable, you can run the executable from any working directory in the Command Prompt:

pycharm64.exe

Alternatively, you can use the batch script:

pycharm.bat

To run PyCharm from the shell, use the open command with the following options:

-a: Specify the application.
-n: Open a new instance of the application even if one is already running.
--args: Specify additional arguments to pass to the application.

For example, you can run PyCharm.app with the following command:

open -na "PyCharm.app"

You can create a shell script with this command in a directory from your PATH environment variable. For example, create the file /usr/local/bin/pycharm with the following contents:

            #!/bin/sh

            open -na "PyCharm.app" --args "$@"

Make sure you have permissions to execute the script and since /usr/local/bin should be in the PATH environment variable by default, you should be able to run pycharm from anywhere in the shell.

If you do not have permissions to execute the script, run the following:

chmod +x /usr/local/bin/pycharm

On Linux, the installation directory contains the launcher shell script pycharm.sh under bin. For example, if you installed PyCharm to /opt/pycharm, you can run the script using the following command:

/opt/pycharm/bin/pycharm.sh

You can create a symbolic link to the launcher script in a directory from the PATH environment variable. For example, if you want to create a link named pycharm in /usr/local/bin, run the following command:

ln -s /opt/pycharm/bin/pycharm.sh /usr/local/bin/pycharm

Since /usr/local/bin should be in the PATH environment variable by default, you should be able to run the pycharm command from anywhere in the shell.

If you installed PyCharm as a snap package, you can use the corresponding launcher: pycharm-professional or pycharm-community.

Shell scripts generated by the Toolbox App

If you are using the Toolbox App to install and manage JetBrains products, you can use shell scripts for launching your IDEs from the command line.

Toolbox App generates shell scripts automatically and places them to the following folders:

%LOCALAPPDATA%\JetBrains\Toolbox\scripts

By default, the Toolbox App puts shell scripts in a directory from the system PATH environment variable, so you can run the name of the script as a command to launch PyCharm from any working directory.

Change shell scripts location

Open the Toolbox App, click the Toolbox App menu icon in the top right corner, and select Settings.
On the Settings tab, expand the Tools section, and specify another folder in the Shell scripts location field.

Rename shell scripts

If you have several versions of the same IDE, the Toolbox App generates a shell script for each version with a unique name. You can change the name of the shell script for an IDE instance in the settings for this specific instance.

Open the Toolbox App.
Click next to an IDE instance and select Settings.
At the bottom of the Configuration section, change the Shell script name field.

/usr/local/bin

or

~/Library/Application Support/JetBrains/Toolbox/scripts

By default, the Toolbox App puts shell scripts in a directory from the system PATH environment variable, so you can run the name of the script as a command to launch PyCharm from any working directory.

Change shell scripts location

Open the Toolbox App, click the Toolbox App menu icon in the top right corner, and select Settings.
On the Settings tab, expand the Tools section, and specify another folder in the Shell scripts location field.

Rename shell scripts

If you have several versions of the same IDE, the Toolbox App generates a shell script for each version with a unique name. You can change the name of the shell script for an IDE instance in the settings for this specific instance.

Open the Toolbox App.
Click next to an IDE instance and select Settings.
At the bottom of the Configuration section, change the Shell script name field.

~/.local/share/JetBrains/Toolbox/scripts

By default, the Toolbox App puts shell scripts in a directory from the system PATH environment variable, so you can run the name of the script as a command to launch PyCharm from any working directory.

Change shell scripts location

Open the Toolbox App, click the Toolbox App menu icon in the top right corner, and select Settings.
On the Settings tab, expand the Tools section, and specify another folder in the Shell scripts location field.

Rename shell scripts

If you have several versions of the same IDE, the Toolbox App generates a shell script for each version with a unique name. You can change the name of the shell script for an IDE instance in the settings for this specific instance.

Open the Toolbox App.
Click next to an IDE instance and select Settings.
At the bottom of the Configuration section, change the Shell script name field.

Command-line arguments

The launcher script accepts commands, options, and other arguments to modify its behavior. Without any arguments, the script launches PyCharm. If you specify the path to a file or directory, PyCharm will open the specified file or directory. For more information, refer to Open files from the command line.

Commands

diff

Open the diff viewer to see the differences between two specified files.

For more information, refer to Compare files from the command line.

merge

Open the Merge dialog to merge the specified files.

For more information, refer to Merge files from the command line.

format

Apply code style formatting to the specified files.

For more information, refer toFormat files from the command line.

inspect

Perform code inspection on the specified project.

For more information, refer to Run code inspections from the command line.

Options

nosplash

Do not show the splash screen when loading PyCharm.

dontReopenProjects

Do not reopen projects and show the welcome screen. This can help if a project that was open crashes PyCharm.

disableNonBundledPlugins

Do not load manually installed plugins. This can help if a plugin that you installed crashes PyCharm. You will be able to start the IDE and either disable or uninstall the problematic plugin.

--wait

Wait for the files to be closed before returning to the command prompt.

For example, you can open file.txt with the following command:

pycharm64.exe --wait file.txt

The shell will be waiting until file.txt is closed.