book/src/install.md · helix

git.iko.soy/helix

helix/book/src/install.md

82 lines 2.3 kB history raw

1# Installation

3We provide pre-built binaries on the [GitHub Releases page](https://github.com/helix-editor/helix/releases).

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

7## OSX

9A Homebrew tap is available:

11```

12brew tap helix-editor/helix

13brew install helix

14```

16## Linux

18### NixOS

20A [flake](https://nixos.wiki/wiki/Flakes) containing the package is available in

21the project root. The flake can also be used to spin up a reproducible development

22shell for working on Helix with `nix develop`.

24Flake outputs are cached for each push to master using

25[Cachix](https://www.cachix.org/). With Cachix

26[installed](https://docs.cachix.org/installation), `cachix use helix` will

27configure Nix to use cached outputs when possible.

29### Arch Linux

31Releases are available in the `community` repository.

33A [helix-git](https://aur.archlinux.org/packages/helix-git/) package is also available on the AUR, which builds the master branch.

35### Fedora Linux

37You can install the COPR package for Helix via

39```

40sudo dnf copr enable varlad/helix

41sudo dnf install helix

42```

44### Void Linux

46```

47sudo xbps-install helix

48```

50## Build from source

52```

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

54cd helix

55cargo install --path helix-term

56```

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

60Helix also needs it's runtime files so make sure to copy/symlink the `runtime/` directory into the

61config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overridden

62via the `HELIX_RUNTIME` environment variable.

64| OS | command |

65|-----------|-----------|

66|windows |`xcopy runtime %AppData%/helix/runtime`|

67|linux/macos|`ln -s $PWD/runtime ~/.config/helix/runtime`

69## Finishing up the installation

71To make sure everything is set up as expected you should finally run the helix healthcheck via

72```

73hx --health

74```

75For more information on the information displayed in the healthcheck results refer to [Healthcheck](https://github.com/helix-editor/helix/wiki/Healthcheck).

78## Building tree-sitter grammars

80Tree-sitter grammars must be fetched and compiled if not pre-packaged.

81Fetch grammars with `hx --grammar fetch` (requires `git`) and compile them

82with `hx --grammar build` (requires a C++ compiler).