AppCode 2020.3 Help

Format files from the command line

AppCode 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 AppCode in the background and applies the formatting. It will not work if another instance of AppCode 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 AppCode (for example, the Shell Script plugin to format shell script files).

AppCode includes a script for running the command-line code formatter. By default, it is located in the application package:

Syntax [<options>] <path ...>

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

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

Non-recursively format all the .xml and .html files in the ~/Data/src directory using code style settings from ~/Data/settings.xml: -s %settings-path% -m *.xml,*.html %path%


-hShow the help message and quit.
-m|-maskSpecify 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|-RProcess specified directories recursively.

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: in the Preferences dialog ⌃⌥S, open the Editor | Code Style page, click The Show Scheme Actions button, and select Export.

  • The .idea/codeStyleSettings.xml file stored in your project directory (for AppCode version 2017.2 and earlier).

  • The .idea/codeStyles/Project.xml file stored in your project directory (for AppCode version 2017.3 and later).

Last modified: 08 March 2021