||2 months ago|
|.cargo||7 months ago|
|.github||2 months ago|
|.idea||4 months ago|
|book||2 months ago|
|contrib||3 months ago|
|docs||5 months ago|
|helix-core||2 months ago|
|helix-dap||2 months ago|
|helix-loader||2 months ago|
|helix-lsp||2 months ago|
|helix-term||2 months ago|
|helix-tui||2 months ago|
|helix-vcs||2 months ago|
|helix-view||2 months ago|
|runtime||2 months ago|
|xtask||2 months ago|
|.envrc||1 year ago|
|.gitattributes||8 months ago|
|.gitignore||8 months ago|
|.ignore||8 months ago|
|CHANGELOG.md||4 months ago|
|Cargo.lock||2 months ago|
|Cargo.toml||4 months ago|
|LICENSE||2 years ago|
|README.md||2 months ago|
|VERSION||4 months ago|
|base16_theme.toml||3 months ago|
|default.nix||9 months ago|
|flake.lock||3 months ago|
|flake.nix||3 months ago|
|grammars.nix||6 months ago|
|languages.toml||2 months ago|
|logo.svg||4 months ago|
|logo_dark.svg||4 months ago|
|logo_light.svg||4 months ago|
|rust-toolchain.toml||2 months ago|
|rustfmt.toml||2 years ago|
|screenshot.png||6 months ago|
|shell.nix||9 months ago|
|theme.toml||2 months ago|
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.
- 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.
Note: Only certain languages have indentation definitions at the moment. Check
Packages are available for various distributions (see Installation docs).
If you would like to build from source:
git clone https://github.com/helix-editor/helix cd helix cargo install --locked --path helix-term
This will install the
hx binary to
$HOME/.cargo/bin and build tree-sitter grammars in
Helix needs its runtime files so make sure to copy/symlink the
runtime/ directory into the
config directory (for example
~/.config/helix/runtime on Linux/macOS, or
%AppData%/helix/runtime on Windows).
|Linux / macOS||
Starting with Windows Vista you can also create symbolic links on Windows. Note that this requires elevated privileges - i.e. PowerShell or Cmd must be run as administrator.
New-Item -ItemType SymbolicLink -Target "runtime" -Path "$Env:AppData\helix\runtime"
cd %appdata%\helix mklink /D runtime "<helix-repo>\runtime"
The runtime location can be overridden via the
HELIX_RUNTIME environment variable.
HELIX_RUNTIMEis set prior to calling
cargo install --locked --path helix-term, tree-sitter grammars will be built in
If you plan on keeping the repo locally, an alternative to copying/symlinking
runtime files is to set
HELIX_RUNTIME=$PWD/runtime if you're in the helix repo directory).
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_RUNTIMEpath, it will automatically detect the
runtimedirectory in the project root.
If you want to customize your
tree-sitter grammars may be manually fetched and built with
hx --grammar fetch and
hx --grammar build.
In order to use LSP features like auto-complete, you will need to install the appropriate Language Server for a language.
Adding Helix to your desktop environment
If installing from source, to use Helix in desktop environments that supports XDG desktop menu, including Gnome and KDE, copy the provided
.desktop file to the correct folder:
cp contrib/Helix.desktop ~/.local/share/applications cp contrib/helix.png ~/.local/share/icons
To use another terminal than the default, you will need to modify the
.desktop file. For example, to use
sed -i "s|Exec=hx %F|Exec=kitty hx %F|g" ~/.local/share/applications/Helix.desktop sed -i "s|Terminal=true|Terminal=false|g" ~/.local/share/applications/Helix.desktop
Helix can be installed on macOS through homebrew:
brew install helix
Contributing guidelines can be found here.
Your question might already be answered on the FAQ.
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).