A post-modern modal text editor. https://helix-editor.com
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
Skyler Hawthorne b2e83f81e1
enable rendering in integration tests (#5819)
1 day ago
.cargo enable rendering in integration tests (#5819) 1 day ago
.github ci: Merge two jobs 2 months ago
book Add `ui.virtual.wrap` to theme docs (#5823) 1 day ago
contrib Add Appstream metadata file (#5643) 2 weeks ago
docs Add Appstream metadata file (#5643) 2 weeks ago
helix-core Fix utf8 length handling for shellwords (#5738) 4 days ago
helix-dap build(deps): bump which from 4.3.0 to 4.4.0 (#5655) 2 weeks ago
helix-loader build(deps): bump toml from 0.6.0 to 0.7.0 (#5726) 6 days ago
helix-lsp Support goto-declaration LSP command (#5646) 6 days ago
helix-term enable rendering in integration tests (#5819) 1 day ago
helix-tui Fix clippy 1.67 warnings (#5697) 1 week ago
helix-vcs build(deps): bump git-repository from 0.31.0 to 0.32.0 (#5476) 4 weeks ago
helix-view provide option to completely disable lsp 3 days ago
runtime Add MSBuild language based on XML grammar (#5793) 2 days ago
xtask build(deps): bump toml from 0.6.0 to 0.7.0 (#5726) 6 days ago
.envrc Work around a nix-direnv issue 12 months ago
.gitattributes Add .gitattributes (#3318) 6 months ago
.gitignore Remove vale from .gitignore 6 months ago
.ignore Add a .ignore file to make ripgrep more useful (#3315) 6 months ago
CHANGELOG.md Add changelog notes for 22.12 (#4822) 2 months ago
Cargo.lock build(deps): bump toml from 0.7.0 to 0.7.1 (#5745) 6 days ago
Cargo.toml enable rendering in integration tests (#5819) 1 day ago
LICENSE Add the LICENSE file. 2 years ago
README.md Update the cargo installation instructions to include --locked (#5443) 4 weeks ago
VERSION Add changelog notes for 22.12 (#4822) 2 months ago
base16_theme.toml Set ui.text.inactive for official themes 2 months ago
default.nix build(nix): update flake deps, add default.nix file 8 months ago
flake.lock build(nix): update inputs (#5219) 2 months ago
flake.nix flake: Fix devshell for darwin hosts (#5368) 1 month ago
grammars.nix nix: replace `runCommandNoCC` with `runCommand` (#3992) 4 months ago
languages.toml Add Podfile and *.podspec to the file types for ruby (#5811) 2 days ago
logo.svg Add the new logo! 2 months ago
logo_dark.svg Add logo with text included (#4973) 2 months ago
logo_light.svg Add logo with text included (#4973) 2 months ago
rust-toolchain.toml pin the rust toolchain to 1.61.0 9 months ago
rustfmt.toml Add rustfmt.toml to force formatting to use rustfmt defaults 2 years ago
screenshot.png update screenshot (#1879) 10 months ago
shell.nix build(nix): update flake deps, add default.nix file 8 months ago
theme.toml Add `markup.strikethrough` theme keys (#5619) 2 weeks ago

README.md

Helix

Build status GitHub Release Documentation GitHub contributors Matrix Space

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.

Troubleshooting

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.

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

Installation

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 ./runtime/grammars.

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

OS Command
Windows (Cmd) xcopy /e /i runtime %AppData%\helix\runtime
Windows (PowerShell) xcopy /e /i runtime $Env:AppData\helix\runtime
Linux / macOS ln -s $PWD/runtime ~/.config/helix/runtime

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.

PowerShell:

New-Item -ItemType SymbolicLink -Target "runtime" -Path "$Env:AppData\helix\runtime"

Cmd:

cd %appdata%\helix
mklink /D runtime "<helix-repo>\runtime"

The runtime location can be overridden via the HELIX_RUNTIME environment variable.

NOTE: if HELIX_RUNTIME is set prior to calling cargo install --locked --path helix-term, tree-sitter grammars will be built in $HELIX_RUNTIME/grammars.

If you plan on keeping the repo locally, an alternative to copying/symlinking runtime files is to set HELIX_RUNTIME=/path/to/helix/runtime (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_RUNTIME path, it will automatically detect the runtime directory in the project root.

If you want to customize your languages.toml config, 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.

Packaging status

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 kitty:

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

macOS

Helix can be installed on macOS through homebrew:

brew install helix

Contributing

Contributing guidelines can be found here.

Getting help

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

Credits

Thanks to @JakeHL for designing the logo!