IntelliJ Shared Indexes Tool Example

Intro

Here you can find examples of the IntelliJ shared indexes tool which simplifies the process of building and uploading project shared indexes.

The main dependency here is com.jetbrains.intellij.indexing.shared:ij-shared-indexes-tool. Also, you can play with the command line version located in com.jetbrains.intellij.indexing.shared:ij-shared-indexes-tool-cli (requires Java 11+ in PATH), just select a version and download a zip file.

These packages allow you to try and understand if shared indexes could be useful for your project. If yes, they can help you to configure your environment for building and uploading project shared indexes either to a server running locally, or any S3-compatible storage.

Usages

CLI can be unpacked and used in the following way:

./bin/ij-shared-indexes-tool-cli <json configuration>

or

./bin/ij-shared-indexes-tool-cli <command> <options>.

Example:

./bin/ij-shared-indexes-tool-cli src/main/resources/validBaseJson.json.

or

./bin/ij-shared-indexes-tool-cli indexes --ij <IDE_DIR> --project <PROJECT_DIR> --base-url https://indexes.mycompany.com.

Json examples and scheme can be found in src/main/resources/.

If CLI is not enough, please check usages of com.jetbrains.intellij.indexing.shared:ij-shared-indexes-tool in main.kt, short.kt and long.kt.

These usages can be adjusted for the particular environment and project, and then run via ./gradlew run (main function is called in this case).

Help

Please read the following documentation for more details.

If you have any questions or suggestions, don't hesitate to file an issue.