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
Blaž Hrastnik ab7885e934
fix: copy_selection needs to account for to() being exclusive
Fixes #1367
Fixes #1590
3 years ago
.cargo docs: Auto generate command list 3 years ago
.github publish a source tarball with version and grammars (#1875) 3 years ago
book Indentation rework (#1562) 3 years ago
contrib Move themes to runtime/themes, add link from contrib/themes 4 years ago
docs migrate grammar fetching/building code into helix-loader crate 3 years ago
helix-core Indentation rework (#1562) 3 years ago
helix-dap Use which to resolve lsp/dap binaries 3 years ago
helix-loader Avoid using the format ident Rust feature (#1881) 3 years ago
helix-lsp Implement LSP `workspace/configuration` and `workspace/didChangeConfiguration` (#1684) 3 years ago
helix-term fix: copy_selection needs to account for to() being exclusive 3 years ago
helix-tui Highlight matching text in file picker suggestions (#1635) 3 years ago
helix-view fix: Don't rely on FormattingOptions::default() 3 years ago
runtime Indentation rework (#1562) 3 years ago
xtask Add --health command for troubleshooting (#1669) 3 years ago
.envrc Work around a nix-direnv issue 3 years ago
.gitignore Dynamically load grammar libraries at runtime 3 years ago
CHANGELOG.md changelog notes for 22.03 (#1830) 3 years ago
Cargo.lock build(deps): bump log from 0.4.14 to 0.4.16 (#1874) 3 years ago
Cargo.toml migrate grammar fetching/building code into helix-loader crate 3 years ago
LICENSE Add the LICENSE file. 4 years ago
README.md rename '--fetch/build-grammars' flags into '--grammar fetch/build' 3 years ago
VERSION publish a source tarball with version and grammars (#1875) 3 years ago
base16_theme.toml Add markup support (#1525) 3 years ago
flake.lock flake: use builtins.fetchTree to shallow-clone grammar repos 3 years ago
flake.nix flake: use builtins.fetchTree to shallow-clone grammar repos 3 years ago
grammars.nix Use fromTOML on Nix >= 2.6.0 (#1892) 3 years ago
languages.toml add tree-sitter-gleam 3 years ago
rust-toolchain.toml Switch rust-toolchain.toml over to stable 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): use nix-cargo-integration, make shell.nix use flake devshell 4 years ago
theme.toml capture markdown link text as markup.link.text (#1456) 3 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.toml.

Installation

We provide packaging for various distributions, but here's a quick method 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). 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.

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