Unnamed repository; edit this file 'description' to name the repository.
Diffstat (limited to 'book/src/install.md')
| -rw-r--r-- | book/src/install.md | 81 |
1 files changed, 65 insertions, 16 deletions
diff --git a/book/src/install.md b/book/src/install.md index 021feceb..34d8b651 100644 --- a/book/src/install.md +++ b/book/src/install.md @@ -1,24 +1,73 @@ -# Installing Helix +# Installation -The typical way to install Helix is via [your operating system's package manager](./package-managers.md). +We provide pre-built binaries on the [GitHub Releases page](https://github.com/helix-editor/helix/releases). -Note that: +[](https://repology.org/project/helix/versions) -- To get the latest nightly version of Helix, you need to - [build from source](./building-from-source.md). +## OSX -- To take full advantage of Helix, install the language servers for your - preferred programming languages. See the - [wiki](https://github.com/helix-editor/helix/wiki/Language-Server-Configurations) - for instructions. +A Homebrew tap is available: -## Pre-built binaries +``` +brew tap helix-editor/helix +brew install helix +``` -Download pre-built binaries from the [GitHub Releases page](https://github.com/helix-editor/helix/releases). -The tarball contents include an `hx` binary and a `runtime` directory. -To set up Helix: +## Linux -1. Add the `hx` binary to your system's `$PATH` to allow it to be used from the command line. -2. Copy the `runtime` directory to a location that `hx` searches for runtime files. A typical location on Linux/macOS is `~/.config/helix/runtime`. +### NixOS -To see the runtime directories that `hx` searches, run `hx --health`. If necessary, you can override the default runtime location by setting the `HELIX_RUNTIME` environment variable. +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 with `nix develop`. + +Flake outputs are cached for each push to master using +[Cachix](https://www.cachix.org/). With Cachix +[installed](https://docs.cachix.org/installation), `cachix use helix` will +configure Nix to use cached outputs when possible. + +### Arch Linux + +Releases are available in the `community` repository. + +A [helix-git](https://aur.archlinux.org/packages/helix-git/) package is also available on the AUR, which builds the master branch. + +### Fedora Linux + +You can install the COPR package for Helix via + +``` +sudo dnf copr enable varlad/helix +sudo dnf install helix +``` + +### Void Linux + +``` +sudo xbps-install helix +``` + +## Build from source + +``` +git clone https://github.com/helix-editor/helix +cd helix +cargo install --path helix-term +``` + +This will install the `hx` binary to `$HOME/.cargo/bin`. + +Helix also needs it's runtime files so make sure to copy/symlink the `runtime/` directory into the +config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overridden +via the `HELIX_RUNTIME` environment variable. + +| OS | command | +|-----------|-----------| +|windows |`xcopy runtime %AppData%/helix/runtime`| +|linux/macos|`ln -s $PWD/runtime ~/.config/helix/runtime` + +## Building tree-sitter grammars + +Tree-sitter grammars must be fetched and compiled if not pre-packaged. +Fetch grammars with `hx --grammar fetch` (requires `git`) and compile them +with `hx --grammar build` (requires a C compiler). |