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 5a344a3ae5 Address clippy lint 4 years ago
.github Merge pull request #11 from helix-editor/dependabot/github_actions/actions/upload-artifact-2.2.3 4 years ago
book Add home-end keymaps, (as kakoune/vim do) (#83) 4 years ago
docs Update architecture.md 4 years ago
helix-core Try to detect language when document file path is set 4 years ago
helix-lsp Remove select_all implementation 4 years ago
helix-syntax Address clippy lint 4 years ago
helix-term Add home-end keymaps, (as kakoune/vim do) (#83) 4 years ago
helix-tui Fix split sizes getting out of sync with the terminal size, refs #69 4 years ago
helix-view Try to detect language when document file path is set 4 years ago
runtime/queries Restored haskell syntax 4 years ago
.envrc Add a nix flake with the development environment. 4 years ago
.gitignore Add a nix flake with the development environment. 4 years ago
.gitmodules Added elixir syntax 4 years ago
Cargo.lock Dropped pico-args in favour of a simpler hand roller parser 4 years ago
Cargo.toml Inline tui as helix-tui fork. 4 years ago
LICENSE Add the LICENSE file. 4 years ago
README.md Update README.md 4 years ago
TODO.md Update deps, introduce the new tree-sitter lifetimes 4 years ago
flake.lock Update flake deps 4 years ago
flake.nix Closer to a full flake build via naersk. 4 years ago
languages.toml Restored haskell syntax 4 years ago
screenshot.png Add screenshot to README. 4 years ago
shell.nix Nix: add lldb to shell 4 years ago
theme.toml Change help prompt styling 4 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.

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.

Installation

Note: Only Rust and Golang have indentation definitions at the moment.

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.

Now copy the runtime/ directory somewhere. Helix will by default look for the runtime inside the same folder as the executable, but that can be overriden via the HELIX_RUNTIME environment variable.

NOTE: You should set this to /runtime in development (if running via cargo).

Arch Linux

There are two packages available from AUR:

  • helix-bin: contains prebuilt binary from GitHub releases
  • helix-git: builds the master branch of this repository

Contributing

Contributors are very welcome! No contribution is too small and all contributions are valued.

Some suggestions to get started:

  • You can look at the good first issue label on the issue tracker.
  • Help with packaging on various distributions needed!
  • If your preferred language is missing, integrating a tree-sitter grammar for it and defining syntax highlight queries for it is straight forward and doesn't require much knowledge of the internals.

We provide an architecture.md that should give you a good overview of the internals.

Usage

Keyboard shortcuts / Keymap

All shortcuts/keymaps can be found in the documentation on the website:

Getting help

Discuss the project on the community Matrix channel.