Run code inspections from the command line
When working in the PyCharm editor, it constantly runs code inspections to find and highlight syntax errors, dead code, possible bugs, bad coding style, and so on. You can also run all the configured inspections from the command line, without opening your project in PyCharm. This way you can perform regular code analysis as a part of your development process, which is especially important for large projects with big teams. Inspection results can be stored as an XML, JSON, or plain text file with a report.
- Syntax
- pycharm.bat inspect <project> <inspection-profile> <output> [<options>]
- Example
-
Inspect the C:\MyProject\src directory of the C:\MyProject project using the C:\MyProject\.idea\inspectionProfiles\MyProfile.xml profile with maximum verbosity, and save results to an XML file under C:\MyProject\InspectionResults:
pycharm.bat inspect C:\MyProject C:\MyProject\.idea\inspectionProfiles\MyProfile.xml C:\MyProject\InspectionResults -v2 -d C:\MyProject\src
- Syntax
- pycharm inspect <project> <inspection-profile> <output> [<options>]
- Example
-
Inspect the ~/MyProject/src directory of the ~/MyProject project using the ~/MyProject/.idea/inspectionProfiles/MyProfile.xml profile with maximum verbosity, and save results to an XML file under ~/MyProject/InspectionResults:
pycharm inspect ~/MyProject ~/MyProject/.idea/inspectionProfiles/MyProfile.xml ~/MyProject/InspectionResults -v2 -d ~/MyProject/src
- Syntax
- pycharm.sh inspect <project> <inspection-profile> <output> [<options>]
- Example
-
Inspect the ~/MyProject/src directory of the ~/MyProject project using the ~/MyProject/.idea/inspectionProfiles/MyProfile.xml profile with maximum verbosity, and save results to an XML file under ~/MyProject/InspectionResults:
pycharm.sh inspect ~/MyProject ~/MyProject/.idea/inspectionProfiles/MyProfile.xml ~/MyProject/InspectionResults -v2 -d ~/MyProject/src
Options
Option | Description |
|---|---|
-d | Specify the full path to the subdirectory if you don't want to inspect the whole project. |
-format | Specify the format of the output file with inspection results: |
-v | Set the verbosity level of the output:
|
Inspection profiles
An inspection profile is an .xml file that specifies enabled inspections and their options.
By default, project inspection profiles are stored in the project directory: .idea/inspectionProfiles.
Global IDE inspection profiles are stored in the IDE configuration directory under inspection.
Inspection results
You can open the generated XML file with inspection results in PyCharm or any text editor as a regular file. However, it is more convenient to analyze it using the Offline View of the Inspection Results Tool Window:
View inspection results
Open the project for which you ran the inspection.
From the main menu, choose .
Select the XML file with the inspection results and click OK.