2022-12-02 06:07:08 +03:00
< img src = "./logo.svg" height = "128" alt = "Logo" / >
2020-09-21 12:24:16 +03:00
2022-12-02 06:07:08 +03:00
# Helix
2022-12-02 06:05:42 +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 )
2022-09-17 14:34:48 +03:00
A Kakoune / Neovim inspired editor, written in Rust.
2021-05-11 12:50:09 +03:00
2022-09-17 14:34:48 +03:00
The editing model is very heavily based on Kakoune; during development I found
myself agreeing with most of Kakoune's design decisions.
2021-05-11 12:50:09 +03:00
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
2022-09-17 14:34:48 +03:00
(similar to Emacs) in wgpu or skulpin.
2020-09-21 12:24:16 +03:00
2021-06-07 03:32:48 +03:00
Note: Only certain languages have indentation definitions at the moment. Check
2022-04-29 20:40:59 +03:00
`runtime/queries/<lang>/` for `indents.scm` .
2021-05-12 10:49:01 +03:00
2021-10-29 08:11:42 +03:00
# Installation
2022-04-20 04:44:11 +03:00
Packages are available for various distributions (see [Installation docs ](https://docs.helix-editor.com/install.html )).
2021-05-11 12:50:09 +03:00
2022-04-20 04:44:11 +03:00
If you would like to build from source:
```shell
2022-02-15 02:23:35 +03:00
git clone https://github.com/helix-editor/helix
2020-10-05 10:12:55 +03:00
cd helix
cargo install --path helix-term
```
2022-10-21 03:39:30 +03:00
This will install the `hx` binary to `$HOME/.cargo/bin` and build tree-sitter grammars in `./runtime/grammars` .
2020-10-05 10:12:55 +03:00
2022-10-12 02:54:18 +03:00
Helix needs its runtime files so make sure to copy/symlink the `runtime/` directory into the
2021-12-16 04:48:49 +03:00
config directory (for example `~/.config/helix/runtime` on Linux/macOS, or `%AppData%/helix/runtime` on Windows).
2022-04-20 04:44:11 +03:00
2022-10-10 20:23:36 +03:00
| OS | Command |
| -------------------- | ------------------------------------------------ |
2022-10-20 01:19:03 +03:00
| Windows (Cmd) | `xcopy /e /i runtime %AppData%\helix\runtime` |
2022-10-10 20:23:36 +03:00
| Windows (PowerShell) | `xcopy /e /i runtime $Env:AppData\helix\runtime` |
2022-11-08 20:02:49 +03:00
| Linux / macOS | `ln -s $PWD/runtime ~/.config/helix/runtime` |
2022-10-20 01:19:03 +03:00
Starting with Windows Vista you can also create symbolic links on Windows. Note that this requires
2022-11-08 17:29:48 +03:00
elevated privileges - i.e. PowerShell or Cmd must be run as administrator.
2022-10-20 01:19:03 +03:00
**PowerShell:**
```powershell
New-Item -ItemType SymbolicLink -Target "runtime" -Path "$Env:AppData\helix\runtime"
```
**Cmd:**
```cmd
cd %appdata%\helix
mklink /D runtime "< helix-repo > \runtime"
```
2022-04-20 04:44:11 +03:00
2022-10-21 03:39:30 +03:00
The runtime location can be overridden via the `HELIX_RUNTIME` environment variable.
> NOTE: if `HELIX_RUNTIME` is set prior to calling `cargo install --path helix-term`,
> tree-sitter grammars will be built in `$HELIX_RUNTIME/grammars`.
If you plan on keeping the repo locally, an alternative to copying/symlinking
runtime files is to set `HELIX_RUNTIME=/path/to/helix/runtime`
(`HELIX_RUNTIME=$PWD/runtime` if you're in the helix repo directory).
2021-06-12 11:20:15 +03:00
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
2022-10-12 02:54:18 +03:00
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` .
2022-04-09 09:47:32 +03:00
In order to use LSP features like auto-complete, you will need to
[install the appropriate Language Server ](https://github.com/helix-editor/helix/wiki/How-to-install-the-default-language-servers )
for a language.
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
2022-10-10 20:23:36 +03:00
## Adding Helix to your desktop environment
If installing from source, to use Helix in desktop environments that supports [XDG desktop menu ](https://specifications.freedesktop.org/menu-spec/menu-spec-latest.html ), including Gnome and KDE, copy the provided `.desktop` file to the correct folder:
```bash
cp contrib/Helix.desktop ~/.local/share/applications
```
To use another terminal than the default, you will need to modify the `.desktop` file. For example, to use `kitty` :
```bash
sed -i "s|Exec=hx %F|Exec=kitty hx %F|g" ~/.local/share/applications/Helix.desktop
sed -i "s|Terminal=true|Terminal=false|g" ~/.local/share/applications/Helix.desktop
```
Please note: there is no icon for Helix yet, so the system default will be used.
2022-11-08 20:02:49 +03:00
## macOS
2022-02-15 02:23:35 +03:00
2022-11-08 20:02:49 +03:00
Helix can be installed on macOS through homebrew:
2021-06-07 03:14:06 +03:00
```
brew install helix
```
2022-07-28 13:37:10 +03:00
2021-05-11 12:50:09 +03:00
# Contributing
2021-11-17 16:30:11 +03:00
Contributing guidelines can be found [here ](./docs/CONTRIBUTING.md ).
2021-05-11 12:50:09 +03:00
# 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).
2022-12-02 06:05:42 +03:00
# Credits
Thanks to [@JakeHL ](https://github.com/JakeHL ) for designing the logo!