JetBrains · Trending

JetBrains/intellij-community

IntelliJ IDEA & IntelliJ Platform

View on GitHub Website / Demo Back to listing

20.7kstars 6.1kforks 100+contributors Java

README.md

[![official JetBrains project](http://jb.gg/badges/official.svg)](https://github.com/JetBrains/.github/blob/main/profile/README.md) [![IntelliJ IDEA build status](https://github.com/JetBrains/intellij-community/actions/workflows/IntelliJ_IDEA.yml/badge.svg?branch=master)](https://github.com/JetBrains/intellij-community/actions/workflows/IntelliJ_IDEA.yml?query=branch%3Amaster) [![PyCharm build status](https://github.com/JetBrains/intellij-community/actions/workflows/PyCharm.yml/badge.svg?branch=master)](https://github.com/JetBrains/intellij-community/actions/workflows/PyCharm.yml?query=branch%3Amaster)

# 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](https://www.jetbrains.com/opensource/idea).

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](https://github.com/JetBrains/intellij-community/blob/master/CONTRIBUTING.md) to get started.

The following conventions will be used to refer to directories on your machine:
* `<USER_HOME>` is your OS user's home directory.
* `<IDEA_HOME>` is the root directory for the **IntelliJ source code**.

---
## 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

- Install [Git](https://git-scm.com/).
- On **Windows**, set these Git options to avoid common issues during cloning:
  ```shell
  git config --global core.longpaths true
  git config --global core.autocrlf input
  ```

### Clone Main Repository

IntelliJ open source repository is available from the [GitHub repository](https://github.com/JetBrains/intellij-community),
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](https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html) page.

You can [clone this project](https://www.jetbrains.com/help/idea/manage-projects-hosted-on-github.html#clone-from-GitHub) using IntelliJ IDEA
(see [Opening the IntelliJ IDEA Source Code in the IDE](#opening-the-intellij-idea-source-code-in-the-ide)).

Alternatively, run the following commands in the terminal:
   ```shell
   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](https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---depthdepth).
> 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:
- Unix: `./getPlugins.sh`
- Windows: `getPlugins.bat`

> [!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](https://bazel.build/) 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](https://plugins.jetbrains.com/plugin/22977-bazel) 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](#running-intellij-idea-in-a-cicd-environment) section.

### Opening the IntelliJ IDEA Source Code in the IDE

**Prerequisites**:
- Install [IntelliJ IDEA 2026.1](https://www.jetbrains.com/idea/download) or newer.
- Install the [Bazel plugin](https://plugins.jetbrains.com/plugin/22977-bazel) (via _Settings | Plugins | Marketplace_).
- If the **Maven** plugin is disabled, [add the path variable](https://www.jetbrains.com/help/idea/absolute-path-variables.html)
  `MAVEN_REPOSITORY` pointing to `<USER_HOME>/.m2/repository` directory.

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](https://www.jetbrains.com/help/idea/managing-plugins.html) 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](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](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](platform/build-scripts/src/org/jetbrains/intellij/build/BuildOptions.kt)

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

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

> [!TIP]
> 
> The `installers.cmd` is used to run [OpenSourceCommunityInstallersBuildTarget](build/src/OpenSourceCommunityInstallersBuildTarget.kt) 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):
```shell
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:
* Working dir: `<IDEA_HOME>/bin`
* VM options:  `-ea`

## Running IntelliJ IDEA from the command line

```shell
./bazel.cmd run //build:idea_community
```

To debug it, set the JVM debug option in the `IJ_JAVA_OPTIONS` environment variable.
The IDE waits until a debugger attaches to port 5005, for example a _Remote JVM Debug_ run configuration:
```shell
IJ_JAVA_OPTIONS='-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=localhost:5005' ./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](platform/build-scripts/src/org/jetbrains/intellij/build/TestingOptions.kt)

```shell
# 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](build/src/CommunityRunTestsBuildTarget.kt) from the command line.
You can also call it directly from IDEA, see run configuration `tests` for an example.

Repository info

Default branch: master
Latest version: pycharm/2026.3
Created: 30/09/2011
Last activity: 11/11/2026
License: Other
Open issues: 176
Watchers: 532

Topics

code-editor ide intellij intellij-community intellij-platform

Contributors

akozlova

25k contributions

develar

22.9k contributions

cdracm

18.8k contributions

yole

17.9k contributions

donnerpeter

17.3k contributions