Format files from the command line

PyCharm can format your code according to the configured code style settings. You can also apply your code style formatting to the specified files from the command line.

The command-line formatter launches an instance of PyCharm in the background and applies the formatting. It will not work if another instance of PyCharm is already running. In this case, you can perform code style formatting from the running instance. Use the command-line formatter for automated regular maintenance of a large codebase with many contributors to ensure a consistent coding style.

To be able to format files, install and enable plugins with support for the corresponding file types in PyCharm (for example, the Shell Script plugin to format shell script files).

You can find the executable for running PyCharm in the installation directory under bin. To use this executable as the command-line launcher, add it to your system PATH as described in Command-line interface.

Syntax

pycharm64.exe format [<options>] <path ...>

Examples

Format two specific files from the C:\Data\src directory using the default code style settings:

                pycharm64.exe format -allowDefaults C:\Data\src\hello.html C:\Data\src\world.html
            

Recursively format all files in the C:\Data\src directory including all subdirectories using the default code style settings:

pycharm64.exe format -allowDefaults -r C:\Data\src

Non-recursively format all the .xml and .html files in the C:\Data\src directory using code style settings from C:\Data\settings.xml:

pycharm64.exe format -s C:\Data\settings.xml -m *.xml,*.html C:\Data\src

PyCharm includes a script for running the command-line code formatter. By default, it is located in the application package: PyCharm.app/Contents/bin/format.sh

Syntax

./format.sh [<options>] <path ...>

Examples

Format two specific files from the ~/Data/src directory using the default code style settings:

./format.sh -allowDefaults ~/Data/src/hello.html ~/Data/src/world.html

Recursively format all files in the ~/Data/src directory including all subdirectories using the default code style settings:

./format.sh -allowDefaults -r ~/Data/src

Non-recursively format all the .xml and .html files in the ~/Data/src directory using code style settings from ~/Data/settings.xml:

./format.sh -s ~/Data/settings.xml -m *.xml,*.html ~/Data/src

You can find the script for running PyCharm in the installation directory under bin. To use this script as the command-line launcher, add it to your system PATH as described in Command-line interface.

Syntax

pycharm.sh format [<options>] <path ...>

Examples

Format two specific files from the ~/Data/src directory using the default code style settings:

pycharm.sh format -allowDefaults ~/Data/src/hello.html ~/Data/src/world.html

Recursively format all files in the ~/Data/src directory including all subdirectories using the default code style settings:

pycharm.sh format -allowDefaults -r ~/Data/src

Non-recursively format all the .xml and .html files in the ~/Data/src directory using code style settings from ~/Data/settings.xml:

pycharm.sh format -s ~/Data/settings.xml -m *.xml,*.html ~/Data/src

Options

Option	Description
`-h`	Show the help message and quit.
`-m\|-mask`	Specify a comma-separated list of file masks that define the files to be processed. You can use the `*` (any string) and `?` (any single character) wildcards.
`-r\|-R`	Process specified directories recursively.
`-s\|-settings`	Specify the code style settings file to use for formatting. This can be one of the following: A file with the exported code style settings: open the Editor \| Code Style page of settings `Ctrl+Alt+S`, click , and select Export. The .idea/codeStyleSettings.xml file stored in your project directory (for PyCharm version 2017.2 and earlier). The .idea/codeStyles/Project.xml file stored in your project directory (for PyCharm version 2017.3 and later). The formatter also looks for .editorconfig files in the parent directories and applies them for formatting on top of the PyCharm code style settings. In this case, if formatting settings from EditorConfig overlap with the settings from your code style scheme, PyCharm will use the settings from EditorConfig. The remaining settings will be taken from your code style scheme. For more information, refer to Manage code style on a directory level with EditorConfig. If this option is not specified, the file will be skipped. If there is a project in one of the parent folders, its settings will be used implicitly as well as EditorConfig.
`-allowDefaults`	Use the default code style settings when the code style is not defined for a file or a group of files: when `-s` is not set and the file does not belong to any project. Otherwise, the file or files will be ignored.
`-charset`	Preserve encoding and enforce the charset for reading and writing source files, for example: `-charset ISO-8859-15`. This option is useful if the command-line formatter cannot correctly process special letters in a source file.
`-d\|-dry`	Run the formatter in the validation mode. The formatter will perform the same formatting operations in memory and will exit with a non-zero status in case any of the formatted files differs from the original one.

Last modified: 31 October 2024