JetBrains Product Documentation

https://www.jetbrains.com/help
Admin
Comprehensive documentation for all JetBrains products, languages, and tools, including AI...
Tokens:8,650,423
Snippets:87,053
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Get help page for Qodana installer CLI

Source: https://www.jetbrains.com/help/qodana/shl-docker-configuration.html

Retrieves the help page for any available command in the Qodana Self-Hosted installer CLI.

```bash
docker run \
    -v /var/run/docker.sock:/var/run/docker.sock \
    quay.io/jetbrains/qodana-installer-cli:latest \
    help
```

--------------------------------

### Example environment.json configuration

Source: https://www.jetbrains.com/help/toolbox-app/add-remote-ide-to-tba.html

Example JSON configuration for the environment.json file, showing how to disable installation, enable log collection, specify tool locations, and disallow specific tools.

```json
{
    "tools": {
        "allowInstallation": false,
        "allowLogCollection": true,
        "location": [
            {"path": "/path/to/tool", "levels": 1}
        ],
        "disallowed": [
            {"type": "RustRover"},
            {"type": "CLion", "builds": ["252.23892.426"]}
        ]
    }
}
```

--------------------------------

### Install IntelliJ IDEA Ultimate 231.8770.65

Source: https://www.jetbrains.com/help/toolbox-app/toolbox-app-cli.html

Example command to install a specific IDE version using the Toolbox App CLI.

```bash
java -jar tb-cli.jar install IU 231.8770.65
```

--------------------------------

### Start YouTrack Docker container (Windows)

Source: https://www.jetbrains.com/help/youtrack/server/stop-and-start-youtrack.html

Run this command to start a YouTrack container on Windows. It mounts data, conf, logs, and backups directories, maps port 8080, and uses the `jetbrains/youtrack:<version>` image. The `-it` flag attaches the terminal to the container output.

```bash
docker run -it --name youtrack-server-instance `
-v <path to data directory>:/opt/youtrack/data `
-v <path to conf directory>:/opt/youtrack/conf `
-v <path to logs directory>:/opt/youtrack/logs `
-v <path to backups directory>:/opt/youtrack/backups `
-p <port on host>:8080 `
jetbrains/youtrack:<version>
```

--------------------------------

### Start YouTrack Docker container (Linux/macOS)

Source: https://www.jetbrains.com/help/youtrack/server/stop-and-start-youtrack.html

Run this command to start a YouTrack container. It mounts data, conf, logs, and backups directories, maps port 8080, and uses the `jetbrains/youtrack:<version>` image. The `-it` flag attaches the terminal to the container output.

```bash
docker run -it --name youtrack-server-instance \
-v <path to data directory>:/opt/youtrack/data \
-v <path to conf directory>:/opt/youtrack/conf \
-v <path to logs directory>:/opt/youtrack/logs \
-v <path to backups directory>:/opt/youtrack/backups \
-p <port on host>:8080 \
jetbrains/youtrack:<version>
```

--------------------------------

### Enable Hyper-V to start automatically with bcdedit

Source: https://www.jetbrains.com/help/youtrack/standalone/youtrack-docker-installation.html

Run this command to configure the Hyper-V hypervisor to launch automatically at boot, which is a prerequisite for using Hyper-V isolation with the Docker container.

```powershell
bcdedit /set hypervisorlaunchtype auto
```

--------------------------------

### Enable YouTrack service on system boot

Source: https://www.jetbrains.com/help/youtrack/server/run-docker-container-as-service.html

Command to enable the docker.youtrack service to start automatically on system boot.

```bash
systemctl enable docker.youtrack
```

--------------------------------

### Run YouTrack as a systemd service on Linux

Source: https://www.jetbrains.com/help/youtrack/server/run-docker-container-as-service.html.md

Create a systemd service descriptor file at /etc/systemd/system/docker.youtrack.service to run YouTrack as a service on Linux. Enable the service to start on boot with systemctl enable docker.youtrack, and manage it manually with sudo service docker.youtrack stop/start.

