Quick Start

This guide will help you install and verify the Noir JetBrains Plugin quickly.

Installation Steps

Install the Plugin

Open your JetBrains IDE and go to:
- Settings/Preferences → Plugins → Marketplace
- Search for “Noir”
- Click Install
- Restart the IDE when prompted
Install Nargo

The plugin requires nargo (the Noir compiler) for LSP features. Install it using noirup:
Terminal window
```
curl -L https://raw.githubusercontent.com/noir-lang/noirup/main/install | bash
noirup
```
Verify installation:
Terminal window
```
nargo --version
```
Open a Noir Project

Open or create a Noir project. If you don’t have one, create a new project:
Terminal window
```
nargo new my_project
cd my_project
```
Then open the folder in your JetBrains IDE.
Verify It Works

Open src/main.nr and you should see:
- Syntax highlighting for keywords, types, and comments
- Code completion when typing (Ctrl+Space)
- Error diagnostics if there are issues
- Hover information when hovering over symbols

What’s Next?

Now that you have the plugin running:

Learn about LSP features - code completion, go-to-definition, hover
Explore Live Templates - quickly scaffold common Noir code
Configure settings - customize nargo path, enable/disable features
Troubleshoot issues - if something isn’t working

Sample Project

Want to explore the plugin features? Create this sample file:

use std::hash::poseidon;

struct Point {
    x: Field,
    y: Field,
}

fn main(a: Field, b: Field) -> pub Field {
    let sum = add(a, b);
    poseidon::bn254::hash_1([sum])
}

fn add(x: Field, y: Field) -> Field {
    x + y
}

#[test]
fn test_add() {
    let result = add(2, 3);
    assert(result == 5);
}

With this code you can test:

Syntax highlighting for all token types
Code completion for std:: imports
Go-to-definition on the add function
Test gutter icon next to #[test]