JetBrains Rider

https://www.jetbrains.com/help/rider/
Admin
JetBrains Rider is a cross-platform .NET IDE that supports C#, VB.NET, F#, ASP.NET, and multiple web...
Tokens:1,853,249
Snippets:18,332
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install IdeaVIM plugin example

Source: https://www.jetbrains.com/help/rider/Remote_development_overview.html

Example of installing the IdeaVIM plugin using the remote-dev-server installPlugins command. Requires a network connection to JetBrains Marketplace.

```bash
remote-dev-server installPlugins IdeaVIM
```

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

### Install and launch JetBrains Toolbox on Linux

Source: https://www.jetbrains.com/help/rider/Installation_guide.html

Extract the Toolbox App tarball to the installation directory, then start the application from the console. The second command must be run after navigating to the installation directory.

```bash
tar -xvf jetbrains-toolbox-<version>.tar.gz -C <installation-directory>
```

```bash
./bin/jetbrains-toolbox
```

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

### generate_inspection_kts_examples

Source: https://www.jetbrains.com/help/rider/mcp-server.html

Returns example inspection.kts templates for the target language to guide code generation. Provides XML-wrapped examples showing how to write inspections using the InspectionKts API.

```APIDOC
## generate_inspection_kts_examples

### Description
Returns example inspection.kts templates for the target language to guide code generation. Provides XML-wrapped examples showing how to write inspections using the InspectionKts API.

### Parameters
- **language** (string) - Required - Target language: 'Java' or 'Kotlin'.
- **includeAdditionalExamples** (boolean) - Optional - If true, includes additional curated examples besides templates.
- **projectPath** (string) - Optional - The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.
```

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

### build_project

Source: https://www.jetbrains.com/help/rider/mcp-server.html

Triggers building of the project or specified files, waits for completion, and returns build errors. Use this tool to build the project or compile files and get detailed information about compilation errors and warnings.

```APIDOC
## build_project

### Description
Triggers building of the project or specified files, waits for completion, and returns build errors. Use this tool to build the project or compile files and get detailed information about compilation errors and warnings. You have to use this tool after performing edits to validate if the edits are valid.

### Parameters
- **rebuild** (boolean) - Optional - Whether to perform a full rebuild of the project. Defaults to false. Effective only when filesToRebuild is not specified.
- **filesToRebuild** (array of strings) - Optional - If specified, only compile files with the specified paths. Paths are relative to the project root.
- **timeout** (integer) - Optional - Timeout in milliseconds.
- **projectPath** (string) - Optional - The project path. Always provide this value if known to reduce ambiguous calls. If only the current working directory is known, you can use it as the project path.

### Response
Returns build errors and warnings after the build completes.
```

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

### Update webdriver-manager binaries

Source: https://www.jetbrains.com/help/rider/Protractor.html

Downloads the necessary binaries for Protractor after installation. See also Getting Started on the Protractor official website.

```shell
webdriver-manager update
```

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

### Configure air-gapped Gateway URLs with cat examples

Source: https://www.jetbrains.com/help/rider/Fully_offline_mode.html

Example contents for the four configuration files that describe downloaded artifacts for JetBrains Gateway. productsInfoUrl points to products.json, clientDownloadUrl to clients, jreDownloadUrl to JBR, and pgpPublicKeyUrl to the KEYS file. <PRODUCT_CODE> is a placeholder replaced by Gateway with the product code.

```bash
$ cat productsInfoUrl
https://internal.site/backends/<PRODUCT_CODE>/products.json
```

```bash
$ cat clientDownloadUrl
https://internal.site/clients/
```

```bash
$ cat jreDownloadUrl
https://internal.site/jre/
```

```bash
$ cat pgpPublicKeyUrl
https://internal.site/KEYS
```

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

### Indent comments started at the first column examples

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

Examples for the cpp_indent_comment property showing true and false values.

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

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

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

### Example of running remote-dev-server.sh

Source: https://www.jetbrains.com/help/rider/Remote_development-a.html

Example command using a specific IDE path and project path. Shows the expected format for the SSH link parameters.

