book/src/install.md · helix

helix/book/src/install.md

51 lines 1.4 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.

24### Arch Linux

26Releases are available in the `community` repository.

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

30### Fedora Linux

32You can install the COPR package for Helix via

34```

35sudo dnf copr enable varlad/helix

36sudo dnf install helix

37```

39## Build from source

41```

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

43cd helix

44cargo install --path helix-term

45```

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

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

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

51via the `HELIX_RUNTIME` environment variable.