<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>book/src/install.md - fork/helix @ 25.07</title>
<meta name="description" content="book/src/install.md in fork/helix at 25.07.">
<meta property="og:title" content="book/src/install.md - fork/helix @ 25.07">
<meta property="og:description" content="book/src/install.md in fork/helix at 25.07.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="25.07" data-tip="5cda70e86637c376bdfaaf3383872e44d7622ff8">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/helix</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/helix</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Jonathan Davies</span><span class="commit-message" data-commit="c5c9e65cc4503253e63d47825f8767eca9e577de">Update install instructions (#13079)</span><span class="snapshot-sha sha" data-commit="c5c9e65cc4503253e63d47825f8767eca9e577de">c5c9e65c</span><time datetime="2025-03-11T13:41:35+00:00" title="2025-03-11 13:41:35 +0000">2025-03-11</time></p>
<header class="topbar"><details class="switcher"><summary>25.07</summary><div class="menu"><strong>branches</strong><a href="/fork/helix/ref/master/">master</a><strong>tags</strong><a href="/fork/helix/ref/23.05/">23.05</a><a href="/fork/helix/ref/23.10/">23.10</a><a href="/fork/helix/ref/24.03/">24.03</a><a href="/fork/helix/ref/24.07/">24.07</a><a href="/fork/helix/ref/25.01/">25.01</a><a href="/fork/helix/ref/25.01.1/">25.01.1</a><a class="current" href="/fork/helix/ref/25.07/">25.07</a><a href="/fork/helix/ref/25.07.1/">25.07.1</a><a class="all" href="/fork/helix/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/helix/">helix</a> / <a href="/fork/helix/ref/25.07/tree/book/">book</a> / <a href="/fork/helix/ref/25.07/tree/book/src/">src</a> / <span class="cur">install.md</span></nav>
<span class="view-stats"><span>1.1 KiB</span><span>24 lines</span></span><span class="actions"><a class="raw" href="/fork/helix/raw/021feceb2c104b71747b6b4ca62db94ee8df43f1/book/src/install.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Installing Helix</h1>
<p>The typical way to install Helix is via <a href="/fork/helix/ref/25.07/blob/book/src/package-managers.md">your operating system's package manager</a>.</p>
<p>Note that:</p>
<ul>
<li>
<p>To get the latest nightly version of Helix, you need to
<a href="/fork/helix/ref/25.07/blob/book/src/building-from-source.md">build from source</a>.</p>
</li>
<li>
<p>To take full advantage of Helix, install the language servers for your
preferred programming languages. See the
<a href="https://github.com/helix-editor/helix/wiki/Language-Server-Configurations">wiki</a>
for instructions.</p>
</li>
</ul>
<h2>Pre-built binaries</h2>
<p>Download pre-built binaries from the <a href="https://github.com/helix-editor/helix/releases">GitHub Releases page</a>.
The tarball contents include an <code>hx</code> binary and a <code>runtime</code> directory.
To set up Helix:</p>
<ol>
<li>Add the <code>hx</code> binary to your system's <code>$PATH</code> to allow it to be used from the command line.</li>
<li>Copy the <code>runtime</code> directory to a location that <code>hx</code> searches for runtime files. A typical location on Linux/macOS is <code>~/.config/helix/runtime</code>.</li>
</ol>
<p>To see the runtime directories that <code>hx</code> searches, run <code>hx --health</code>. If necessary, you can override the default runtime location by setting the <code>HELIX_RUNTIME</code> environment variable.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Installing Helix</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">The typical way to install Helix is via [your operating system&#39;s package manager](./package-managers.md).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">Note that:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>- </a-p>To get the latest nightly version of Helix, you need to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>  </a-p>[build from source](./building-from-source.md).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>- To take full advantage of Helix, install the language servers for your</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>  preferred programming languages. See the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>  [wiki](https://github.com/helix-editor/helix/wiki/Language-Server-Configurations)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>  for instructions.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>## </a-p><a-tt>Pre-built binaries</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>Download pre-built binaries from the [GitHub Releases page](https://github.com/helix-editor/helix/releases).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>The tarball contents include an `hx` binary and a `runtime` directory.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>To set up Helix:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>1. Add the `hx` binary to your system&#39;s `$PATH` to allow it to be used from the command line.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>2. Copy the `runtime` directory to a location that `hx` searches for runtime files. A typical location on Linux/macOS is `~/.config/helix/runtime`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">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.</span></span></pre></div></div>
</main>
</body>
</html>
