intellij-community README

The project's README from github.com/JetBrains/intellij-community. As one markdown file: README.md.

official JetBrains project IntelliJ IDEA build status PyCharm build status

IntelliJ Open Source Repository

This repository is the open-source part of the JetBrains IDEs codebase. It also serves as the basis for IntelliJ Platform development.

These instructions will help you build and run open source parts of IntelliJ Platform / IntelliJ IDEA / PyCharm.

If you are new to the community and would like to contribute code or help others learn, see CONTRIBUTING.md to get started.

The following conventions will be used to refer to directories on your machine:


Getting the Source Code

This section will guide you through getting the project sources and help avoid common issues in Git config and other steps before opening it in the IDE.

Prerequisites

Clone Main Repository

IntelliJ open source repository is available from the GitHub repository, which can be cloned or downloaded as a zip file (based on a branch) into <IDEA_HOME>. The master (default) branch contains the source code which will be used to create the next major version of all JetBrains IDEs. The branch names and build numbers for older releases of JetBrains IDEs can be found on the Build Number Ranges page.

You can clone this project using IntelliJ IDEA (see Opening the IntelliJ IDEA Source Code in the IDE).

Alternatively, run the following commands in the terminal:

git clone https://github.com/JetBrains/intellij-community.git
cd intellij-community

[!TIP]

  • For faster download: If the complete repository history isn't needed, create shallow clone. To download only the latest revision of the repository, add --depth 1 option after clone.
  • Cloning in IntelliJ IDEA also supports creating shallow clone.

Get Android Modules

IntelliJ IDEA requires additional Android modules from separate Git repositories. Run the following script from project root <IDEA_HOME> to get the required modules:

[!IMPORTANT]

Always git checkout the intellij-community and android Git repositories to the same branches/tags.


Building IntelliJ IDEA

These instructions will help you build IntelliJ IDEA from source code, which is the basis for IntelliJ Platform development.

[!IMPORTANT]

IntelliJ IDEA project is currently being migrated to the Bazel build system. The migration is still in progress, so you may encounter some rough edges or temporary issues along the way, mostly related to IDE integration.

  • Building the project using only IDE built-in capabilities is not supported anymore, so make sure the Bazel plugin is installed and enabled.
  • Known issue: some tests are not yet possible to be run with Bazel. In case of any issues, please depend on the tests.cmd script mentioned in the Running IntelliJ IDEA in a CI/CD environment section.

Opening the IntelliJ IDEA Source Code in the IDE

Prerequisites:

Using the latest IntelliJ IDEA, click File | Open and select the <IDEA_HOME>/.bazelproject. If IntelliJ IDEA displays a message about a missing or out-of-date required plugin (e.g., Kotlin), enable, upgrade, or install that plugin and restart IntelliJ IDEA.

Building the IntelliJ IDEA Application

In IntelliJ IDEA, choose Build | Build Project from the main menu.

From the command line, run the bazel-build-all-community.cmd script in the <IDEA_HOME> directory (note: all *.cmd scripts work on both Windows and Unix systems).

To build installation packages, run the installers.cmd script in the <IDEA_HOME> directory. Options to build installers are passed as system properties to installers.cmd command. You may find the list of available properties in BuildOptions.kt

Pass --debug to suspend and wait for the debugger to attach to port 5005.

Installer build examples:

# Build installers only for current operating system:
./installers.cmd -Dintellij.build.target.os=current

[!TIP]

The installers.cmd is used to run OpenSourceCommunityInstallersBuildTarget from the command line. You can also call it directly from IDEA, using run configuration Build IntelliJ IDEA Installers (current OS).

Dockerized Build Environment

To build installation packages inside a Docker container with preinstalled dependencies and tools, run the following command in <IDEA_HOME> directory (on Windows, use PowerShell):

docker build . --target intellij_idea --tag intellij_idea_env
docker run --rm --user "$(id -u)" --volume "${PWD}:/community" intellij_idea_env

[!NOTE]

Please remember to specify the --user "$(id -u)" argument for the container's user to match the host's user. This prevents issues with permissions for the checked-out repository, the build output, if any.


Running IntelliJ IDEA from IDEA

To run the IntelliJ IDEA that was built from source, choose Run | Run... from the main menu and choose the preconfigured run configuration Run //build:idea_community.

To run tests on the build, apply these settings to the Run | Edit Configurations... | Templates | JUnit configuration tab:

Running IntelliJ IDEA from the command line

./bazel.cmd run //build:idea_community

Running IntelliJ IDEA in a CI/CD environment

