curd-editor 0.6.0

A small terminal code editor: projects with a file tree, git status, tabs, quick open and language-server support
curd-editor-0.6.0 is not a library.

curd

A small terminal code editor written in Rust with crossterm: open a folder as a project, browse it in a file tree with git status colours, keep several files open in tabs, and get colours, errors, hover and go-to-definition from language servers.

Package name: curd-editor (curd is taken on crates.io). Command name: curd.

Install

One command, no Rust needed. It downloads the latest release for your system.

Linux and macOS:

curl -fsSL https://raw.githubusercontent.com/vikram5258/crud-editor/main/install.sh | sh

Windows (PowerShell):

irm https://raw.githubusercontent.com/vikram5258/crud-editor/main/install.ps1 | iex

Then:

curd .               # open the current folder as a project
curd src/main.rs     # open one file (or several: they open in tabs)
curd                 # start with an empty file

Other ways to get it:

  • With Rust installed: cargo install curd-editor
  • By hand: download a binary from the releases page

Run

cargo run -- src/main.rs

Keys

Project and files:

Key What it does
Ctrl+P quick open: type part of a file name, Enter opens it, Esc cancels
Ctrl+B or Alt+B show or hide the file tree
Alt+E move between the file tree and the text (Esc also leaves the tree)
Arrows, Enter (in the tree) move; Enter or Right opens a folder or file, Left closes a folder
Alt+. and Alt+, next / previous tab (Ctrl+PageDown / Ctrl+PageUp also work)
Alt+1 ... Alt+9 go to that tab
Ctrl+W or Alt+W close the file in front (asks for a second press if it has unsaved changes)
Ctrl+S save
Ctrl+Q quit (asks for a second press if any file has unsaved changes)

Editing:

Key What it does
Typing, Enter, Tab insert text, a new line, four spaces
Backspace / Delete delete before / under the cursor (joins lines at a line edge)
Arrows, Home, End move the cursor; the view scrolls in both directions
Alt+K or Ctrl+K fold / unfold the block on, or around, the cursor line
Alt+A fold every top-level block, or unfold everything
Alt+H or F2 hover: show what the language server knows about the thing under the cursor
Alt+G or F12 go to definition, opening the file it is in if needed
Tab after a trigger word expand a snippet (see below)

Mouse: click a file or folder in the tree, a tab, or a spot in the text; the wheel scrolls whatever is under the pointer. Because curd listens to the mouse, selecting text to copy with the terminal needs Shift held while dragging (Option on macOS Terminal).