```bash
~/ideaIU-213.3469/bin/remote-dev-server.sh
run ~/spring-boot-example/
--ssh-link-host ec2-11-50-136-85.eu-north-1.compute.amazonaws.com
--ssh-link-user ubuntu
```

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

### ProvidesContext attribute example

Source: https://www.jetbrains.com/help/rider/Reference__Code_Annotation_Attributes.html

Example of ProvidesContext attribute on a field, showing a warning when another way to get the value is used.

```csharp
class Foo {
  [ProvidesContext] IBarService _barService = ...;

  void ProcessNode(INode node) {
    DoSomething(node, node.GetGlobalServices().Bar);
    //              ^ Warning: use value of '_barService' field
  }
}
```

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

### Project structure of the example project

Source: https://www.jetbrains.com/help/rider/Install_custom_project_templates.html

Shows the initial project structure used as a starting point for the custom template. It contains a single file Program.cs and the project file MyProject.csproj, along with bin and obj directories.

```text
ConsoleAppAsyncMain
├── bin
├── obj
├── MyProject.csproj
├── Program.cs
```

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

### Public environment file example

Source: https://www.jetbrains.com/help/rider/HTTP-Client-variables.html

Sample http-client.env.json file defining development and production environments with common variables.

```json
{
    "development": {
        "host": "localhost",
        "id-value": 12345,
        "username": "",
        "password": "",
        "my-var": "my-dev-value"
    },

    "production": {
        "host": "example.com",
        "id-value": 6789,
        "username": "",
        "password": "",
        "my-var": "my-prod-value"
    }
}

```

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

### Run Rider launcher script (Linux)

Source: https://www.jetbrains.com/help/rider/Working_with_the_IDE_Features_from_Command_Line.html

Runs the rider.sh launcher script from the installation directory. Example assumes installation to /opt/rider.

```shell
/opt/rider/bin/rider.sh
```

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

### Install plugin from command line on Linux

Source: https://www.jetbrains.com/help/rider/Managing_Plugins.html

Run this command from the bin directory of your JetBrains Rider installation to install a plugin by its Plugin ID. Replace <PluginID> with the actual ID, for example, org.jetbrains.plugins.github.

```bash
rider.sh installPlugins <PluginID>
```

```bash
rider.sh installPlugins org.jetbrains.plugins.github
```

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

### Example idea.properties file

Source: https://www.jetbrains.com/help/rider/Tuning_the_IDE.html

Example platform properties file that overrides the default values for the maximum file size for coding assistance and the console cyclic buffer size. Each property must be specified on a separate line.

```properties
idea.max.intellisense.filesize=5000
idea.cycle.buffer.size=1024
```

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

### Show jetbrains-clients-downloader help

Source: https://www.jetbrains.com/help/rider/Fully_offline_mode.html

Shows the detailed syntax for the JetBrains Client Downloader. Run this to see all available filters and options.

```bash
jetbrains-clients-downloader -h
```

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

### Install plugin from command line on Windows

Source: https://www.jetbrains.com/help/rider/Managing_Plugins.html

Run this command from the bin directory of your JetBrains Rider installation to install a plugin by its Plugin ID. Replace <PluginID> with the actual ID, for example, org.jetbrains.plugins.github.

```bash
rider64.exe installPlugins <PluginID>
```

```bash
rider64.exe installPlugins org.jetbrains.plugins.github
```

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

### Install plugin from custom repository with rider64.exe

Source: https://www.jetbrains.com/help/rider/Install_plugins_from_the_command_line.html

Installs a plugin with ID com.example.myplugin from a custom repository URL.

```bash
rider64.exe installPlugins com.example.myplugin http://plugins.example.com:8080/updatePlugins.xml
```

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

### Short form GET request

Source: https://www.jetbrains.com/help/rider/Exploring_HTTP_Syntax.html

For GET requests, you can omit the request method and only specify the URI. This example shows a basic request with a comment.

```http
// A basic request
https://example.com/a/
```

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

### Podman API socket URL example

