# 从命令行格式化文件

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/zh-cn/help/clion/llms.txt).

CLion 可以根据配置的代码样式设置 [格式化您的代码](reformat-and-rearrange-code.html)。 您还可以从命令行将代码样式格式应用到指定文件。

命令行格式化工具将在后台启动 CLion 实例并应用格式。 如果另一个 CLion 实例已经在运行，则无法工作。 在这种情况下，您可以从正在运行的实例中执行代码样式格式化。 使用命令行格式化程序对有许多贡献者的大型代码库进行自动化定期维护，以确保一致的编码风格。

要能够格式化文件，请在 CLion 中安装并启用支持相应文件类型的插件（例如，  Shell 脚本  插件用于格式化 shell 脚本文件）。

Windows:

您可以在 [安装目录](directories-used-by-the-ide-to-store-settings-caches-plugins-and-logs.html)下的  `bin` 中找到用于运行CLion的可执行文件。 要将此可执行文件用作命令行启动器，请按照 [命令行界面](working-with-the-ide-features-from-command-line.html) 中的说明将其添加到您的系统  `PATH` 。

语法
: ```PLAINTEXT
: clion64.exe format [<options>] <path ...>
:
: ```

示例
: 使用默认的代码样式设置格式化  `C:\Data\src`  目录中的两个特定文件：
:
:
:
:
: ```SHELL
: clion64.exe format -allowDefaults C:\Data\src\hello.cpp C:\Data\src\world.cpp
:
: ```
:
:
:
: 递归格式化  `C:\Data\src`  目录中的所有文件，包括所有子目录，使用默认代码样式设置：
:
:
:
:
: ```SHELL
: clion64.exe format -allowDefaults -r C:\Data\src
:
: ```
:
:
:
: 非递归格式化  `.cpp`  和  `.h`  文件并使用  `C:\Data\settings.xml`  中的代码样式设置格式化  `C:\Data\src`  目录下的所有文件：
:
:
:
:
: ```SHELL
: clion64.exe format -s C:\Data\settings.xml -m *.cpp,*.h C:\Data\src
:
: ```

macOS:

CLion 包含一个用于运行命令行代码格式化工具的脚本。 默认情况下，它位于应用程序包中：  `CLion.app/Contents/bin/format.sh`

语法
: ```PLAINTEXT
:
: ./format.sh [<options>] <path ...>
:
: ```

示例
: 使用默认的代码样式设置格式化  `~/Data/src`  目录中的两个特定文件：
:
:
:
:
: ```SHELL
:
: ./format.sh -allowDefaults ~/Data/src/hello.html ~/Data/src/world.html
:
: ```
:
:
:
: 递归格式化  `~/Data/src`  目录中的所有文件，包括所有子目录，使用默认代码样式设置：
:
:
:
:
: ```SHELL
:
: ./format.sh -allowDefaults -r ~/Data/src
:
: ```
:
:
:
: 非递归格式化  `.cpp`  和  `.h`  文件并使用  `~/Data/settings.xml`  中的代码样式设置格式化  `~/Data/src`  目录下的所有文件：
:
:
:
:
: ```SHELL
:
: format.sh -s ~/Data/settings.xml -m *.cpp,*.h ~/Data/src
:
: ```

Linux:

您可以在 [安装目录](directories-used-by-the-ide-to-store-settings-caches-plugins-and-logs.html)下的  `bin` 中找到用于运行CLion的脚本。 要将此脚本用作命令行启动器，请按照 [命令行界面](working-with-the-ide-features-from-command-line.html) 中的说明将其添加到您的系统  `PATH` 。

语法
: ```PLAINTEXT
: clion.sh format [<options>] <path ...>
:
: ```

示例
: 使用默认的代码样式设置格式化  `~/Data/src`  目录中的两个特定文件：
:
:
:
:
: ```SHELL
: clion.sh format -allowDefaults ~/Data/src/hello.cpp ~/Data/src/world.cpp
:
: ```
:
:
:
: 递归格式化  `~/Data/src`  目录中的所有文件，包括所有子目录，使用默认代码样式设置：
:
:
:
:
: ```SHELL
: clion.sh format -allowDefaults -r ~/Data/src
:
: ```
:
:
:
: 非递归格式化  `.cpp`  和  `.h`  文件并使用  `~/Data/settings.xml`  中的代码样式设置格式化  `~/Data/src`  目录下的所有文件：
:
:
:
:
: ```SHELL
: clion.sh format -s ~/Data/settings.xml -m *.cpp,*.h ~/Data/src
:
: ```

## 选项

|  选项  |  描述  |
| --- | --- |
|   `-h`   |  显示帮助信息后退出。  |
|   `-m\|-mask`   |  请指定一个逗号分隔的文件掩码列表，以定义要处理的文件。 您可以使用  `*` （任何字符串）和  `?` （任何单个字符）通配符。  |
|   `-r\|-R`   |  递归处理指定目录。  |
|   `-s\|-settings`   |     指定用于格式化的代码样式设置文件。 这可以是以下之一：        * 包含导出代码样式设置的文件：打开 编辑器｜代码样式 设置页面 `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `⌘ Comma` (Xcode), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (ReSharper), `⌘ Comma` (ReSharper (macOS)), `Ctrl+Alt+S` (QtCreator), `⌘ Comma` (QtCreator (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS))，点击 !["显示方案操作"按钮](https://resources.jetbrains.com/help/img/idea/2026.3/Project.xml` 文件（适用于 CLion 2017.3 及更高版本）。      如果未指定此选项，该文件将被跳过。 如果在某个父文件夹中有项目，其设置将被隐式使用，以及 EditorConfig。     |
|   `-allowDefaults`   |  在未为文件或一组文件定义代码风格时，使用默认代码风格设置：当  `-s` 未设置且文件不属于任何项目时。 否则，该文件或文件将被忽略。  |
|   `-charset`   |     请保留编码并强制执行用于读取和写入源文件的字符集，例如：  `-charset ISO-8859-15` 。       如果命令行格式器无法正确处理源文件中的特殊字母，此选项非常有用。     |
|   `-d\|-dry`   |  在验证模式下运行格式化程序。 格式化程序将在内存中执行相同的格式化操作，如果任何格式化文件与原始文件不同，将以非零状态退出。  |

