book/src/install.md · helix

git.iko.soy/helix

helix/book/src/install.md

91 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

9Helix is available in homebrew-core:

11```

12brew install helix

13```

15## Linux

17### NixOS

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

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

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

23Flake outputs are cached for each push to master using

24[Cachix](https://www.cachix.org/). The flake is configured to

25automatically make use of this cache assuming the user accepts

26the new settings on first use.

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

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

30configure Nix to use cached outputs when possible.

32### Arch Linux

34Releases are available in the `community` repository.

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

38### Fedora Linux

40You can install the COPR package for Helix via

42```

43sudo dnf copr enable varlad/helix

44sudo dnf install helix

45```

47### Void Linux

49```

50sudo xbps-install helix

51```

53## Build from source

55```

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

57cd helix

58cargo install --path helix-term

59```

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

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

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

65via the `HELIX_RUNTIME` environment variable.

67| OS | command |

68|-------------------|-----------|

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

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

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

73## Finishing up the installation

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

76```

77hx --health

78```

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

82### Building tree-sitter grammars

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

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

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

88### Installing language servers

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

91Follow 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.