rim Docs

A terminal-first, state-driven editor prototype with explicit domain, application, and adapter boundaries.

Documentation map

Architecture

Start with the workspace map, crate responsibilities, and data flow.

Getting Started

Install rim, launch it, open files, and move on to configuration.

Configuration

Set up editor.toml, keymaps.toml, and commands.toml as a user.

Plugins

Install Wasm plugins with rim plugin install ... and wire them into commands and keymaps.

Contributing

Follow the contributor workflow, testing expectations, and extension paths.

Config Reference

See the active config files, load flow, and ownership boundaries.

Workspace Session

Understand how session snapshots are shaped and restored.

Undo And Swap

Inspect persistence and recovery flows without reading the worker code first.