```CONSOLE
[Unit]
Description=YouTrack Service
After=docker.service
Requires=docker.service

[Service]
TimeoutStartSec=0
Restart=always
ExecStartPre=-/usr/bin/docker exec %n stop
ExecStartPre=-/usr/bin/docker rm %n
ExecStartPre=/usr/bin/docker pull jetbrains/youtrack:<version>
ExecStart=/usr/bin/docker run --rm --name %n \
-v <path to data directory>:/opt/youtrack/data \
-v <path to conf directory>:/opt/youtrack/conf \
-v <path to logs directory>:/opt/youtrack/logs \
-v <path to backups directory>:/opt/youtrack/backups \
-p <port on host>:8080 \
--stop-timeout 60 \
jetbrains/youtrack:<version>
ExecStop=/usr/bin/docker exec %n stop

[Install]
WantedBy=default.target
```

```CONSOLE
systemctl enable docker.youtrack
```

```CONSOLE
sudo service docker.youtrack stop
sudo service docker.youtrack start
```

--------------------------------

### Update Hub URL with docker run configure --hub-url

Source: https://www.jetbrains.com/help/youtrack/server/update-hub-server-url.html.md

Run this command from a command-line interface to update the Hub server URL in YouTrack's configuration. Replace <url-with-/hub-at-the-end> with the base URL of your new Hub installation, appending /hub. After running, start YouTrack to apply the change.

```bash
docker run -it -v /path/to/conf/on/host:/opt/youtrack/conf -v ... <YT_IMAGE_ID> configure --hub-url=<url-with-/hub-at-the-end>
```

--------------------------------

### Run YouTrack Docker container on Linux (Bash)

Source: https://www.jetbrains.com/help/youtrack/server/restore-docker-image-installation.html.md

Starts a YouTrack server container on a Linux host, mapping the data, conf, logs, and backups directories and exposing port 8080. Replace the placeholders with your actual paths, port, and version.

```console
docker run -it --name <youtrack-server-instance> \
-v <path to data directory>:/opt/youtrack/data \
-v <path to conf directory>:/opt/youtrack/conf \
-v <path to logs directory>:/opt/youtrack/logs \
-v <path to backups directory>:/opt/youtrack/backups \
-p <port on host>:8080 \
jetbrains/youtrack:<version>
```

--------------------------------

### Stop and start YouTrack service manually

Source: https://www.jetbrains.com/help/youtrack/server/run-docker-container-as-service.html

Commands to manually stop and start the docker.youtrack service.

```bash
sudo service docker.youtrack stop
```

```bash
sudo service docker.youtrack start
```

--------------------------------

### Start YouTrack Compose application

Source: https://www.jetbrains.com/help/youtrack/server/run-docker-container-as-service.html

Command to start the YouTrack container in detached mode using Docker Compose, applying the restart policy declared in the Compose file.

```bash
docker compose -f docker-compose.yml up -d
```

--------------------------------

### Enable Hyper-V and restart system

Source: https://www.jetbrains.com/help/youtrack/server/youtrack-docker-installation.html

Enables Hyper-V to start automatically and then restarts the system. These commands are prerequisites for running the YouTrack container in Hyper-V isolation mode on Windows Server.

```bash
bcdedit /set hypervisorlaunchtype auto
```

```powershell
Restart-Computer -Force
```

--------------------------------

### Run YouTrack Docker container on Windows (PowerShell)

Source: https://www.jetbrains.com/help/youtrack/server/restore-docker-image-installation.html.md

Starts a YouTrack server container on a Windows host using PowerShell, mapping the data, conf, logs, and backups directories and exposing port 8080. Replace the placeholders with your actual paths, port, and version.

```powershell
docker run -it --name <youtrack-server-instance> `
-v <path to data directory>:C:/opt/youtrack/data `
-v <path to conf directory>:C:/opt/youtrack/conf `
-v <path to logs directory>:C:/opt/youtrack/logs `
-v <path to backups directory>:C:/opt/youtrack/backups `
-p <port on host>:8080 `
jetbrains/youtrack-windows:<version>
```

--------------------------------

### Run YouTrack with Docker Compose on Windows

Source: https://www.jetbrains.com/help/youtrack/server/run-docker-container-as-service.html.md

For Windows Server, create a Docker Compose file with the restart policy 'unless-stopped' to run YouTrack as a service. Start the Compose application in detached mode with 'docker compose -f docker-compose.yml up -d', and manage the container with standard Compose commands like 'down' and 'ps'.

```YAML
version: "3"
services:
  YouTrack:
    container_name: youtrack-server
    image: jetbrains/youtrack-windows:<version>
    user: "13001:13001"
    restart: unless-stopped
    ports:
      - "<port on host>:8080"
    volumes:
      - <path to data folder>:C:/opt/youtrack/data
      - <path to conf folder>:C:/opt/youtrack/conf
      - <path to logs folder>:C:/opt/youtrack/logs
      - <path to backups folder>:C:/opt/youtrack/backups
```

