book/src/install.md · helix

helix/book/src/install.md

49 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

26Binary packages are available on AUR:

27- [helix-bin](https://aur.archlinux.org/packages/helix-bin/) contains the pre-built release

28- [helix-git](https://aur.archlinux.org/packages/helix-git/) builds the master branch

30## Build from source

32```

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

34cd helix

35cargo install --path helix-term

36```

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

40Now copy the `runtime/` directory somewhere. Helix will by default look for the

41runtime inside the same folder as the executable, but that can be overriden via

42the `HELIX_RUNTIME` environment variable.

44If you want to embed the `runtime/` directory into the Helix binary you can build

45it with:

47```

48cargo install --path helix-term --features "embed_runtime"

49```