Installation

note

Rue is still in active development. If you run into any issues, please report them in GitHub issues.

First, you will need to install the Rust toolchain.

You can install the Rue CLI with this command:

cargo install rue-cli

It's also useful to install clvm_tools_rs:

cargo install clvm_tools_rs

Editor Support

VSCode

You will need to install Visual Studio Code.

Then, you can install the Rue extension on the VSCode marketplace. It provides syntax highlighting and LSP integration.

You can install the Rue language server with this command:

cargo install rue-lsp

This should automatically work with the extension.

Cursor

You will need to install Cursor.

Then, you can install the Rue extension on the Open VSX marketplace. It provides syntax highlighting and LSP integration.

You can install the Rue language server with this command:

cargo install rue-lsp

This should automatically work with the extension.

tip

Any editor that supports Open VSX and VSCode extensions will likely support this.

Hello World

The simplest program in Rue is the classic "hello world" example.

You can run the following command to setup a new project:

rue init

And then you can build it:

rue build

The puzzles/main.rue file should contain something like this:

fn main() -> String {
    "Hello, world!"
}

And the CLVM output when compiling it is (q . "Hello, world!)".