Launching a code inspection from the command line
- Specify the following command line arguments:
- Path to the launcher: specify the full path
to one of the following launchers (which reside under the
bindirectory of your IntelliJ IDEA installation):- For Windows:
inspect.bat - For UNIX and macOS:
inspect.sh
- For Windows:
- Project file path is the full path to
the directory that contains the project to be inspected.
Please note that you have to specify full paths. Relative paths are not accepted!
- Inspection profile path is the full path to the
profile, against which the project should be inspected. The inspection profiles are stored
under
USER_HOME\.IntelliJ IDEAXX\config\inspection - Output path is the full path to an existing directory where the report will be stored.
- Options. You can specify:
- The directory to be inspected
-d <full path to the subdirectory> - The verbosity level of output
-vX, where X is 0 for quiet, 1 for noisy and 2 for extra noisy.
- The directory to be inspected
If SDK is not defined, the inspection will fail. The SDK descriptions should be stored in
config\options\jdk.table.xml. Learn how to configure SDK here. - Path to the launcher: specify the full path
to one of the following launchers (which reside under the
Examples
Windows
"C:\Program Files (x86)\JetBrains\<IntelliJ IDEA home>\bin\inspect.bat" E:\SampleProjects\MetersToInchesConverter E:\Work\MyProject\.idea\inspectionProfiles\Project_Default.xml E:\Work\MyProject\inspection-results-dir -v2 -d E:\SampleProjects\MetersToInchesConverter\subdirectory
Note that your paths should be adjusted to your particular local system.
macOS
/Applications/IntelliJ IDEA.app/Contents/bin/inspect.sh ~/IntelliJ IDEAProjects/MyTestProject ~/Library/Preferences/ideaXX/inspection/Default.xml ~/IntelliJ IDEAProjects/MyTestProject/results-dir -v2
Viewing the results of an offline inspection
If you have performed an offline inspection and exported the inspection results to a directory in the XML format you can always download and view these results.
- Open the project against which the inspection was performed.
- On the main menu, choose Analyze | View Offline Inspection Results.
- In the Select Path dialog box that opens, navigate to the directory that contains inspection results in XML format.
- Click OK. Inspection results display in the Offline View tab in the Inspection Results Tool Window.
Alternatively, you can open the relevant XML file in IntelliJ IDEA or in any other text processor without opening the inspected project.