A post-modern modal text editor.
Go to file
2021-06-14 17:39:01 +09:00
.github Add bug report template 2021-06-12 10:39:46 +09:00
book add symbol picker (#230) 2021-06-12 21:45:21 +09:00
contrib Add onedark theme 2021-06-14 17:39:01 +09:00
docs Update architecture.md 2021-05-30 17:52:46 +09:00
helix-core Release v0.2.0 2021-06-13 22:35:13 +09:00
helix-lsp Release v0.2.0 2021-06-13 22:35:13 +09:00
helix-syntax Release v0.2.0 2021-06-13 22:35:13 +09:00
helix-term Bump crossterm from 0.19.0 to 0.20.0 2021-06-14 17:36:47 +09:00
helix-tui Bump crossterm from 0.19.0 to 0.20.0 2021-06-14 17:36:47 +09:00
helix-view Bump crossterm from 0.19.0 to 0.20.0 2021-06-14 17:36:47 +09:00
runtime/queries Add Nix runtime 2021-06-10 22:01:48 +09:00
.envrc build(nix): use nix-cargo-integration, make shell.nix use flake devshell 2021-06-13 14:46:51 +09:00
.gitignore ignore Nix outputs 2021-06-10 22:00:53 +09:00
.gitmodules Add Nix syntax 2021-06-10 22:01:48 +09:00
Cargo.lock Bump anyhow from 1.0.40 to 1.0.41 2021-06-14 17:36:56 +09:00
Cargo.toml Inline tui as helix-tui fork. 2021-05-09 17:52:55 +09:00
flake.lock chore(nix): update nixCargoIntegration input 2021-06-13 23:38:14 +09:00
flake.nix build(nix): use nix-cargo-integration, make shell.nix use flake devshell 2021-06-13 14:46:51 +09:00
languages.toml Only auto-format for certain languages 2021-06-12 10:20:37 +09:00
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md Update README 2021-06-12 17:26:41 +08:00
screenshot.png Add screenshot to README. 2021-05-12 16:52:36 +09:00
shell.nix build(nix): use nix-cargo-integration, make shell.nix use flake devshell 2021-06-13 14:46:51 +09:00
theme.toml Change help prompt styling 2021-06-01 12:00:25 +09:00
TODO.md Update deps, introduce the new tree-sitter lifetimes 2021-05-28 00:00:51 +09:00

Helix

Build status

Screenshot

A kakoune / neovim inspired editor, written in Rust.

The editing model is very heavily based on kakoune; during development I found myself agreeing with most of kakoune's design decisions.

For more information, see the website or documentation.

All shortcuts/keymaps can be found in the documentation on the website

Features

  • Vim-like modal editing
  • Multiple selections
  • Built-in language server support
  • Smart, incremental syntax highlighting and code editing via tree-sitter

It's a terminal-based editor first, but I'd like to explore a custom renderer (similar to emacs) in wgpu or skulpin.

Installation

Note: Only certain languages have indentation definitions at the moment. Check runtime/<lang>/ for indents.toml.

We provide packaging for various distributions, but here's a quick method to build from source.

git clone --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix
cd helix
cargo install --path helix-term

This will install the hx binary to $HOME/.cargo/bin.

Now copy the runtime/ directory somewhere. Helix will by default look for the runtime inside the config directory or the same directory as executable, but that can be overriden via the HELIX_RUNTIME environment variable.

NOTE: running via cargo doesn't require setting explicit HELIX_RUNTIME path, it will automatically detect the runtime directory in the project root.

If you want to embed the runtime/ directory into the Helix binary you can build it with:

cargo install --path helix-term --features "embed_runtime"

Arch Linux

There are two packages available from AUR:

  • helix-bin: contains prebuilt binary from GitHub releases
  • helix-git: builds the master branch of this repository

MacOS

Helix can be installed on MacOS through homebrew via:

brew tap helix-editor/helix
brew install helix

Contributing

Contributors are very welcome! No contribution is too small and all contributions are valued.

Some suggestions to get started:

  • You can look at the good first issue label on the issue tracker.
  • Help with packaging on various distributions needed!
  • To use print debugging to the ~/.cache/helix/helix.log file, you must:
    • Print using log::info!, warn!, or error!. (log::info!("helix!"))
    • Pass the appropriate verbosity level option for the desired log level. (hx -v <file> for info, more vs for higher severity inclusive)
  • If your preferred language is missing, integrating a tree-sitter grammar for it and defining syntax highlight queries for it is straight forward and doesn't require much knowledge of the internals.

We provide an architecture.md that should give you a good overview of the internals.

Getting help

Discuss the project on the community Matrix Space (make sure to join #helix-editor:matrix.org if you're on a client that doesn't support Matrix Spaces yet).