redox-editor 0.6.0

A terminal-based, Vim-like text editor built with MinUI
redox-editor-0.6.0 is not a library.

Project structure

Redox is a Cargo workspace with a small core crate and a MinUI frontend. The core crate owns editor logic that should stay UI-agnostic, while the TUI crate owns input mapping, app state, rendering, popups, syntax highlighting, and terminal interaction.

redox/
├── Cargo.toml                  # Workspace manifest and published redox binary wrapper
├── src/main.rs                 # Thin entrypoint that calls redox-tui
└── crates/
    ├── redox-core/
    │   └── src/
    │       ├── buffer/         # Rope-backed text buffer, selections, edits, text objects
    │       ├── fuzzy.rs        # Fuzzy matching and path ranking helpers
    │       ├── io.rs           # File read/write helpers
    │       ├── logic/          # Shared editor logic helpers
    │       ├── motion.rs       # Vim-style motion logic
    │       ├── session/        # Multi-buffer session model and background loading
    │       └── text/           # Shared text indexing and clamp helpers
    └── redox-tui/
        └── src/
            ├── app/
            │   ├── state.rs    # Main editor state and mode model
            │   └── state/      # Commands, editing, explorer, finder, LSP, perf, search, etc.
            ├── input/          # Key/event mapping, counts, operators, cursor controller
            └── ui/
                ├── syntax/     # Tree-sitter language adapters and highlighting
                ├── widgets/    # About, command line, explorer, finder, LSP, status, toast, perf
                ├── overlays.rs # Indent guides, delimiter highlights, colour column
                ├── render.rs   # Text snapshot/render helpers
                └── style.rs    # Theme and colour definitions

This split keeps buffer operations, indexing, motions, fuzzy scoring, and session behaviour easy to test without needing a terminal. The frontend can then evolve the interface without pulling UI details into redox-core.

The subcrates can be found here:

Getting Started

Requirements

  • Rust toolchain (cargo + rustc)
  • A terminal that supports basic ANSI features and raw mode (and ideally full colour support)

Install via CLI

The easiest way to install the editor is to just install the binary from Crates.io:

cargo install redox-editor

Build from source

Build from source after cloning the repository:

cargo build --release -p redox-editor

Then install the created binary:

cargo install --path .

This installs the redox binary into ~/.cargo/bin by default.

If needed, add that location to your PATH (example for zsh):

export PATH="$HOME/.cargo/bin:$PATH"

Usage guide

Run Redox

redox <file_path>

Example:

redox ./README.md

Open straight into the explorer for any specified directory (including .):

redox src

Command mode

Enter command mode with :.

Command Behaviour
:w Write the current buffer. Explorer buffers apply pending filesystem edits.
:q / :quit Quit when all buffers are clean, or close the active surface buffer.
:q! Force quit.
:wq Write the current buffer, then quit when all buffers are clean.
:e <path> Open or switch to a file buffer.
:bn / :bnext Switch to the next buffer in MRU order.
:bp / :bprev Switch to the previous buffer in MRU order.
:ls Show a compact summary of open buffers.
:ex / :explorer Toggle the file explorer.
:about Toggle the about popup.
:rain Toggle rain mode.
:perf Toggle the performance metrics popup.
:lsp list Open the language tools marketplace.
:lsp status Show the active buffer's detected language tools.

Command history is available with Up / Down or ctrl+p / ctrl+n.

File navigation

Keys Behaviour
<space><space> Open the fuzzy file finder for the launch directory.
<space>e Toggle the file explorer.
<space>x Toggle the diagnostics list for the current file.
<space>ca Show quick fixes for the diagnostic under the cursor.
gd Go to symbol definition using the active LSP.
ctrl+shift+k Request LSP completions in insert mode.
Enter Open the selected explorer/finder entry.
- Navigate to the parent directory in the explorer.
ctrl+shift+p Open the pinboard for the current file or selected finder entry.
ctrl+1 ... ctrl+5 Open a pinned file slot.

Finder controls:

Keys Behaviour
Type text Filter files with fuzzy matching.
Backspace Delete the previous query character.
Up / Down Move through results.
ctrl+p / ctrl+n Move through results.
Enter Open the selected file.
ctrl+shift+p Pin the selected finder entry.
Escape / ctrl+c Close the finder.

Pinboard controls:

Keys Behaviour
j / k or Down / Up Move between pin slots.
p or shift+Enter Assign the current file to the selected slot.
ctrl+1 ... ctrl+5 Assign directly to a slot while the pinboard is open.
Enter Open the selected pinned file.
shift+j / shift+k Reorder the selected pin down/up.
d Delete the selected pin.
Escape / ctrl+c Close the pinboard.

Language tools

Redox can start installed language servers for supported file types and display diagnostics inline, in the status bar, and in a diagnostics popup.

Open the language tools marketplace with :lsp list.

Completion controls:

Keys Behaviour
Typing code Request completions automatically after a short pause.
ctrl+i Show type, signature, or documentation for the symbol under the cursor.
ctrl+shift+k Request completions in insert mode.
ctrl+n / ctrl+p or Down / Up Move through completion results.
Enter Accept the selected completion or snippet.
ctrl+e Close completions.
Escape Leave insert mode.

