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
Robin van Dijk c0d32707d0 move to first nonwhitespace on shift-i
This matches the behaviour in vim and kak
4 years ago
.github Disable aarch64-macos, it fails to build on macos-latest 4 years ago
book commands: Add goto first non-whitespace char of line 4 years ago
contrib/themes theme: Enable style modifiers in theme.toml, add Ingrid's theme (#113) 4 years ago
docs Update architecture.md 4 years ago
helix-core Downgrade `unicode-segmentation` 4 years ago
helix-lsp Derive debug without feature 4 years ago
helix-syntax Add Nix syntax 4 years ago
helix-term move to first nonwhitespace on shift-i 4 years ago
helix-tui Derive debug without feature 4 years ago
helix-view Implement missing Debug and update Cargo.lock 4 years ago
runtime/queries Add Nix runtime 4 years ago
.envrc Add a nix flake with the development environment. 4 years ago
.gitignore ignore Nix outputs 4 years ago
.gitmodules Add Nix syntax 4 years ago
Cargo.lock Downgrade `unicode-segmentation` 4 years ago
Cargo.toml Inline tui as helix-tui fork. 4 years ago
LICENSE Add the LICENSE file. 4 years ago
README.md Add trace log primer to the Contributing section 4 years ago
TODO.md Update deps, introduce the new tree-sitter lifetimes 4 years ago
flake.lock Fix flake package 4 years ago
flake.nix embed runtime 4 years ago
languages.toml Add Nix syntax 4 years ago
screenshot.png Add screenshot to README. 4 years ago
shell.nix Use upstream jsonrpc again 4 years ago
theme.toml Change help prompt styling 4 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.

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

NOTE: You should set this to /runtime in development (if running via cargo).

export HELIX_RUNTIME=$PWD/runtime

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