A post-modern modal text editor.
Go to file
2022-08-03 08:21:51 -05:00
.cargo add integration-test cargo alias 2022-06-18 23:57:47 -04:00
.github chore(ci): match *-macos by checking suffix 2022-08-02 12:04:09 +09:00
book feat: add cue support (#3262) 2022-07-31 07:04:57 -05:00
contrib adds --vsplit and --hsplit arguments (#2773) 2022-07-01 18:27:32 +09:00
docs add release checklist and changelog curation docs (#2598) 2022-07-22 10:31:40 +09:00
helix-core Exclude only named children without injection.include-children (#3129) 2022-08-03 19:18:17 +09:00
helix-dap DAP: Make cwd required in RunTerminalArguments 2022-07-05 12:34:03 +02:00
helix-loader feat: support grammar cross-compilation 2022-08-02 12:04:09 +09:00
helix-lsp Suport diagnostic code (#3096) 2022-07-26 10:26:50 +09:00
helix-term feat: support grammar cross-compilation 2022-08-02 12:04:09 +09:00
helix-tui build(deps): bump crossterm from 0.23.0 to 0.24.0 (#2968) 2022-07-05 19:30:33 +09:00
helix-view Fix LF line-endings (#3316) 2022-08-03 07:53:57 -05:00
runtime Inherit javascript/typescript from common 'ecma' queries (#3301) 2022-08-03 14:09:44 +09:00
xtask Add workspace and document diagnostics picker (#2013) 2022-06-30 18:16:18 +09:00
.envrc Work around a nix-direnv issue 2022-02-25 18:01:47 +09:00
.gitattributes Add .gitattributes (#3318) 2022-08-03 08:21:51 -05:00
.gitignore Remove vale from .gitignore 2022-07-26 10:22:28 +09:00
base16_theme.toml Update theme base16_default (ui.menu) (#2794) 2022-06-17 20:24:18 +09:00
Cargo.lock build(deps): bump pulldown-cmark from 0.9.1 to 0.9.2 (#3294) 2022-08-02 10:07:01 +09:00
Cargo.toml migrate grammar fetching/building code into helix-loader crate 2022-03-10 17:31:57 +09:00
CHANGELOG.md Fix link to pop-dark in CHANGELOG.md (#2594) 2022-05-28 13:11:31 -05:00
default.nix build(nix): update flake deps, add default.nix file 2022-06-21 17:39:30 -05:00
flake.lock nix: update nixCargoIntegration (#2907) 2022-06-29 17:53:56 +09:00
flake.nix Only add cargo-tarpaulin on x86_64 (#3252) 2022-07-31 14:52:54 -05:00
grammars.nix build(nix): add a way to override what grammars get built (#3141) 2022-07-27 12:52:07 -05:00
languages.toml feat: add cue support (#3262) 2022-07-31 07:04:57 -05:00
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md Update README command table (#3224) 2022-07-28 05:37:10 -05:00
rust-toolchain.toml pin the rust toolchain to 1.61.0 2022-05-24 01:05:19 +09:00
rustfmt.toml Add rustfmt.toml to force formatting to use rustfmt defaults 2021-07-23 18:11:22 +09:00
screenshot.png update screenshot (#1879) 2022-03-30 00:16:57 +09:00
shell.nix build(nix): update flake deps, add default.nix file 2022-06-21 17:39:30 -05:00
theme.toml Add a default cursorline style for the primary selection 2022-06-27 17:27:24 +09:00
VERSION Fix the VERSION file 2022-05-29 01:07:30 +09:00

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

Helix also 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 runtime %AppData%\helix\runtime
Windows (PowerShell) xcopy 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.

In order to use LSP features like auto-complete, you will need to install the appropriate Language Server for a language.

Packaging status

MacOS

Helix can be installed on MacOS through homebrew via:

brew tap helix-editor/helix
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).