A post-modern modal text editor.
Go to file
Fanda Vacek 76d55c0d9e
Cpon support tree sitter version bumped (#2424)
Co-authored-by: Fanda Vacek <fvacek@elektroline.cz>
2022-05-07 06:47:15 -05:00
.cargo docs: Auto generate command list 2021-12-08 10:23:50 +09:00
.github AppImage (#2089) 2022-04-20 10:43:52 +09:00
book feat(languages): add odin language (#2399) 2022-05-05 12:09:09 -05:00
contrib AppImage (#2089) 2022-04-20 10:43:52 +09:00
docs Fix typo (#2264) 2022-04-25 07:26:02 -05:00
helix-core feat(languages): git-ignore and git-attributes (#2397) 2022-05-05 08:47:28 -05:00
helix-dap Use which to resolve lsp/dap binaries 2022-02-24 11:38:40 +09:00
helix-loader helix-loader + helix-core now compile for WASM 2022-05-01 11:39:07 +09:00
helix-lsp build(deps): bump tokio from 1.17.0 to 1.18.1 (#2373) 2022-05-03 09:31:05 +09:00
helix-term Making the 'set-option' command help more descriptive. (#2365) 2022-05-04 11:17:08 +09:00
helix-tui fix typos (#2304) 2022-04-27 14:21:20 -05:00
helix-view cfg-gate unused functions on macos & windows (#2332) 2022-05-02 23:31:23 +09:00
runtime fix Markdown list highlighting (#2401) 2022-05-07 11:26:34 +09:00
xtask Making the 'set-option' command help more descriptive. (#2365) 2022-05-04 11:17:08 +09:00
.envrc Work around a nix-direnv issue 2022-02-25 18:01:47 +09:00
.gitignore Dynamically load grammar libraries at runtime 2021-07-14 10:00:05 +09:00
base16_theme.toml Add markup support (#1525) 2022-01-23 11:18:50 +09:00
Cargo.lock build(deps): bump serde_json from 1.0.79 to 1.0.80 (#2376) 2022-05-03 09:31:55 +09:00
Cargo.toml migrate grammar fetching/building code into helix-loader crate 2022-03-10 17:31:57 +09:00
CHANGELOG.md fix typos (#2304) 2022-04-27 14:21:20 -05:00
flake.lock Fix build on aarch64-darwin (#1789) 2022-05-03 17:32:44 -05:00
flake.nix Fix build on aarch64-darwin (#1789) 2022-05-03 17:32:44 -05:00
grammars.nix Use fromTOML on Nix >= 2.6.0 (#1892) 2022-03-30 11:28:05 -05:00
languages.toml Cpon support tree sitter version bumped (#2424) 2022-05-07 06:47:15 -05:00
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md fix(docs): cleanup obsolete indents.toml mentions (#2327) 2022-04-29 12:40:59 -05:00
rust-toolchain.toml Switch rust-toolchain.toml over to stable 2021-09-08 16:34:04 +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 Fix nix shell by hardcoding the flakecompat library (#2196) 2022-04-20 09:55:09 -05:00
theme.toml theme ui.virtual capture for existing themes 2022-04-20 11:37:23 +09:00
VERSION set VERSION file to dev (#1883) 2022-03-31 16:31:38 +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
hx --grammar fetch
hx --grammar build

This will install the hx binary to $HOME/.cargo/bin and build tree-sitter grammars.

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 xcopy runtime %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).