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
Omnikar ebc14d9d20
Add `m` textobject for pair under cursor (#961)
3 years ago
.github Break CI cache 3 years ago
book add wonly -- window only (#1057) 3 years ago
contrib Move themes to runtime/themes, add link from contrib/themes 4 years ago
docs Add a "vision" document, to help give people a sense of Helix's direction. (#657) 3 years ago
helix-core Use default `languages.toml` if user's is invalid (#994) 3 years ago
helix-lsp Add LSP rename_symbol (space-r) (#1011) 3 years ago
helix-syntax glsl support (#993) 3 years ago
helix-term Add `m` textobject for pair under cursor (#961) 3 years ago
helix-tui Truncate the starts of file paths instead of the ends in picker (#951) 3 years ago
helix-view Allow piping from stdin into a buffer on startup (#996) 3 years ago
runtime Add json indents.toml file (#1055) 3 years ago
.envrc build(nix): use nix-cargo-integration, make shell.nix use flake devshell 4 years ago
.gitignore Dynamically load grammar libraries at runtime 3 years ago
.gitmodules glsl support (#993) 3 years ago
CHANGELOG.md Mention CMake support in changelog (#926) 3 years ago
Cargo.lock build(deps): bump serde_json from 1.0.68 to 1.0.69 (#1030) 3 years ago
Cargo.toml Inline tui as helix-tui fork. 4 years ago
LICENSE Add the LICENSE file. 4 years ago
README.md chore(doc): use faq for finding helix log file (#963) 3 years ago
TODO.md Remove some old TODOs 3 years ago
flake.lock Update to rust 1.56 + 2021 edition 3 years ago
flake.nix nix: Update lld to 12 3 years ago
languages.toml Make shebangs optional, they don't make sense outside of scripts 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 4 years ago
theme.toml fix: #896 broke some of the default highlights 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). 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

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!
  • To use print debugging to the Helix log file, you must:
    • Print using log::info!, warn!, or error!. (log::info!("helix!"))
    • Pass the appropriate verbosity level option for the desired log level. (hx -v <file> for info, more vs for higher severity inclusive)
  • 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.

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