```CONSOLE
docker compose -f docker-compose.yml up -d
```

```CONSOLE
docker compose -f docker-compose.yml down
```

```CONSOLE
docker compose -f docker-compose.yml ps
```

--------------------------------

### Docker Compose file for YouTrack on Windows Server

Source: https://www.jetbrains.com/help/youtrack/server/run-docker-container-as-service.html

Example docker-compose.yml for running YouTrack on Windows Server. It defines the youtrack-server container with the jetbrains/youtrack-windows image, sets the restart policy to unless-stopped, maps port 8080, and mounts data, conf, logs, and backups folders.

```yaml
version: "3"
services:
  YouTrack:
    container_name: youtrack-server
    image: jetbrains/youtrack-windows:<version>
    user: "13001:13001"
    restart: unless-stopped
    ports:
      - "<port on host>:8080"
    volumes:
      - <path to data folder>:C:/opt/youtrack/data
      - <path to conf folder>:C:/opt/youtrack/conf
      - <path to logs folder>:C:/opt/youtrack/logs
      - <path to backups folder>:C:/opt/youtrack/backups
```

--------------------------------

### GET /mcp

Source: https://www.jetbrains.com/help/youtrack/server/model-context-protocol-server.html

Configures the YouTrack MCP server behavior via optional query parameters. Use these parameters to control which tools are exposed, exclude tools, include custom tool packages, or enable output schemas.

```APIDOC
## [GET] /mcp

### Description
Configures the YouTrack MCP server behavior via optional query parameters. Use these parameters to control which tools are exposed, exclude tools, include custom tool packages, or enable output schemas.

### Method
GET

### Endpoint
/mcp

### Parameters
#### Query Parameters
- **tools** (string) - Optional - Comma-separated list of tool names to return on a `tools/list` request. Example: `/mcp?tools=search_issues,get_issue`.
- **ignoreTools** (string) - Optional - Comma-separated list of tool names to exclude from the `tools/list` response. Example: `/mcp?ignoreTools=find_user,manage_issue_tags`.
- **customToolPackages** (string) - Optional - Comma-separated list of app packages whose custom tools to make available. Example: `/mcp?customToolPackages=app-name1,app-name2`.
- **enableToolOutputSchema** (boolean) - Optional - Set to `true` to return a JSON Schema describing tool output. Example: `/mcp?enableToolOutputSchema=true`.

### Request Example
GET /mcp?tools=search_issues,get_issue&ignoreTools=find_user&customToolPackages=app-name1&enableToolOutputSchema=true

### Response
#### Success Response (200)
- **tools** (array) - List of available tools based on the `tools` and `ignoreTools` parameters.
- **outputSchema** (object) - JSON Schema describing tool output when `enableToolOutputSchema` is `true`.

#### Response Example
{
  "tools": ["search_issues", "get_issue"],
  "outputSchema": {}
}
```

--------------------------------

### Initialize and add app settings

Source: https://www.jetbrains.com/help/youtrack/devportal/apps-enhanced-dx-typescript.html

Use npm run g -- settings to initialize the settings schema and add properties. Examples include init with title and description, adding a write-only apiKey string, and adding an integer maxItems with min and max constraints.

```bash
npm run g -- settings init --title "My App Settings" --description "Admin configuration"
```

```bash
npm run g -- settings add --name apiKey --type string --write-only
```

```bash
npm run g -- settings add --name maxItems --type integer --min 1 --max 100
```

--------------------------------

### Run setup commands before agent session

Source: https://www.jetbrains.com/help/air/run-environments.html

Example `.air/worktree.json` `setup` section that runs a command on macOS before the agent session starts. Only the command for the current OS is executed; others are ignored.

```json
{
    "setup": {
        "macos": [
            "echo \"Setup ran successfully with $TEST!\" > /tmp/setup-test.txt"
        ]
    }
}
```

--------------------------------

### Inspect and manage remote tools with RemoteToolsHelper

Source: https://www.jetbrains.com/help/toolbox-app/remote-dev-api.html

Use RemoteToolsHelper (experimental) to inspect and manage IDEs/tools on the host by hint. Toolbox installs the latest version matching the hint. The example shows getting available and installed tools and installing a remote tool.

