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

Gokul Soumya 8b67acf130 Format keys identically in statusline and command palette (#2790 ) The command palette previously used + as a delimiter for denoting a single key in a key sequence, (like C+w). This was at odds with how the statusline displayed them with pending keys (like <C-w>). This patch changes the palette formatting to the statusline formatting		2 years ago
.cargo	docs: Auto generate command list	3 years ago
.github	Use a minimal binary to fetch grammar sources in release CI (#2557 )	2 years ago
book	Make indent guides configurable	2 years ago
contrib	AppImage (#2089 )	3 years ago
docs	Fix typo (#2264 )	3 years ago
helix-core	feat: make `move_vertically` aware of tabs and wide characters (#2620 )	2 years ago
helix-dap	Use which to resolve lsp/dap binaries	3 years ago
helix-loader	Use a minimal binary to fetch grammar sources in release CI (#2557 )	2 years ago
helix-lsp	embed jsonrpc types from jsonrpc-core crate (#2801 )	2 years ago
helix-term	Format keys identically in statusline and command palette (#2790 )	2 years ago
helix-tui	Make Borders u8	3 years ago
helix-view	Format keys identically in statusline and command palette (#2790 )	2 years ago
runtime	Add theme scopes for indent guides	2 years ago
xtask	Making the 'set-option' command help more descriptive. (#2365 )	3 years ago
.envrc	Work around a nix-direnv issue	3 years ago
.gitignore	Dynamically load grammar libraries at runtime	3 years ago
CHANGELOG.md	Fix link to `pop-dark` in `CHANGELOG.md` (#2594 )	3 years ago
Cargo.lock	build(deps): bump anyhow from 1.0.57 to 1.0.58 (#2843 )	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
flake.lock	chore(nix): format nix files with alejandra, update deps, minor code refactors (#2683 )	2 years ago
flake.nix	add rust-analyzer to shell environment (#2739 )	2 years ago
grammars.nix	chore(nix): format nix files with alejandra, update deps, minor code refactors (#2683 )	2 years ago
languages.toml	HEEx: upgrade version and support new special_attribute node (#2800 )	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	chore(nix): format nix files with alejandra, update deps, minor code refactors (#2683 )	2 years ago
theme.toml	Add theme scopes for indent guides	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).