git.iko.soy/helix
on aa00a47 help sign in
helix/README.md
87 lines 3.4 kB history raw
1# Helix
3[![Build status](https://github.com/helix-editor/helix/actions/workflows/build.yml/badge.svg)](https://github.com/helix-editor/helix/actions)
5![Screenshot](./screenshot.png)
7A Kakoune / Neovim inspired editor, written in Rust.
9The editing model is very heavily based on Kakoune; during development I found
10myself agreeing with most of Kakoune's design decisions.
12For more information, see the [website](https://helix-editor.com) or
13[documentation](https://docs.helix-editor.com/).
15All shortcuts/keymaps can be found [in the documentation on the website](https://docs.helix-editor.com/keymap.html).
17[Troubleshooting](https://github.com/helix-editor/helix/wiki/Troubleshooting)
19# Features
21- Vim-like modal editing
22- Multiple selections
23- Built-in language server support
24- Smart, incremental syntax highlighting and code editing via tree-sitter
26It's a terminal-based editor first, but I'd like to explore a custom renderer
27(similar to Emacs) in wgpu or skulpin.
29Note: Only certain languages have indentation definitions at the moment. Check
30`runtime/queries/<lang>/` for `indents.scm`.
32# Installation
34Packages are available for various distributions (see [Installation docs](https://docs.helix-editor.com/install.html)).
36If you would like to build from source:
38```shell
39git clone https://github.com/helix-editor/helix
40cd helix
41cargo install --path helix-term
42```
44This will install the `hx` binary to `$HOME/.cargo/bin` and build tree-sitter grammars.
45If you want to customize your `languages.toml` config,
46tree-sitter grammars may be manually fetched and built with `hx --grammar fetch` and `hx --grammar build`.
48Helix also needs its runtime files so make sure to copy/symlink the `runtime/` directory into the
49config directory (for example `~/.config/helix/runtime` on Linux/macOS, or `%AppData%/helix/runtime` on Windows).
51| OS | Command |
52| -------------------- | -------------------------------------------- |
53| Windows (cmd.exe) | `xcopy /e /i runtime %AppData%\helix\runtime` |
54| Windows (PowerShell) | `xcopy /e /i runtime $Env:AppData\helix\runtime` |
55| Linux/macOS | `ln -s $PWD/runtime ~/.config/helix/runtime` |
57This location can be overridden via the `HELIX_RUNTIME` environment variable.
59Packages already solve this for you by wrapping the `hx` binary with a wrapper
60that sets the variable to the install dir.
62> NOTE: running via cargo also doesn't require setting explicit `HELIX_RUNTIME` path, it will automatically
63> detect the `runtime` directory in the project root.
65In order to use LSP features like auto-complete, you will need to
66[install the appropriate Language Server](https://github.com/helix-editor/helix/wiki/How-to-install-the-default-language-servers)
67for a language.
69[![Packaging status](https://repology.org/badge/vertical-allrepos/helix.svg)](https://repology.org/project/helix/versions)
71## MacOS
73Helix can be installed on MacOS through homebrew:
75```
76brew install helix
77```
79# Contributing
81Contributing guidelines can be found [here](./docs/CONTRIBUTING.md).
83# Getting help
85Your question might already be answered on the [FAQ](https://github.com/helix-editor/helix/wiki/FAQ).
87Discuss the project on the community [Matrix Space](https://matrix.to/#/#helix-community:matrix.org) (make sure to join `#helix-editor:matrix.org` if you're on a client that doesn't support Matrix Spaces yet).