```kotlin
val tools = serviceLocator.getService<RemoteToolsHelper>()
val available = tools.getAvailableRemoteTools(env.id, hint = "IU-251.*")
val installed = tools.getInstalledRemoteTools(env.id, hint = "IU-*")
val ok = tools.installRemoteTool(env.id, hint = "IU-251.*")
```

--------------------------------

### Global configuration example with profile

Source: https://www.jetbrains.com/help/qodana/global-configuration.html

Shows a global configuration with failure conditions and a profile reference.

```yaml
failureConditions:
    severityThresholds:
        critical: 0

profile:
    name: qodana.recommended

```

--------------------------------

### Begin Qodana for JVM configuration

Source: https://www.jetbrains.com/help/qodana/configuration-reference.html

Starts a Qodana configuration for the JVM linter. The example is incomplete in the source, showing only the version field.

```yaml
version: "1.0"

```

--------------------------------

### Get an Issue with Its Custom Fields

Source: https://www.jetbrains.com/help/youtrack/devportal/api-howto-get-issues-with-all-values.html

Send a GET request to a target issue to get the issue with values of all its custom fields. Reference the issue by its `idReadable` value (for example, `SP-8`) or by its entity `id` (for example, `2-7`).

```http
GET /api/issues/{issueID}?[fields]
```

--------------------------------

### Launch Visual Studio in experimental instance with /rootSuffix

Source: https://www.jetbrains.com/help/dotcover/Installation_Guide.html

Launches Visual Studio in a specified experimental instance. Replace <InstanceName> with the name of the instance you entered during installation. The experimental instance does not need to exist before starting the installation.

```plaintext
devenv.exe /rootSuffix <InstanceName>
```

--------------------------------

### Indent comments started at the first column examples

Source: https://www.jetbrains.com/help/resharper/EditorConfig_CPP_CppOtherPageScheme.html

Examples for the cpp_indent_comment setting showing indentation of comments started at the first column for values true and false.

```cpp
namespace N
{
	// Some comment
	class C1
	{
	};
};
```

```cpp
namespace N
{
// Some comment
	class C1
	{
	};
};
```

--------------------------------

### Unresolved tag example in Django template

Source: https://www.jetbrains.com/help/inspectopedia/DjangoUnresolvedTagInspection.html

Example template that triggers the inspection because the tag <start> is not resolved. The IDE highlights <start> and offers a quick-fix to add it to custom HTML tags.

```django
<h1>{{ question.question_text }}</h1>
<start>
```

--------------------------------

### Example VM options path

Source: https://www.jetbrains.com/help/toolbox-app/gettings-started-with-ssh.html

Example of the VM options configuration path for IntelliJ IDEA 2025.1 on Linux.

```text
~/.config/JetBrains/IntelliJIdea2025.1/idea64.vmoptions
```

--------------------------------

### Get groups by IDs response example

Source: https://www.jetbrains.com/help/jetbrains-console/analytics-api-v2.html

Example response for the get groups by IDs endpoint. Returns a collection of groups that the user is authorized to view, with the same structure as the list groups response but without a nextCursor field.

```json
{
  "items": [
    {
      "id": "c1d2e3f4-a5b6-7890-cdef-1234567890ab",
      "orgId": "0fedcba9-8765-4321-fedc-ba9876543210",
      "type": "local",
      "name": "Backend Engineers",
      "description": "Backend engineering team",
      "parentId": null,
      "membersCount": {
        "directMembersCount": 12,
        "transitiveMembersCount": 18
      },
      "parentGroups": [],
      "hasChildren": true
    },
    {
      "id": "d2e3f4a5-b6c7-8901-defa-234567890abc",
      "orgId": "0fedcba9-8765-4321-fedc-ba9876543210",
      "type": "local",
      "name": "Backend Engineers - Payments",
      "description": "Payments squad",
      "parentId": "c1d2e3f4-a5b6-7890-cdef-1234567890ab",
      "membersCount": {
        "directMembersCount": 6,
        "transitiveMembersCount": 6
      },
      "parentGroups": [
        {
          "id": "c1d2e3f4-a5b6-7890-cdef-1234567890ab",
          "orgId": "0fedcba9-8765-4321-fedc-ba9876543210",
          "type": "local",
          "name": "Backend Engineers",
          "description": "Backend engineering team",
          "parentId": null
        }
      ],
      "hasChildren": false
    }
  ]
}
```

--------------------------------

