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
Michael Davis 5f4f171b73
Fix debug assertion for diagnostic sort order (#4319)
The debug assertion that document diagnostics are sorted incorrectly
panics for cases like `[161..164, 162..162]`. The merging behavior
in the following lines that relies on the assertion only needs the
input ranges to be sorted by `range.start`, so this change simplifies
the assertion to only catch violations of that assumption.
2 years ago
.cargo chore: rename `.cargo/{config -> config.toml}` 2 years ago
.github Document MSRV policy (#3913) 2 years ago
book Show keys required to enter each minor mode (#4302) 2 years ago
contrib fix fish completions for --config & --log (#3912) 2 years ago
docs Document MSRV policy (#3913) 2 years ago
helix-core Rename extend indent captures. 2 years ago
helix-dap feat(csharp,debug): add C# debugger support (#4213) 2 years ago
helix-loader build(deps): bump once_cell from 1.14.0 to 1.15.0 (#3987) 2 years ago
helix-lsp Find workspace from document path (#3553) 2 years ago
helix-term Fix debug assertion for diagnostic sort order (#4319) 2 years ago
helix-tui build(deps): bump unicode-segmentation from 1.9.0 to 1.10.0 (#3903) 2 years ago
helix-view feat(csharp,debug): add C# debugger support (#4213) 2 years ago
runtime themes: Add `bogster_light` theme (#4265) 2 years ago
xtask chore: fix clippy linting 2 years ago
.envrc Work around a nix-direnv issue 3 years ago
.gitattributes Add .gitattributes (#3318) 2 years ago
.gitignore Remove vale from .gitignore 2 years ago
.ignore Add a .ignore file to make ripgrep more useful (#3315) 2 years ago
CHANGELOG.md Fix typos (#3858) 2 years ago
Cargo.lock do not reparse unmodified injections (#4146) 2 years ago
Cargo.toml remove `split-debuginfo` setting (#3691) 2 years ago
LICENSE Add the LICENSE file. 4 years ago
README.md Rearrange README.md slightly (#4206) 2 years ago
VERSION Changelog notes for 22.08.1 (#3639) 2 years ago
base16_theme.toml Update theme base16_default (`ui.menu`) (#2794) 3 years ago
default.nix build(nix): update flake deps, add default.nix file 3 years ago
flake.lock build(nix): update flake deps (#3663) 2 years ago
flake.nix flake: Fix devShell on aarch64-darwin (#3810) 2 years ago
grammars.nix nix: replace `runCommandNoCC` with `runCommand` (#3992) 2 years ago
languages.toml feat(csharp,debug): add C# debugger support (#4213) 2 years ago
rust-toolchain.toml pin the rust toolchain to 1.61.0 3 years ago
rustfmt.toml Add rustfmt.toml to force formatting to use rustfmt defaults 3 years ago
screenshot.png update screenshot (#1879) 3 years ago
shell.nix build(nix): update flake deps, add default.nix file 3 years ago
theme.toml Add a default cursorline style for the primary selection 2 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.

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 --path helix-term

This will install the hx binary to $HOME/.cargo/bin and build tree-sitter 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.exe) 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

This location can be overridden 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.

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

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

Please note: there is no icon for Helix yet, so the system default will be used.

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