To run tests outside IntelliJ IDEA, use the tests.cmd command in <IDEA_HOME> directory. Options to run tests are passed as system properties to tests.cmd command. You may find the list of available properties in TestingOptions.kt

# Run specific run configuration:
./tests.cmd -Dintellij.build.test.configurations=ApiCheckTest
# Run a specific test: 
./tests.cmd -Dintellij.build.test.patterns=com.intellij.util.ArrayUtilTest

To debug tests, use: -Dintellij.build.test.debug.enabled=true -Dintellij.build.test.debug.suspend=true -Dintellij.build.test.debug.port=5005.

tests.cmd is used just to run CommunityRunTestsBuildTarget from the command line. You can also call it directly from IDEA, see run configuration tests for an example.

intellij-community (JetBrains/intellij-community)

Searching Database…

Что это такое?Это открытая часть кодовой базы IDE от JetBrains и основа для разработки IntelliJ Platform — тот самый исходный код, из которого собираются IntelliJ IDEA или PyCharm, а не готовая IDE, которую можно просто скачать.
То есть это готовая IDE или исходный код, из которого она делается?Это исходный код. В ветке master лежит код следующей мажорной версии всех IDE JetBrains; вы клонируете репозиторий и собираете IDE из него сами, а не устанавливаете готовый бинарник отсюда.
Как собрать IDE из этого кода?Склонируйте репозиторий через Git (добавьте --depth 1, если полная история не нужна), подтяните Android-модули скриптом getPlugins.sh или getPlugins.bat, затем откройте .bazelproject в IntelliJ IDEA и запустите Build | Build Project — либо выполните скрипт bazel-build-all-community.cmd из командной строки.
Что должно быть установлено перед сборкой?Git для клонирования, а также IntelliJ IDEA 2026.1 или новее, чтобы открыть проект, с включённым плагином Bazel из Settings | Plugins | Marketplace. Для Android-модулей также нужны скрипты getPlugins, и оба репозитория — intellij-community и android — должны быть на одних и тех же ветках или тегах.
Сборка сработает сразу, или стоит ждать шероховатостей?Стоит ждать шероховатостей: проект в процессе миграции на Bazel, и проблемы в основном касаются интеграции с IDE. Сборка только встроенными средствами IDE больше не поддерживается, а часть тестов пока не запускается под Bazel — для них есть запасной вариант, скрипт tests.cmd.
Зачем мне клонировать это вместо того, чтобы просто скачать IntelliJ IDEA?Чтобы пользоваться IDE, этот репозиторий не нужен — он для тех, кто хочет вносить код, помогать другим разобраться или работать над самой IntelliJ Platform. Новым контрибьюторам стоит начать с CONTRIBUTING.md.
Сборка работает на Windows или только на macOS и Linux?Поддерживаются все три основные настольные системы: в README сказано, что все скрипты .cmd работают и на Windows, и на Unix-системах, а для сборки установщиков есть окружение на базе Docker с заранее установленными зависимостями.
Какие IDE на самом деле собираются из этого репозитория?IntelliJ Platform лежит в основе всех IDE JetBrains, а в этом репозитории отдельно описана сборка IntelliJ IDEA и PyCharm. Android-модули, нужные для IntelliJ IDEA, находятся в отдельных Git-репозиториях и подтягиваются скриптами getPlugins.sh или getPlugins.bat.
Могу ли я собрать установщики, не настраивая всё вручную у себя на компьютере?Да. Есть Docker-окружение для сборки с заранее установленными зависимостями и инструментами для создания установочных пакетов; на Windows оно запускается через PowerShell. Передайте аргумент --user, совпадающий с вашим пользователем на хосте, иначе можно нарваться на проблемы с правами доступа к склонированному репозиторию и результатам сборки.
Могу ли я запустить набор тестов из командной строки?Да — tests.cmd запускает CommunityRunTestsBuildTarget вне IntelliJ IDEA для запусков в стиле CI, а параметры передаются как системные свойства, перечисленные в TestingOptions.kt. Флаги вроде -Dintellij.build.test.debug.port=5005 позволяют приостановить выполнение и подключить отладчик.
Вся ли кодовая база распространяется под одной лицензией?Нет. GitHub указывает лицензию репозитория как NOASSERTION — то есть для всей кодовой базы не найдено ни одной стандартной лицензии. Прежде чем переиспользовать её код в своём проекте, посмотрите файлы лицензий в самом репозитории.
Creator
JetBrains
Size
5.8 GB
Stars
20.6K
Age
15y
Commits · 90 Days