Marketplace controls:

Keys Behaviour
j / k or Down / Up Move through tools.
i Enable or install the selected tool. If the executable is already on PATH, Redox just enables it.
u Disable or uninstall the selected tool when Redox knows how it was installed.
Escape / ctrl+c Close the marketplace.

Diagnostics controls:

Keys Behaviour
<space>x Toggle the diagnostics list for the current file.
j / k or Down / Up Move through diagnostics.
Enter Jump to the selected diagnostic.
a Open quick fixes for the selected diagnostic in a lower split.
Escape / ctrl+c Close the lower quick-fix split, or close the diagnostics list when no split is open.

Code action controls:

Keys Behaviour
<space>ca Open quick fixes for the diagnostic under the cursor.
j / k or Down / Up Move through available actions.
Enter Apply the selected quick fix.
Escape / ctrl+c Close the quick-fix popup.

Other language tool commands:

Command / keys Behaviour
:lsp status Show the detected language, LSP, and linter for the current file.
gd Go to symbol definition.
ctrl+i Show symbol info.
Typing code or ctrl+shift+k Request completions.

Editing and motion

Keys Behaviour
h / j / k / l Move left / down / up / right.
Arrow keys Basic directional motion.
w / b / e Move by word starts and word ends.
0 / _ / $ Move to line start, first non-whitespace, or line end.
gg / G Jump to the start or end of the file.
% Jump to the matching delimiter under or near the cursor.
f / t / F / T Find/till a character forward or backward on the current line.
i / I Insert before the cursor / at first non-whitespace.
a / A Insert after the cursor / at line end.
o / O Open a line below / above.
x Delete the character under the cursor without touching the private register.
r Replace the character under the cursor.
dd / cc / yy Delete, change, or yank the current line.
D Delete from the cursor to the end of the line.
p / P Paste after/before from the private register.
<space>p Paste from the system clipboard.
u / ctrl+r Undo / redo.
ctrl+d / ctrl+u Scroll down/up by one viewport.
zz Centre the cursor line in the viewport.
~ Toggle character case, or the whole visual selection.

Visual modes

Keys Behaviour
v / V / ctrl+v Enter visual, visual line, or visual block mode.
y / d / c Yank, delete, or change the active selection.
x Delete the selection without copying to the private register.
r Replace the active selection.
<space>y Yank the selection to the system clipboard.
tab / shift+tab Indent / outdent the selection.
J / K Move selected lines down/up.

Search and text objects

Keys Behaviour
/ Search in the current buffer.
ctrl+n / ctrl+p Repeat the cached search forward/backward.
d$, c$, y$ Apply an operator through a motion.
daw, ci", yi( Apply operators to text objects.

Notes:

  • Count prefixes are supported for motions and many operators, for example 3w, 5j, 2G, and 2ci].
  • Compound motions are functional, such as dap, ci", and d$.
  • Redox is intentionally opinionated, so keybindings may still move around as the editor settles.

Roadmap

These have roughly been categorized, and so aren't necessarily in chronological order.

  • Rope-backed text buffer core (redox-core)
  • TUI rendering with statusline + cursor projection
  • Text insertion, newline insertion, and backspace editing
  • Vim-style mode system (Normal / Insert / Command)
  • Core motion model with reusable UI-agnostic logic
  • Unit test coverage across core and TUI state logic
  • Per-buffer cursor/viewport state preservation
  • File open and write flows
  • Multi-buffer session architecture in core
  • Incremental loading for large files
  • Buffer switching commands (:e, :bn, :bp, :ls)
  • Intelligent dirty tracking (dirty clears when content returns to saved/original state)
  • Editable file explorer/picker widget
  • Fuzzy file finder for project directory search
  • Global file pinning and pinboard popup
  • Style module with explicit RGB-ish theme colours
  • :about screen with version info
  • Relative line numbers (no standard line numbers because those are objectively worse)
  • Directory launch mode with redox .
  • Visual mode and visual line mode
  • Visual block mode
  • Basic session-bound undo/redo
  • Tree-sitter syntax highlighting for
    • Rust
    • Markdown
    • C/C++
    • Go
    • Lua
    • Python
    • HTML
    • CSS
    • JS/TS
    • JSON
    • TOML
    • YAML
  • Smart indenting with Tree-sitter
  • Subtle colour column at col=80
  • Scope indicator lines and delimiter pair highlighting
  • Compound motions (like daw or ci")
  • Basic local search (/, f, F)
  • Performance popup for frame timing
  • Toast/status popups for longer messages
  • LSP diagnostics, go-to-definition, completion, snippets, and language tool management
  • LSP symbol renaming (project-wide)
  • LSP document formatting
  • LSP code actions and quick fixes
  • Basic git integration (diff stats)
  • Undo tree UI with stored history
  • Grep-based finder for searching text patterns across files
  • More extendable leader key system with "whichkey" functionality
  • A dashboard screen with similar functionality to nvim dashboards
  • More persistent project/session state
  • Broader fuzzy finder indexing and async refresh for very large repositories
  • Editor command palette, making use of the fuzzy matching logic
  • More Vim motions (ongoing, not marking this complete until I've caught them all!)

License

Redox is under the terms of the MIT License.