README.md · helix · git.iko.soy

git.iko.soy/helix

helix/README.md

88 lines 3.3 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.scm`.

33# Installation

35Packages are available for various distributions (see [Installation docs](https://docs.helix-editor.com/install.html)).

37If you would like to build from source:

39```shell

40git clone https://github.com/helix-editor/helix

41cd helix

42cargo install --path helix-term

43```

45This will install the `hx` binary to `$HOME/.cargo/bin` and build tree-sitter grammars.

46If you want to customize your `languages.toml` config,

47tree-sitter grammars may be manually fetched and built with `hx --grammar fetch` and `hx --grammar build`.

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

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

52| OS | command |

53|-----------|-----------|

54|windows |`xcopy runtime %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 via:

75```

76brew tap helix-editor/helix

77brew install helix

78```

80# Contributing

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

84# Getting help

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

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