Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/kashsuks/rode/llms.txt

Use this file to discover all available pages before exploring further.

Rode is shipped across multiple platforms, primarily through GitHub Releases and crates.io. This guide covers installation methods for different platforms.
Nightly builds are an ongoing process and planned for the near future. Currently, stable releases are available through crates.io and GitHub releases.

​
Prerequisites

Before installing Rode, ensure you have:
  • Rust toolchain - Required for building from source
  • Cargo package manager - Comes with Rust installation
  • Git - For cloning the repository (if building from source)
If you don’t have Rust installed, visit rustup.rs to install the official Rust toolchain.

​
Install from crates.io

The easiest way to install Rode is through Cargo: 
cargo install rode-editor
This will download, compile, and install the latest stable version of Rode. The binary will be available in your Cargo bin directory (usually ~/.cargo/bin/). After installation, run Rode: 
rode-editor

​
Install from GitHub releases

Pre-built binaries are available for different platforms on the GitHub releases page.

​
macOS installation

1

Download the binary

For Mac Silicon (M1, M2, M3 chips), download rode-editor-apple-silicon from the latest release.
2

Make it executable

Open your terminal and navigate to the download location, then run:
chmod +x rode-editor-apple-silicon
3

Run the editor

Execute the binary:
./rode-editor-apple-silicon
4

Handle security permissions

If macOS displays a security warning:
  1. Go to System Settings
  2. Navigate to Privacy & Security
  3. Scroll to the Security section
  4. Click Open Anyway next to the Rode warning
  5. Confirm to allow the application
You can move the binary to /usr/local/bin/ to make it accessible from anywhere:
sudo mv rode-editor-apple-silicon /usr/local/bin/rode

​
Linux installation

Download the appropriate binary for your architecture from GitHub releases: 
# Download the binary (replace URL with latest release)
wget https://github.com/kashsuks/rode/releases/download/v0.4.1/rode-editor-linux

# Make executable
chmod +x rode-editor-linux

# Move to PATH (optional)
sudo mv rode-editor-linux /usr/local/bin/rode

​
Build from source

Building from source gives you the latest features and allows you to customize the build.
1

Clone the repository

git clone https://github.com/kashsuks/rode
2

Navigate to the directory

cd rode
3

Build and run

cargo run
This will install all required dependencies and compile the application.
4

Install the binary (optional)

To install the compiled binary to your Cargo bin:
cargo install --path .
GitHub commits are not guaranteed to be stable as they represent development logs. The current commit may not compile or run correctly. For stable builds:
  • Use tagged releases (e.g., git checkout v0.4.1)
  • Install from crates.io
  • Download pre-built binaries from releases

​
Verify installation

After installation, verify Rode is working: 
rode-editor --version
Or simply launch the editor: 
rode-editor
You should see the Rode welcome screen with options to open a folder or file.

​
Dependencies

Rode uses the following core dependencies (automatically installed during build): 
[dependencies]
eframe = "0.29"
egui = "0.29"
iced = { version = "0.14.0", features = ["svg", "image", "advanced", "markdown", "tokio"] }
syntect = { version = "5", default-features = false, features = ["default-syntaxes", "regex-onig"] }

# Tree-sitter for syntax highlighting
tree-sitter-highlight = "0.25"
tree-sitter-rust = "0.24"
tree-sitter-javascript = "0.23"
tree-sitter-typescript = "0.23"
tree-sitter-python = "0.23"

# Additional utilities
fuzzy-matcher = "0.3"
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"

​
Configuration directory

On first launch, Rode creates a configuration directory:
  • macOS: ~/Library/Application Support/rode/
  • Linux: ~/.config/rode/
  • Windows: %APPDATA%\rode\
This directory contains:
  • preferences.lua - Editor preferences
  • theme.lua - Custom theme configuration
  • wakatime.json - WakaTime integration settings

​
Next steps

Quickstart guide

Learn the basics and start editing

Keyboard shortcuts

Master Rode’s keybindings

Build docs developers (and LLMs) love

Get started for freeTalk to us