Source: https://www.jetbrains.com/help/rider/Podman.html

Example output showing the Podman API socket URL and DOCKER_HOST value after starting the Podman machine.

```text
unix:///var/folders/3p/qnvz_wss4g32qcwxcmvsk70c0000gp/T/podman/podman-machine-default-api.sock
```

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

### Program.cs with async Main method

Source: https://www.jetbrains.com/help/rider/Install_custom_project_templates.html

The source code of the example project. It contains an async Main method as the default application entry point, printing 'Hello World!'.

```csharp
using System;
using System.Threading.Tasks;

namespace MyProject
{
    class Program
    {
        static async Task Main(string[] args)
        {
            Console.WriteLine("Hello World!");
        }
    }
}
```

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

### Verify .NET SDK installation with dotnet --version

Source: https://www.jetbrains.com/help/rider/Get_started_with_net_desktop_apps.html

Run this command in the Terminal window to verify that the .NET SDK is installed. The latest stable version is recommended.

```bash
dotnet --version
```

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

### Install plugin from command line on macOS

Source: https://www.jetbrains.com/help/rider/Managing_Plugins.html

Run this command to install a plugin by its Plugin ID on macOS. Replace <PluginID> with the actual ID, for example, org.jetbrains.plugins.github.

```bash
open -na "Rider 2026.2.app" --args installPlugins <PluginID>
```

```bash
open -na "Rider 2026.2.app" --args installPlugins org.jetbrains.plugins.github
```

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

### Example Dev Container CLI distribution URL

Source: https://www.jetbrains.com/help/rider/dev-container-cli.html

Example link to a deployed distribution of the Dev Container CLI ZIP archive.

```text
https://download.jetbrains.com/resources/intellij/dev-containers/243.19420.43/intellij-devcontainers-cli.zip
```

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

### XPath predicate with index 0 examples

Source: https://www.jetbrains.com/help/rider/Code_Inspections_in_XPath.html

Examples of using index 0 in XPath predicates, which is almost always a bug because XPath indices start at 1. The inspection reports these usages.

```xpath
//someelement[position() = 0]
```

```xpath
//something[0]
```

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

### Example of registering backend location

Source: https://www.jetbrains.com/help/rider/Remote_development-a.html

Example command using a specific IDE path to register the backend location for Gateway.

```bash
sh WebStorm-221.5591.52/bin/remote-dev-server.sh registerBackendLocationForGateway
```

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

### Example SSH build command

Source: https://www.jetbrains.com/help/rider/FAQ_about_Dev_Containers.html

A concrete example of building a Dev Container over SSH, using a specific host and repository. This demonstrates the format for the command.

```bash
docker --host ssh://jetbrains@MUNIT-234:22 build
            git@git.jetbrains.team/devcont/DevCont_test_cases.git:.devcontainer
```

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

### Use request.templateValue() to access values by index

Source: https://www.jetbrains.com/help/rider/HTTP-Client-variables.html

Shows how to use request.templateValue(Integer) to get the value by its index in the loop. The example sends a GET request for each book and logs the title and year.

```http
### Use templateValue

< {%
    request.variables.set("books", [{
    "books": {
      "title": "Ulysses",
      "year": 1922
    }
  },
  {
    "books": {
      "title": "Dune",
      "year": 1965
    }}])
%}

GET http://localhost:8080/books
Content-Type: application/json

{
  "bookTitle": "{{$.books..title}}",
  "bookYear": "{{$.books..year}}"
}

> {%
  let bookTitle = request.templateValue(0)
  client.log(`book title is: ${bookTitle}`) // prints Ulysses in 1st request, Dune in 2nd
  client.log(request.iteration())

  let bookYear = request.templateValue(1)
  client.log(`book year is: ${bookYear}`) // prints 1922 in 1st request, 1965 in 2nd

%}
```

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

### Launch an instance with vagrant up

Source: https://www.jetbrains.com/help/rider/Vagrant_Support.html

Launches the virtual machine instance. Run in the embedded Terminal.

```bash
vagrant up
```
Tokens:
Raw