### Matrix parameters for configuration example

Source: https://www.jetbrains.com/help/teamcity/matrix-build.html

Example matrix parameters used in the configuration steps. Shows two parameters with two values each.

```text
Browser: Chrome, Firefox
Java: jdk-17, jdk-21
```

--------------------------------

### Example project structure for global configuration

Source: https://www.jetbrains.com/help/qodana/global-configuration.html

Shows a directory layout where project-a and project-b contain qodana.yaml files, project-b also has a custom profile, and a global configuration file qodana-global-configurations.yaml is at the root.

```text
root/
    project-a/
        qodana.yaml
    project-b/
        qodana.yaml
        project-b-profile.yaml
    qodana-global-configurations.yaml

```

--------------------------------

### Get All Tags Response

Source: https://www.jetbrains.com/help/youtrack/devportal/resource-api-tags.html

Example response body for the GET /api/tags request, showing a list of tags.

```json
[
  {
    "name": "Regression",
    "$type": "Tag"
  }
]
```

--------------------------------

### GET /api/v1/code-provenance/totals

Source: https://www.jetbrains.com/help/jetbrains-console/analytics-api-v1.html.md

Documentation for the GET /api/v1/code-provenance/totals endpoint, including parameters, request example, and response schema.

```APIDOC
## GET /api/v1/code-provenance/totals

### Description
Get the total number of lines generated by humans or AI tools, and time saved within a specified date range, grouped by feature. Filters for `feature`, `userIds`, `userEmails`, and `ide` are applied together (the API returns only records that match all criteria).

### Method
GET

### Endpoint
https://api.jetbrains.cloud/metrics/api/v1/code-provenance/totals

### Parameters
#### Query Parameters
- **fromDate** (string date) - Required - The starting date to filter the data from (ISO 8601 format). The returned result includes data for the specified date.
- **toDate** (string date) - Required - The end date to filter the data to (ISO 8601 format). The returned result includes data for the specified date.
- **feature** (string) - Optional - A comma-separated list of features to filter by. Available features: human, junie, aia, claude_agent, codex_agent, gemini_agent, copilot, code_completion, nes, other, uncategorized.
- **userIds** (string) - Optional - A comma-separated list of user IDs to filter by. If not used or left blank, the data for all users is returned.
- **userEmails** (string) - Optional - A comma-separated list of user emails to filter by. If not used or left blank, the data for all users is returned.
- **ide** (string) - Optional - A comma-separated list of IDEs to filter by. Available values: air, air_cloud, air_automations, clion, datagrip, dataspell, goland, idea, phpstorm, pycharm, rider, rubymine, rustrover, webstorm, wire, unknown.

#### Header Parameters
- **Authorization** (string) - Required - Bearer token used for authentication. Provide as Bearer <ACCESS_TOKEN> in the Authorization header.

### Request Example
```
GET https://api.jetbrains.cloud/metrics/api/v1/code-provenance/totals?fromDate=2026-03-01&toDate=2026-04-01&feature=aia,junie&ide=idea
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
```

### Response
#### Success Response (200)
- **totals** (Array of CodeProvenanceFeatureData) - Required - A collection of total code provenance metrics grouped by feature.
  - **feature** (Enum) - Required - The name of the feature. Available features: human, junie, aia, claude_agent, codex_agent, gemini_agent, copilot, code_completion, nes, other, uncategorized.
  - **loc** (integer) - Required - Lines of code attributed to the feature.
  - **timeSavedS** (integer) - Required - Time saved in seconds compared to writing code manually. Applies only to AI features.

#### Response Example
```json
{
  "totals": [
    {
      "feature": "aia",
      "loc": 161313,
      "timeSavedS": 93705
    },
    {
      "feature": "junie",
      "loc": 164368,
      "timeSavedS": 99292
    }
  ]
}
```

#### Error Responses
- **400** - Bad Request. Invalid query parameters.
- **401** - Unauthorized. Missing or invalid authentication token.
```

--------------------------------

### Qodana CLI with plugin properties

Source: https://www.jetbrains.com/help/qodana/configuration-reference.html

Command-line example for running Qodana with required and suppressed plugin properties.

```bash
qodana scan \
   -e QODANA_TOKEN="<cloud-project-token>" \
   --property=idea.required.plugins.id=JavaScript,org.intellij.grails \
   --property=idea.suppressed.plugins.id=com.intellij.spring.security
```
Tokens:
Raw