2020-09-21 17:24:16 +08:00
# Helix
2021-05-11 18:46:58 +08:00
2021-05-31 20:09:07 +08:00
[](https://github.com/helix-editor/helix/actions)
2021-05-11 18:46:58 +08:00
2021-05-12 15:49:01 +08:00
2021-05-11 17:50:09 +08:00
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.
2021-05-31 16:12:09 +08:00
For more information, see the [website ](https://helix-editor.com ) or
[documentation ](https://docs.helix-editor.com/ ).
2021-05-11 18:46:58 +08:00
2021-05-11 17:50:09 +08:00
# 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.
2020-09-21 17:24:16 +08:00
2020-10-05 15:12:55 +08:00
# Installation
2021-05-15 00:34:34 +08:00
Note: Only Rust and Golang have indentation definitions at the moment.
2021-05-12 15:49:01 +08:00
2021-05-11 17:50:09 +08:00
We provide packaging for various distributions, but here's a quick method to
build from source.
2020-10-05 15:12:55 +08:00
```
2021-05-11 17:50:09 +08:00
git clone --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix
2020-10-05 15:12:55 +08:00
cd helix
cargo install --path helix-term
```
This will install the `hx` binary to `$HOME/.cargo/bin` .
2021-05-11 17:50:09 +08:00
Now copy the `runtime/` directory somewhere. Helix will by default look for the
runtime inside the same folder as the executable, but that can be overriden via
the `HELIX_RUNTIME` environment variable.
2021-06-02 10:14:46 +08:00
> NOTE: You should set this to <path to repository>/runtime in development (if
> running via cargo).
2021-06-06 00:50:34 +08:00
If you want to embed the `runtime/` directory into the Helix binary you can build
2021-06-04 04:46:56 +08:00
it with:
```
cargo install --path helix-term --features "embed_runtime"
```
2021-06-02 02:45:07 +08:00
## Arch Linux
There are two packages available from AUR:
- `helix-bin` : contains prebuilt binary from GitHub releases
- `helix-git` : builds the master branch of this repository
2021-06-07 08:14:06 +08:00
## MacOS
Helix can be installed on MacOS through homebrew via:
```
brew tap helix-editor/helix
brew install helix
```
2021-05-11 17:50:09 +08:00
# 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 ](https://github.com/helix-editor/helix/labels/good%20first%20issue ) label on the issue tracker.
- Help with packaging on various distributions needed!
2021-05-11 18:46:58 +08:00
- If your preferred language is missing, integrating a tree-sitter grammar for
2021-05-11 17:50:09 +08:00
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 ](./docs/architecture.md ) that should give you
a good overview of the internals.
2021-06-02 18:05:39 +08:00
## Usage
2021-06-02 23:05:15 +08:00
### Keyboard shortcuts / Keymap
2021-06-02 18:05:39 +08:00
2021-06-02 19:15:31 +08:00
All shortcuts/keymaps can be found in the documentation on the website:
- https://docs.helix-editor.com/keymap.html
2021-05-11 17:50:09 +08:00
# Getting help
2021-06-05 11:01:48 +08:00
Discuss 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).
