book/src/install.md · helix

git.iko.soy/helix

helix/book/src/install.md

92 lines 2.9 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/). The flake is configured to

26automatically make use of this cache assuming the user accepts

27the new settings on first use.

29If you are using a version of Nix without flakes enabled you can

30[install Cachix cli](https://docs.cachix.org/installation); `cachix use helix` will

31configure Nix to use cached outputs when possible.

33### Arch Linux

35Releases are available in the `community` repository.

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

39### Fedora Linux

41You can install the COPR package for Helix via

43```

44sudo dnf copr enable varlad/helix

45sudo dnf install helix

46```

48### Void Linux

50```

51sudo xbps-install helix

52```

54## Build from source

56```

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

58cd helix

59cargo install --path helix-term

60```

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

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

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

66via the `HELIX_RUNTIME` environment variable.

68| OS | command |

69|-------------------|-----------|

70|windows(cmd.exe) |`xcopy /e runtime %AppData%/helix/runtime` |

71|windows(powershell)|`xcopy /e runtime $Env:AppData\helix\runtime` |

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

74## Finishing up the installation

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

77```

78hx --health

79```

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

83### Building tree-sitter grammars

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

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

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

89### Installing language servers

91Language servers can optionally be installed if you want their features (auto-complete, diagnostics etc.).

92Follow the [instructions on the wiki page](https://github.com/helix-editor/helix/wiki/How-to-install-the-default-language-servers) to add your language servers of choice.