Fork of helix with some PRs merged
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
Nathan Vegdahl e191a75e33 Give default document a single line ending. 3 years ago
.github action: copy grammar libraries to runtime 3 years ago
book Quite edit page 3 years ago
contrib Move themes to runtime/themes, add link from contrib/themes 4 years ago
docs Update architecture.md 4 years ago
helix-core Fixes for new clippy lints in Rust 1.54. 3 years ago
helix-lsp Bump tokio from 1.8.2 to 1.9.0 3 years ago
helix-syntax Simplify replace dashes with underscore 3 years ago
helix-term Fix incorrect behavior of `find_char` command and friends. 3 years ago
helix-tui Calculate completion popup sizing 3 years ago
helix-view Give default document a single line ending. 3 years ago
runtime fix: change primary cursor color in bogster theme 3 years ago
.envrc build(nix): use nix-cargo-integration, make shell.nix use flake devshell 4 years ago
.gitignore Dynamically load grammar libraries at runtime 3 years ago
.gitmodules Add latex 4 years ago
CHANGELOG.md Release 0.3.0 4 years ago
Cargo.lock Bump futures-executor from 0.3.15 to 0.3.16 3 years ago
Cargo.toml Inline tui as helix-tui fork. 4 years ago
LICENSE Add the LICENSE file. 4 years ago
README.md Make instructions regarding runtime clearer 3 years ago
TODO.md minor: Remove old TODOs 4 years ago
flake.lock build(nix): fix build issues 3 years ago
flake.nix build(nix): fix build issues 3 years ago
languages.toml Fixes toggle_comment not finding the correct language comment token 3 years ago
rustfmt.toml Add rustfmt.toml to force formatting to use rustfmt defaults 3 years ago
screenshot.png Add screenshot to README. 4 years ago
shell.nix build(nix): use nix-cargo-integration, make shell.nix use flake devshell 4 years ago
theme.toml Fix number highlighting 3 years ago

README.md

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.

Helix also needs it's runtime files so make sure to copy/symlink the runtime/ directory into the config directory (for example ~/.config/helix/runtime on Linux/macOS). This location can be overriden via the HELIX_RUNTIME environment variable.

Packages already solve this for you by wrapping the hx binary with a wrapper that sets the variable to the install dir.

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

Alternatively, 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"

Packaging status

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).