Skip to content
rim Docs

Getting Started

Getting Started

Section titled “Getting Started”

Install

Section titled “Install”

The current installation path is:

Terminal window
cargo install --path rim-app --locked

If you are installing from a repository checkout, run the command at the workspace root.

Launch

Section titled “Launch”
Terminal window
rim

Open a file directly:

Terminal window
rim path/to/file.rs

Open multiple files:

Terminal window
rim README.md Cargo.toml src/main.rs

Plugin Install Command

Section titled “Plugin Install Command”

rim can install plugins from GitHub and compile them for you:

Terminal window
rim plugin install github owner/repo --package plugin-crate-name

For the built-in Yazi plugin example:

Terminal window
rim plugin install github zooeywm/rim --package rim-plugin-yazi

First Setup

Section titled “First Setup”

For most users, the practical order is:

  1. Install and launch rim
  2. Set your preferred leader_key in editor.toml
  3. Add a few personal key bindings in keymaps.toml
  4. Install optional plugins such as the Yazi picker

Optional Tools

Section titled “Optional Tools”

These are not required for basic editing, but they matter for specific workflows:

  • yazi if you want the external Yazi picker plugin
  • git, cargo, rustup, and wasm32-wasip2 if you want rim plugin install github ...

Read This Next

Section titled “Read This Next”
  1. Configuration guide
  2. Plugins guide
  3. Reference pages if you need behavior details