In this topic:
- Overview
- Enabling invocation of PyCharm operations from the command line
- Comparing files using PyCharm as a diff command line tool
- Merging files using PyCharm as a command line tool
Overview
Besides using PyCharm as an Integrated Development Environment, you can use it as a command line tool for comparing and merging files.
PyCharm executable is platform-dependent: product1.exe
or product1.bat
for Windows and product1.sh
for Linux.
For OS X, the executable is /Applications/product1.app/Contents/OS X/...
.
To add the launcher to your path, add its containing directory /Applications/product1.app/Contents/OS X
.
Enabling invocation of pycharm operations from the command line
-
Using the command line commands, for example,
cd
to change the directory, switch to the directory where the PyCharm executable file is located (PyCharm installation directory). The CMD commands, the name of the PyCharm executable, and its default location depend on the operating system you use. See the lists of CMD commands for Windows, OS X
, Linux
.
-
Specify the location of the PyCharm executable in the
Path
system environment variable. In this case, you will be able to invoke the PyCharm executable and other PyCharm command from any directory.
If you have specified location of the PyCharm executable as a Path
environment variable,
the command will work no matter which directory you are currently in.
Otherwise, you need to switch to the PyCharm installation folder first
or specify full path to the executable.
Comparing files using pycharm as a diff command line tool
- Enable invoking PyCharm operations from the command line.
- Type the following command at the command line prompt:
where
<PyCharm launcher> diff <path to file1> <path to file2>
file1
is your local copy,file2
is the repository version.
Merging files using pycharm as a command line tool
Most often you need to merge three versions of the same file: your local version, the version in the repository or in the upstream, and the base revision, which is the origin for the two diverged versions.
- Enable invoking PyCharm operations from the command line.
- Type the following command at the command line prompt:
where
<PyCharm launcher> merge <path to file1> <path to file2> <path to file3> <path to output>
file1
is your local copy,file2
is the repository version,file3
is the base revision forfile1
andfile2
, andoutput
is the file to save the merge results in (optional).
It is possible to pass just three arguments to the merge tool: <path to file1> <path to file2> <path to output>
.
In this case, the contents of the output will be taken as the base revision:
<PyCharm launcher> merge <path to file1> <path to file2> <path to output> <path to output>