xi-editor /xi-editor

A modern editor with a backend written in Rust.

★ 19,795⑂ 707👁 386⑃ 806● 534▤ 0
RustApache-2.0Created 2016-04-26xi-editor.io
-1
日增长
19,795
stars
707
forks
386
watchers
806
prs
534
issues
0
releases

README

Xi editor

Maintenance status: The xi-editor project is currently discontinued. Although we will happily accept bug fixes, no new features are currently planned. You may be interested in the Lapce editor, which can be considered a spiritual successor to the xi-editor.
— The Editors

Note: This repo contains only the editor core, which is not usable on its own. For editors based on it, check out the list in Frontends.

The xi-editor project is an attempt to build a high quality text editor,
using modern software engineering techniques. It is initially built for
macOS, using Cocoa for the user interface. There are also frontends for
other operating systems available from third-party developers.

Goals include:

 Incredibly high performance. All editing operations should commit and paint
  in under 16ms. The editor should never make you wait for anything.

 Beauty. The editor should fit well on a modern desktop, and not look like a
  throwback from the ’80s or ’90s. Text drawing should be done with the best
  technology available (Core Text on Mac, DirectWrite on Windows, etc.), and
  support Unicode fully.

 Reliability. Crashing, hanging, or losing work should never happen.

 Developer friendliness. It should be easy to customize xi editor, whether
  by adding plug-ins or hacking on the core.

Learn more with the creator of Xi, Raph Levien, in this Recurse Center Localhost talk.

Screenshot:

!xi-mac screenshot


 Getting started

This repository is the core only. You'll also need a front-end, from the list
below.


 Building the core

Xi-editor targets 'recent stable Rust'. We recommend installing via rustup.
The current minimum supported version is 1.40.

To build the xi-editor core from the root directory of this repo:


 cd rust
 cargo build



 Frontends

Here are some front-ends in various stages of development:

 xi-mac, the official macOS front-end.

 xi-gtk, a GTK+ front-end.

 xi-term, a text UI.

 xi-electron, a cross-platform front-end based on web-technologies.

 Tau, a GTK+ front-end written in Rust. Forked from https://github.com/bvinc/gxi, which was abandoned.

 xi-win, an experimental Windows front-end written in Rust.

 kod, a terminal frontend written in Golang.

 xi-qt, a Qt front-end.

 vixi, a Vim like front-end in Rust.

The following are currently inactive, based on earlier versions of the front-end
protocol, but perhaps could be revitalized:

 xi_glium, an
experimental GL-based front-end in Rust.

 XiEditorVS2015, C.

 xi-android, an Android frontend.

There are notes (I wouldn’t call it
documentation at this point) on the protocol at
frontend.md. If you're working on a front-end, feel free to
send a PR to add it to the above list.


 Design decisions

Here are some of the design decisions, and motivation why they should
contribute to the above goals:

 Separation into front-end and back-end modules. The front-end is responsible for presenting the user interface and
  drawing a screen full of text. The back-end (also known

Top issues

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON