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 b799b0d50e
capture markdown link text as markup.link.text (#1456)
3 years ago
.cargo docs: Auto generate command list 3 years ago
.github build(deps): bump actions/upload-artifact from 2.3.0 to 2.3.1 (#1316) 3 years ago
book capture markdown link text as markup.link.text (#1456) 3 years ago
contrib Move themes to runtime/themes, add link from contrib/themes 3 years ago
docs Auto generate docs for language support 3 years ago
helix-core feat(commands): shrink_selection (#1340) 3 years ago
helix-lsp Release 0.6 3 years ago
helix-syntax add tree-sitter-regex (#1362) 3 years ago
helix-term feat(commands): shrink_selection (#1340) 3 years ago
helix-tui Release 0.6 3 years ago
helix-view feat(commands): shrink_selection (#1340) 3 years ago
runtime capture markdown link text as markup.link.text (#1456) 3 years ago
xtask Release 0.6 3 years ago
.envrc build(nix): use nix-cargo-integration, make shell.nix use flake devshell 3 years ago
.gitignore Dynamically load grammar libraries at runtime 3 years ago
.gitmodules add tree-sitter-regex (#1362) 3 years ago
CHANGELOG.md minor: Fix previous version's header 3 years ago
Cargo.lock Release 0.6 3 years ago
Cargo.toml docs: Auto generate command list 3 years ago
LICENSE Add the LICENSE file. 4 years ago
README.md In README, add example for windows config directory (#1273) 3 years ago
TODO.md Remove some old TODOs 3 years ago
base16_theme.toml add diff.{plus,minus,delta} to themes 3 years ago
flake.lock nix: Update flake.lock 3 years ago
flake.nix nix: Update to lld 13, drop flake-compat (was unused) 3 years ago
languages.toml Add default language server for JavaScript (#1457) 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 Add screenshot to README. 4 years ago
shell.nix build(nix): use nix-cargo-integration, make shell.nix use flake devshell 3 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 --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix
cd helix
cargo install --path helix-term

This will install the hx binary to $HOME/.cargo/bin.

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