README.md · helix · git.iko.soy

git.iko.soy/helix

helix/README.md

74 lines 2.7 kB history raw

1# Helix

4[![Build status](https://github.com/helix-editor/helix/actions/workflows/build.yml/badge.svg)](https://github.com/helix-editor/helix/actions)

6![Screenshot](./screenshot.png)

8A kakoune / neovim inspired editor, written in Rust.

10The editing model is very heavily based on kakoune; during development I found

11myself agreeing with most of kakoune's design decisions.

13For more information, see the [website](https://helix-editor.com) or

14[documentation](https://docs.helix-editor.com/).

16All shortcuts/keymaps can be found [in the documentation on the website](https://docs.helix-editor.com/keymap.html).

18[Troubleshooting](https://github.com/helix-editor/helix/wiki/Troubleshooting)

20# Features

22- Vim-like modal editing

23- Multiple selections

24- Built-in language server support

25- Smart, incremental syntax highlighting and code editing via tree-sitter

27It's a terminal-based editor first, but I'd like to explore a custom renderer

28(similar to emacs) in wgpu or skulpin.

30Note: Only certain languages have indentation definitions at the moment. Check

31`runtime/queries/<lang>/` for `indents.toml`.

33# Installation

35We provide packaging for various distributions, but here's a quick method to

36build from source.

38```

39git clone --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix

40cd helix

41cargo install --path helix-term

42```

44This will install the `hx` binary to `$HOME/.cargo/bin`.

46Helix also needs its runtime files so make sure to copy/symlink the `runtime/` directory into the

47config directory (for example `~/.config/helix/runtime` on Linux/macOS, or `%AppData%/helix/runtime` on Windows).

48This location can be overriden via the `HELIX_RUNTIME` environment variable.

50Packages already solve this for you by wrapping the `hx` binary with a wrapper

51that sets the variable to the install dir.

53> NOTE: running via cargo also doesn't require setting explicit `HELIX_RUNTIME` path, it will automatically

54> detect the `runtime` directory in the project root.

56[![Packaging status](https://repology.org/badge/vertical-allrepos/helix.svg)](https://repology.org/project/helix/versions)

58## MacOS

59Helix can be installed on MacOS through homebrew via:

61```

62brew tap helix-editor/helix

63brew install helix

64```

66# Contributing

68Contributing guidelines can be found [here](./docs/CONTRIBUTING.md).

70# Getting help

72Your question might already be answered on the [FAQ](https://github.com/helix-editor/helix/wiki/FAQ).

74Discuss 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).