2020-09-21 12:24:16 +03:00
# Helix
2021-05-11 13:46:58 +03:00
2021-05-31 15:09:07 +03:00
[![Build status ](https://github.com/helix-editor/helix/actions/workflows/build.yml/badge.svg )](https://github.com/helix-editor/helix/actions)
2021-05-11 13:46:58 +03:00
2021-05-12 10:49:01 +03:00
![Screenshot ](./screenshot.png )
2021-05-11 12:50:09 +03: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 11:12:09 +03:00
For more information, see the [website ](https://helix-editor.com ) or
[documentation ](https://docs.helix-editor.com/ ).
2021-05-11 13:46:58 +03:00
2021-08-14 07:28:27 +03:00
All shortcuts/keymaps can be found [in the documentation on the website ](https://docs.helix-editor.com/keymap.html ).
[Troubleshooting ](https://github.com/helix-editor/helix/wiki/Troubleshooting )
2021-06-07 03:32:48 +03:00
2021-05-11 12:50:09 +03: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 12:24:16 +03:00
2020-10-05 10:12:55 +03:00
# Installation
2021-06-07 03:32:48 +03:00
Note: Only certain languages have indentation definitions at the moment. Check
2021-08-02 09:22:50 +03:00
`runtime/queries/<lang>/` for `indents.toml` .
2021-05-12 10:49:01 +03:00
2021-05-11 12:50:09 +03:00
We provide packaging for various distributions, but here's a quick method to
build from source.
2020-10-05 10:12:55 +03:00
```
2021-05-11 12:50:09 +03:00
git clone --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix
2020-10-05 10:12:55 +03:00
cd helix
cargo install --path helix-term
```
This will install the `hx` binary to `$HOME/.cargo/bin` .
2021-08-30 11:58:22 +03:00
Helix also needs its runtime files so make sure to copy/symlink the `runtime/` directory into the
2021-07-17 18:22:58 +03:00
config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overriden
2021-06-12 11:20:15 +03:00
via the `HELIX_RUNTIME` environment variable.
2021-07-17 18:22:58 +03:00
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
2021-06-12 11:20:15 +03:00
> detect the `runtime` directory in the project root.
2021-06-02 05:14:46 +03:00
2021-06-22 19:05:08 +03:00
[![Packaging status ](https://repology.org/badge/vertical-allrepos/helix.svg )](https://repology.org/project/helix/versions)
2021-06-01 21:45:07 +03:00
2021-06-07 03:14:06 +03:00
## MacOS
Helix can be installed on MacOS through homebrew via:
```
brew tap helix-editor/helix
brew install helix
```
2021-05-11 12:50:09 +03:00
# Contributing
Contributors are very welcome! **No contribution is too small and all contributions are valued.**
Some suggestions to get started:
2021-06-22 18:51:30 +03:00
- You can look at the [good first issue ](https://github.com/helix-editor/helix/labels/E-easy ) label on the issue tracker.
2021-05-11 12:50:09 +03:00
- Help with packaging on various distributions needed!
2021-06-08 05:44:31 +03:00
- To use print debugging to the `~/.cache/helix/helix.log` file, you must:
* Print using `log::info!` , `warn!` , or `error!` . (`log::info!("helix!")`)
* Pass the appropriate verbosity level option for the desired log level. (`hx -v < file > ` for info, more `v` s for higher severity inclusive)
2021-05-11 13:46:58 +03:00
- If your preferred language is missing, integrating a tree-sitter grammar for
2021-05-11 12:50:09 +03: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.
# Getting help
2021-10-16 04:05:29 +03:00
Your question might already be answered on the [FAQ ](https://github.com/helix-editor/helix/wiki/FAQ ).
2021-06-05 06:01:48 +03: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).