Some terminals keep certain Ctrl keys for themselves (VS Code's terminal takes Ctrl+K, Ctrl+B, Ctrl+P and Ctrl+W), which is why most commands also have an Alt or function-key form.

Projects

curd some-folder opens the folder as a project. curd some-file works out the project from the file: its git repository if it is in one, otherwise the folder it sits in. Ctrl+B shows the tree either way.

  • File tree: folders first, then files. Folders are read only when you open them, so large projects open instantly. The tree follows the file in front, and is re-read when you save or come back to the terminal window.
  • Git status colours, with a letter at the right edge of the tree, the same idea as VS Code:
Colour Letter Meaning
plain committed and unchanged
yellow M modified since the last commit, not staged
cyan S staged with git add, waiting to be committed
green U untracked: a new file git does not know yet
red ! merge conflict
dim ignored by .gitignore

A folder takes the colour of the most pressing change inside it. The current branch is shown under the tree. The status comes from the git command, run in the background so it never holds up typing.

  • Tabs: every open file keeps its own cursor, folds and unsaved changes. The tab bar appears when two or more files are open; a ● marks unsaved changes.
  • Quick open (Ctrl+P): searches every file git tracks or would track (so not target/ or node_modules/). Letters can be spread out: wsrs finds workspace.rs.

Language servers (LSP)

curd gets colours, errors, warnings, hover and go-to-definition from the same language servers VS Code and other editors use. It starts the server for the file's type, if it is installed. One server looks after all the open files of its language in a project, so opening more files does not start more servers:

Language Server Install
Rust rust-analyzer rustup component add rust-analyzer
Python pyright-langserver npm install -g pyright
JavaScript / TypeScript typescript-language-server npm install -g typescript typescript-language-server
C / C++ clangd your system's clangd package
Go gopls go install golang.org/x/tools/gopls@latest
  • Colours: come from two places, as in VS Code. A small built-in scanner colours keywords, strings, comments and numbers the instant a file opens and on every key, with or without a server. The server then says what each piece of code really is (function, type, macro and so on) and its colours are laid over the scanner's a moment later. They are your terminal's own sixteen colours, so they match your terminal theme.
  • Underlines: the exact code an error or warning is about is underlined. Unused code is shown faded and deprecated code struck through.
  • Lines with a problem get a red E or yellow W beside the line number; move the cursor onto the line to read the message in the status bar. The status bar also shows a count, like E:1 W:2.
  • Without a server installed, curd works as a plain editor and says so once in the status bar.
  • CURD_LSP=off curd file.rs turns servers off. CURD_LSP="my-server --stdio" curd file.rs uses a different one.

How it works: curd runs the server as a child process and talks to it over stdin/stdout. Edits are sent as small changes (not the whole file), batched while you type, and a background thread reads the answers, so typing never waits on the server.

Code editing

  • Line numbers in a column on the left.
  • Folding: lines that start a block have a - beside their line number. Alt+K (or Ctrl+K) collapses the block into one row, shown as fn main() { ... } with a +; the same key opens it again. Alt+A folds or unfolds everything. Blocks are { ... } in most languages and indentation in Python. Folding only changes the view, never the file.
  • Auto-indent: Enter keeps the current indentation and adds a level after {, ( or [ (and after : in Python). Typing } on a blank line steps back a level.
  • Paste: pasted text goes in exactly as copied, without auto-indent.
  • Snippets: type a trigger word and press Tab. Which ones exist depends on the file extension:
Language Triggers
Rust (.rs) fn main struct enum impl match if for while loop test tests pl
Python (.py) def class if for while main try
JavaScript / TypeScript fn afn if for while log
C / C++ main if for while inc
Go (.go) fn main if for err

For example, in a .rs file main + Tab becomes:

fn main() {
    |
}

curd new-file.txt starts an empty document and creates the file on the first save. The bottom row is a status bar with the file name, a [modified] marker and the cursor position.

Test

cargo test                # unit tests + end-to-end tests
cargo llvm-cov            # same, with a coverage report (cargo install cargo-llvm-cov)
  • Unit tests sit next to the code in a tests.rs file per module, such as src/editor/tests.rs.
  • End-to-end tests in tests/e2e.rs start the real curd in a pseudo-terminal, send keys and check the screen (Linux/macOS only).
  • The language-server tests use a small fake server, tests/fake_lsp.py (needs python3). To also test against the real rust-analyzer: cargo test --test e2e -- --ignored.

Test files are left out of the published crate (see include in Cargo.toml).

CI runs the tests on every push and pull request and saves a JUnit test report and a coverage report as artifacts on the run. Pushing a v* tag runs the same checks first and only publishes a release (GitHub binaries, then crates.io) if they pass.

Layout

  • src/main.rs — reads the arguments and starts everything up
  • src/workspace.rs — the whole window: tabs, file tree, quick open, routing keys, mouse and language-server messages
  • src/tree.rs — the file tree
  • src/git.rs — git status and branch, read from the git command
  • src/finder.rs — quick open and its fuzzy matching
  • src/screen.rs — styled rows of text, and drawing only the rows that changed
  • src/terminal.rs — raw mode, alternate screen, mouse and focus reports, screen size (restored on drop)
  • src/document.rs — the text (lines), editing it, opening and saving files
  • src/editor.rs — one open file: keys, editing, scrolling, its part of the screen, status bar
  • src/folds.rs — finding { ... } blocks and tracking which are collapsed
  • src/snippets.rs — snippet tables per language
  • src/lsp.rs — language server client: starting servers, the wire format, requests and replies
  • src/highlight.rs — colours: the built-in scanner, and the server's colours kept per line and moved along as you type

Progress

  • Step 1: raw mode, read keys, Ctrl+Q
  • Step 2: draw the screen with ~ and a welcome message
  • Step 3: open a file and show it (modular refactor)
  • Step 4: cursor movement and vertical scrolling
  • Step 5: typing and deleting
  • Step 6: save with Ctrl+S, unsaved-changes warning, new files
  • Status bar and horizontal scrolling
  • Line numbers, code folding, snippets, auto-indent, paste
  • LSP: diagnostics, hover, go to definition
  • Colours, underlines and other decorations from the language server
  • Built-in syntax colouring, so colours never wait for the server
  • Projects: file tree, tabs, quick open, git status colours, mouse
  • One language server shared by all open files; go to definition across files
  • LSP: completion
  • Git: changed-line markers beside the text
  • Challenge: PageUp / PageDown
  • Save as (name a file started without one)
  • Search, undo