Command Line Code Inspector
Launching a code inspection from the command line
To launch 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
bin
directory of your RubyMine installation):- For Windows:
rinspect.bat
- For UNIX and macOS:
rinspect.sh
- For Windows:
- Project file path is the full path to the directory that contains the project to be inspected.
- 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\.RubyMineXX\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
- 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\<RubyMine home>\bin\inspect.bat" C:\SamplesProjects\EmptyProject\anagram.rb E:\Work\MyProject\.idea\inspectionProfiles\Project_Default.xml C:\SamplesProjects\EmptyProject\ -v2
Note that your paths should be adjusted to your particular local system.
macOS
/Applications/RubyMine.app/bin/rinspect.sh ~/IdeaProjects/MyTestProject ~/Library/Preferences/rubymineXX/inspection/Default.xml ~/RubyMineProjects/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.
To view the results of an offline inspection, follow these steps
- 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.
Last modified: 4 April 2018