{"id":13496648,"url":"https://github.com/zee-editor/zee","last_synced_at":"2025-12-12T13:52:24.582Z","repository":{"id":37989510,"uuid":"223287266","full_name":"zee-editor/zee","owner":"zee-editor","description":"A modern text editor for the terminal written in Rust","archived":false,"fork":false,"pushed_at":"2025-02-06T18:41:38.000Z","size":1101,"stargazers_count":1546,"open_issues_count":42,"forks_count":43,"subscribers_count":20,"default_branch":"master","last_synced_at":"2025-04-20T09:12:37.437Z","etag":null,"topics":["async","cross-platform","emacs","ide","incremental-parsing","rope","rust-lang","text-editor","tree-sitter"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zee-editor.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-21T23:58:51.000Z","updated_at":"2025-04-18T13:11:45.000Z","dependencies_parsed_at":"2025-02-21T16:00:51.564Z","dependency_job_id":"4bad57c1-6b43-41ce-8965-46ebd9cf63b6","html_url":"https://github.com/zee-editor/zee","commit_stats":null,"previous_names":["mcobzarenco/zee"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zee-editor%2Fzee","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zee-editor%2Fzee/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zee-editor%2Fzee/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zee-editor%2Fzee/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zee-editor","download_url":"https://codeload.github.com/zee-editor/zee/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251559457,"owners_count":21609019,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","cross-platform","emacs","ide","incremental-parsing","rope","rust-lang","text-editor","tree-sitter"],"created_at":"2024-07-31T19:01:54.744Z","updated_at":"2025-12-12T13:52:19.532Z","avatar_url":"https://github.com/zee-editor.png","language":"Rust","funding_links":[],"categories":["Rust","text-editor","\u003ca name=\"editors\"\u003e\u003c/a\u003eEditors","Table of Contents"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Zi logo\" src=\"https://user-images.githubusercontent.com/797170/76172978-08909000-6193-11ea-9ed3-4c40d3a4c74b.png\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/mcobzarenco/zee/actions?query=workflow%3ABuild\"\u003e\n    \u003cimg alt=\"Build Status\" src=\"https://github.com/mcobzarenco/zi/workflows/Build/badge.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://crates.io/crates/zee\"\u003e\n    \u003cimg alt=\"Crates.io\" src=\"https://img.shields.io/crates/v/zee.svg\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nZee is a modern editor for the terminal, _in the spirit of Emacs_. It is written in Rust and it is\nsomewhat experimental.\n\nIn the old tradition of text editor demos, here's what it currently looks like editing its own\nsource code\n\n![Peek 2020-03-09 00-16](https://user-images.githubusercontent.com/797170/76173969-0bdc4980-619c-11ea-9f24-7899e2722910.gif)\n\n## features\n\n- The 100 FPS editor. Cursor movement and edits render under 10ms. Everything else happens asynchronously (syntax parsing and highlighting, IO to/from disk, file pickers).\n- Buffers are backed by a fast B-tree implementation of a [rope](\u003chttps://en.wikipedia.org/wiki/Rope_(data_structure)\u003e) (via cessen's [ropey](https://github.com/cessen/ropey)).\n- Edit tree history, aka. undo/redo tree\n- Uses [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) for generating a parse tree from your code. This AST is used for syntax highlighting and on the fly validation. As it is an incremental parsing library, it scales to files with 1 million lines of code.\n- multi-buffer, multi-pane -- shared state _beats_ tmux with multiple editors\n- fast recursive file search with fuzzy matching and aware of _ignore_ files (using BurntSushi's ripgrep crates [walkdir](https://github.com/BurntSushi/walkdir), [ignore](https://github.com/BurntSushi/ripgrep))\n- local file picker with directory navigation\n- a pragmatic editor, not a research endeavour into CRDTs\n\n## getting started\n\nThe recommended way to install zee is using [cargo](https://crates.io/)\n\n```\ncargo install --locked zee\n```\n\nTo start the editor run `zee`. As expected, you can pass in one or multiple files to be opened, e.g. `zee file1 file2`.\n\n### install options\n\nTo enable integration with your system's clipboard, install zee with the `system-clipboard` feature\n\n```\ncargo install --locked --features system-clipboard zee\n```\n\nTo build with clipboard support, you'll additionally need x11 bindings on Linux. On a _Debian-y_ distribution, you can install them like this\n\n```\nsudo apt install xorg-dev libxcb-shape0-dev libxcb-xfixes0-dev\n```\n\n#### nightly version\n\nTo install the latest version directly from the official repository, just run\nthe following command:\n\n```\ncargo install --git https://github.com/zee-editor/zee\n```\n\n**Important:** please note that the code base state fetched by this instruction\ncould contain work-in-progress features which might need some further\nmaintenance before being included in the release of the next stable version.\n\n### configuration\n\nZee is customised using a [`config.ron`](zee/config/config.ron) file inside the configuration directory.\n\nTo create the default configuration file, use the `--init` command line argument.\n\n```\nzee --init\n```\n\nIf `config.ron` doesn't already exist, `zee --init` will create a fresh configuration file with comments, ready to be edited.\n\nThe exact location of the configuration directory is system specific, e.g. `~/.config/zee` on Linux or macOS\nand `%AppData%/zee` on Windows. The location of the configuration directory can be overwritten by setting the environment variable `ZEE_CONFIG_DIR`.\n\n```\nZEE_CONFIG_DIR=/home/user/.zee zee --init --build\n```\n\nThis command will initialise a configuration directory at `/home/user/.zee` and immediately download and build the configured tree sitter parsers. See below details on the `--build` command line argument.\n\n### syntax highlighting\n\nZee uses [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) parsers for\nsyntax highlighting and on the fly validation of source code. Each tree sitter\nparser is compiled to a shared object which is linked dynamically. To download\nand build the parsers, simply run\n\n```\nzee --build\n```\n\nThe parsers are downloaded, compiled and placed in a `grammars` directory inside the config\ndirectory. The exact location is system specific, e.g. `~/.config/zee/grammars` on Linux or macOS\nand `%AppData%/zee/grammars` on Windows.\n\nThe parsers are either the ones configured in the `config.ron` file or the\ndefault ones if no configuration file is found.\n\nIf you change the parsers in the `config.ron` file, you'll have to re-run the build command.\n\n## building from source\n\nZee is written in Rust and it requires the latest stable compiler to build. You can use cargo to\nbuild it as you'd expect\n\n```\ngit clone https://github.com/zee-editor/zee.git \u0026\u0026 cd zee\ncargo run -- zee/src/main.rs\n```\n\nThe editor also depends on tree sitter parsers, one for each supported language,\nsee [configuration](#configuration). Each tree sitter parser is compiled to a\nshared object which is linked dynamically.\n\nRunning `cargo build` downloads and builds this parsers just to ensure\neverything works correctly. You can skip this step by setting\n`ZEE_DISABLE_GRAMMAR_BUILD`, e.g.\n\n```\nZEE_DISABLE_GRAMMAR_BUILD=t cargo run -- zee/src/main.rs\n```\n\n## usage\n\nTo start the editor run `zee`. As expected, you can pass in one or multiple files to be opened,\ne.g. `zee file1 file2`.\n\nZee uses Emacs-y keybindings. Feeling at home with the default Emacs bindings is a goal of the\nproject.\n\nBelow, `C-` means `Ctrl` + the specified key, e.g. `C-k` is `Ctrl + k`. Similarly `A-` means\n`Alt` + the specified key. Empty spaces denote a sequence of key presses, e.g. `C-x C-c` means\nfirst pressing `C-x` followed by `C-c`.\n\nThe following keybindings are available\n\n### movement\n\n- `C-f`, `Right` move forward\n- `C-b`, `Left` move backward\n- `C-n`, `Down` move down\n- `C-p`, `Up` move up\n- `A-f` move forward by one word\n- `A-b` move backward by one word\n- `A-n` move forward by one paragraph\n- `A-p` move backward by one paragraph\n- `C-a`, `Home` move to start of line\n- `C-e`, `End` move to end of line\n- `C-v`, `PageDown` move down one page\n- `A-v`, `PageUp` move up one page\n- `A-\u003c` move to the beginning of the buffer\n- `A-\u003e` move to the end of the buffer\n- `C-l` centre the cursor visually\n\n### editing\n\n- `C-d` delete forwards\n- `Backspace` delete backwards\n- `C-k` delete the current line\n- `C-SPC` enter selection mode at the current cursor position\n- `C-w` cut selection\n- `A-w` copy selection\n- `C-x h` select the entire buffer and move the cursor to the beginning\n- `C-y` paste selection (yank in Emacs)\n- `C-g` clear the current selection\n- `C-_`, `C-z`, `C-/` undo previous command\n- `C-q` redo previous command\n- `C-x u` open the edit tree viewer\n- `Enter` insert a new line, moving the cursor\n- `C-o` insert a new line after the cursor, without moving it\n- `C-x C-s` save the current buffer\n\n### file navigation\n\n- `C-x C-f` choose a file to open using a directory-level picker\n- `C-x C-v` search recursively for a file to open from the selected directory\n- `C-l` while opening a file, go to the parent directory\n- `Tab` while opening a file, fills in the currently selected path\n\n### edit tree viewer\n\n- `C-p`, `Up` move up the tree to an older revision, undoing the command\n- `C-n`, `Down` move down the tree to a newer revision, redoing the command\n- `C-b`, `Left` select the left child of current revision\n- `C-f`, `Right` select the right child of current revision\n\n### global\n\n- `C-g` cancel the current operation\n- `C-x k` choose a buffer to close\n- `C-x b` switch the current window to another buffer\n- `C-x 0`, `C-x C-0` close the focused window\n- `C-x 1`, `C-x C-1` make the focused window fullscreen\n- `C-x 2`, `C-x C-2` split the focused window below\n- `C-x 3`, `C-x C-3` split the focused window to the right\n- `C-x o`, `C-x C-o` switch focus to the next buffer\n- `C-x C-t` cycle through the available themes\n- `C-x C-c` quit\n\n## license\n\nThis project is licensed under either of\n\n- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or\n  http://www.apache.org/licenses/LICENSE-2.0)\n- MIT license ([LICENSE-MIT](LICENSE-MIT) or\n  http://opensource.org/licenses/MIT)\n\nat your discretion.\n\n### contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion by you, as defined in the Apache-2.0 license, shall be dual\nlicensed as above, without any additional terms or conditions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzee-editor%2Fzee","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzee-editor%2Fzee","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzee-editor%2Fzee/lists"}