2021-04-05 10:18:43 +04:00
|
|
|
# Installation
|
|
|
|
|
|
2021-05-12 15:32:44 +04:00
|
|
|
We provide pre-built binaries on the [GitHub Releases page](https://github.com/helix-editor/helix/releases).
|
2021-04-05 10:18:43 +04:00
|
|
|
|
|
|
|
|
## OSX
|
|
|
|
|
|
|
|
|
|
TODO: brew tap
|
|
|
|
|
|
2021-06-02 06:14:46 +04:00
|
|
|
Please use a pre-built binary release for the time being.
|
2021-04-05 10:18:43 +04:00
|
|
|
|
|
|
|
|
## Linux
|
|
|
|
|
|
|
|
|
|
### NixOS
|
|
|
|
|
|
|
|
|
|
A [flake](https://nixos.wiki/wiki/Flakes) containing the package is available in
|
|
|
|
|
the project root. The flake can also be used to spin up a reproducible development
|
|
|
|
|
shell for working on Helix.
|
|
|
|
|
|
|
|
|
|
### Arch Linux
|
|
|
|
|
|
2021-06-02 06:14:46 +04:00
|
|
|
Binary packages are available on AUR:
|
|
|
|
|
- [helix-bin](https://aur.archlinux.org/packages/helix-bin/) contains the pre-built release
|
|
|
|
|
- [helix-git](https://aur.archlinux.org/packages/helix-git/) builds the master branch
|
2021-04-05 10:18:43 +04:00
|
|
|
|
|
|
|
|
## Build from source
|
|
|
|
|
|
|
|
|
|
```
|
2021-05-12 15:32:44 +04:00
|
|
|
git clone --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix
|
|
|
|
|
cd helix
|
|
|
|
|
cargo install --path helix-term
|
2021-04-05 10:18:43 +04:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This will install the `hx` binary to `$HOME/.cargo/bin`.
|
2021-05-12 15:32:44 +04:00
|
|
|
|
|
|
|
|
Now copy the `runtime/` directory somewhere. Helix will by default look for the
|
|
|
|
|
runtime inside the same folder as the executable, but that can be overriden via
|
|
|
|
|
the `HELIX_RUNTIME` environment variable.
|
