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

Daniel Poulin 8afdb30de3 Move default comment toggle binding to pound This is a common rebind in both the helix and kakoune community. Some reasons this is desirable: * Pound is a common symbol for commenting in many languages * Pound is not bound to anything else, and it is not obvious what else it would be bound to * `C-c` should really be reserved for cancelling subshells from `:sh`, `\|` and friends Most sensible alternatives are taken: * `/` is search * `` adds selection to search register `-` is not common, and though not currently taken, may make sense as the opposite of `_`, for another PR to implement. * `c` change selection * `A-c` change selection w/o yank * `C` copy selection down * `A-C` copy selection up		2 years ago
.cargo	chore: rename `.cargo/{config -> config.toml}`	2 years ago
.github	Strip release binary by setting `profile.release.strip` in a pre-build step (#3780 )	2 years ago
book	Update usage.md with paragraph textobject(#3797 )	2 years ago
contrib	fix: add elvish completions (#3331 )	2 years ago
docs	packaging: Point to homebrew-core instead of tap (#3513 )	2 years ago
helix-core	build(deps): bump once_cell from 1.13.1 to 1.14.0 (#3715 )	2 years ago
helix-dap	DAP: Make `cwd` required in RunTerminalArguments	2 years ago
helix-loader	ordinals instead of indexes when listing grammar fetch errors (#3773 )	2 years ago
helix-lsp	Remove LspNotDefined, instead return an Option<>	2 years ago
helix-term	Move default comment toggle binding to pound	2 years ago
helix-tui	Update to crossterm-0.25 (#3390 )	2 years ago
helix-view	Switch to Result for invalid language	2 years ago
runtime	Remove the .txt suffix from tutor	2 years ago
xtask	Add query-check xtask	2 years ago
.envrc	Work around a nix-direnv issue	3 years ago
.gitattributes	Add .gitattributes (#3318 )	2 years ago
.gitignore	Remove vale from .gitignore	2 years ago
.ignore	Add a .ignore file to make ripgrep more useful (#3315 )	2 years ago
CHANGELOG.md	Changelog notes for 22.08.1 (#3639 )	2 years ago
Cargo.lock	build(deps): bump tokio from 1.20.1 to 1.21.0 (#3716 )	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	xcopy - assume destination is a directory (#3686 )	2 years ago
VERSION	Changelog notes for 22.08.1 (#3639 )	2 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	build(nix): update flake deps (#3663 )	2 years ago
flake.nix	build(nix): update nci, refactor flake, seperate wrapping, add source filtering (#3657 )	2 years ago
grammars.nix	build(nix): add a way to override what grammars get built (#3141 )	2 years ago
languages.toml	Add textobject for gdscript (#3760 )	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 (cmd.exe)	`xcopy /e /i runtime %AppData%\helix\runtime`
Windows (PowerShell)	`xcopy /e /i runtime $Env: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:

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