native/repair-utility/README.md
Repair is the command line utility to troubleshoot startup problems of the IDE.
Repair binary should be launched from the command line if the IDE cannot start.
repair [aspect] [flags] where
| Aspect | Description |
|---|---|
| hashes | Hashes aspect generates(-g) or checks(-c, default) IDE integrity by inspecting checksums of all installation files. |
| Hashes aspect returns Warning if some files are missing, or distribution has redundant files inside | |
| log | Log aspect inspects idea.log file for exceptions and errors generated by plugins. In case of Warnings, it asks to remove caches and configs. |
| plugins | Plugins aspect scans all the installed plugins and suggest fixes if some of them are incompatible or require updates. |
| runtime | Runtime aspect finds the JDK used to start the IDE and checks if it is OK to use. Sets the bundled JDK in case of warnings. |
| vmoptions | Vmoptions aspect finds the .vmoptions file used by the IDE and analyzes its content for suspicious entries. If any of them found, one can edit the file manually, or reset VM options to default. |
If no aspects passed, all aspects will be executed one by one.
| Flag | Description |
|---|---|
| --debug | Enable debug |
| -h , --help | show help for repair utility |
| -n, --no | Only check the installation. All the fixes will be skipped. |
| -y, --yes | Apply all the suggested fixes automatically |
| --path [string] | path to the IDE (default is the IDE where the script is located) |
To show usage overview, execute ./repair --help
To list all available options of an aspect, execute ./repair <aspect> --help
/Applications/IntelliJ IDEA.app/Contents/bin/repair - Checks the current IDE installation through all aspects one-by-one
./repair hashes --path "/Applications/IntelliJ IDEA.app" - Checks all the files of the defined IDE installation for consistency
./repair plugins -y - Find all installed IDEs on the computer and check its plugins. All fixes such as updaying will be executed automatically