Helix Mirror

kakoune rust text-editor vim

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

Gokul Soumya 6e2aaed5c2 Reuse menu::Item trait in picker (#2814 ) * Refactor menu::Item to accomodate external state Will be useful for storing editor state when reused by pickers. * Add some type aliases for readability * Reuse menu::Item trait in picker This opens the way for merging the menu and picker code in the future, since a picker is essentially a menu + prompt. More excitingly, this change will also allow aligning items in the picker, which would be useful (for example) in the command palette for aligning the descriptions to the left and the keybinds to the right in two separate columns. The item formatting of each picker has been kept as is, even though there is room for improvement now that we can format the data into columns, since that is better tackled in a separate PR. * Rename menu::Item::EditorData to Data * Call and inline filter_text() in sort_text() completion * Rename diagnostic picker's Item::Data		2 years ago
.cargo	add integration-test cargo alias	2 years ago
.github	add integration-test cargo alias	2 years ago
book	fix CI	2 years ago
contrib	adds --vsplit and --hsplit arguments (#2773 )	2 years ago
docs	update docs for integration tests	2 years ago
helix-core	Add workspace and document diagnostics picker (#2013 )	2 years ago
helix-dap	Reuse menu::Item trait in picker (#2814 )	2 years ago
helix-loader	Fix initial selection of Document in new view	2 years ago
helix-lsp	feat: highlight / select symbol under cursor using LSP textDocument/documentHighlight (#2738 )	2 years ago
helix-term	Reuse menu::Item trait in picker (#2814 )	2 years ago
helix-tui	Reuse menu::Item trait in picker (#2814 )	2 years ago
helix-view	Add mode specific styles (#2676 )	2 years ago
runtime	Update night_owl for cursorline (#2938 )	2 years ago
xtask	Add workspace and document diagnostics picker (#2013 )	2 years ago
.envrc	Work around a nix-direnv issue	3 years ago
.gitignore	Fix initial selection of Document in new view	2 years ago
CHANGELOG.md	Fix link to `pop-dark` in `CHANGELOG.md` (#2594 )	3 years ago
Cargo.lock	build(deps): bump smallvec from 1.8.0 to 1.8.1 (#2901 )	2 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	Update from-source install instruction in README (#2603 )	3 years ago
VERSION	Fix the VERSION file	3 years ago
base16_theme.toml	Update theme base16_default (`ui.menu`) (#2794 )	2 years ago
default.nix	build(nix): update flake deps, add default.nix file	2 years ago
flake.lock	nix: update nixCargoIntegration (#2907 )	2 years ago
flake.nix	build(nix): update flake deps, add default.nix file	2 years ago
grammars.nix	chore(nix): format nix files with alejandra, update deps, minor code refactors (#2683 )	2 years ago
languages.toml	markdown: limit raw block highlight to code fence content	2 years ago
rust-toolchain.toml	pin the rust toolchain to 1.61.0	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): update flake deps, add default.nix file	2 years ago
theme.toml	Add a default cursorline style for the primary selection	2 years ago

README.md

Helix

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

This will install the hx binary to $HOME/.cargo/bin and build tree-sitter grammars. If you want to customize your languages.toml config, tree-sitter grammars may be manually fetched and built with hx --grammar fetch and hx --grammar build.

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.

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