mirror of https://github.com/helix-editor/helix
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
415 lines
23 KiB
HTML
415 lines
23 KiB
HTML
2 years ago
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="sidebar-visible no-js colibri">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Installation</title>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Custom HTML head -->
|
||
|
|
|
||
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||
|
|
<meta name="description" content="">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta name="theme-color" content="#ffffff" />
|
||
|
|
|
||
|
|
<link rel="icon" href="favicon.svg">
|
||
|
|
<link rel="shortcut icon" href="favicon.png">
|
||
|
|
<link rel="stylesheet" href="css/variables.css">
|
||
|
|
<link rel="stylesheet" href="css/general.css">
|
||
|
|
<link rel="stylesheet" href="css/chrome.css">
|
||
|
|
<link rel="stylesheet" href="css/print.css" media="print">
|
||
|
|
|
||
|
|
<!-- Fonts -->
|
||
|
|
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
|
||
|
|
<link rel="preconnect" href="https://fonts.gstatic.com">
|
||
|
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@200;400;500;700&display=swap" rel="stylesheet">
|
||
|
|
<link rel="stylesheet" href="fonts/fonts.css">
|
||
|
|
|
||
|
|
<!-- Highlight.js Stylesheets -->
|
||
|
|
<link rel="stylesheet" href="highlight.css">
|
||
|
|
<link rel="stylesheet" href="tomorrow-night.css">
|
||
|
|
<link rel="stylesheet" href="ayu-highlight.css">
|
||
|
|
|
||
|
|
<!-- Custom theme stylesheets -->
|
||
|
|
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Provide site root to javascript -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var path_to_root = "";
|
||
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "colibri" : "colibri";
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
try {
|
||
|
|
var theme = localStorage.getItem('mdbook-theme');
|
||
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
|
|
||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
|
|
}
|
||
|
|
|
||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
|
|
}
|
||
|
|
} catch (e) { }
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var theme;
|
||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
html.classList.remove('no-js')
|
||
|
|
html.classList.remove('colibri')
|
||
|
|
html.classList.add(theme);
|
||
|
|
html.classList.add('js');
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
var sidebar = 'hidden';
|
||
|
|
if (document.body.clientWidth >= 1080) {
|
||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
|
|
sidebar = sidebar || 'visible';
|
||
|
|
}
|
||
|
|
html.classList.remove('sidebar-visible');
|
||
|
|
html.classList.add("sidebar-" + sidebar);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
|
|
<div class="sidebar-scrollbox">
|
||
|
|
<ol class="chapter"><li class="chapter-item expanded affix "><a href="title-page.html">Helix</a></li><li class="chapter-item expanded "><a href="install.html" class="active"><strong aria-hidden="true">1.</strong> Installation</a></li><li class="chapter-item expanded "><a href="usage.html"><strong aria-hidden="true">2.</strong> Usage</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="keymap.html"><strong aria-hidden="true">2.1.</strong> Keymap</a></li><li class="chapter-item expanded "><a href="commands.html"><strong aria-hidden="true">2.2.</strong> Commands</a></li><li class="chapter-item expanded "><a href="lang-support.html"><strong aria-hidden="true">2.3.</strong> Language support</a></li></ol></li><li class="chapter-item expanded "><a href="from-vim.html"><strong aria-hidden="true">3.</strong> Migrating from Vim</a></li><li class="chapter-item expanded "><a href="configuration.html"><strong aria-hidden="true">4.</strong> Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="themes.html"><strong aria-hidden="true">4.1.</strong> Themes</a></li><li class="chapter-item expanded "><a href="remapping.html"><strong aria-hidden="true">4.2.</strong> Key remapping</a></li><li class="chapter-item expanded "><a href="languages.html"><strong aria-hidden="true">4.3.</strong> Languages</a></li></ol></li><li class="chapter-item expanded "><a href="guides/index.html"><strong aria-hidden="true">5.</strong> Guides</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="guides/adding_languages.html"><strong aria-hidden="true">5.1.</strong> Adding languages</a></li><li class="chapter-item expanded "><a href="guides/textobject.html"><strong aria-hidden="true">5.2.</strong> Adding textobject queries</a></li><li class="chapter-item expanded "><a href="guides/indent.html"><strong aria-hidden="true">5.3.</strong> Adding indent queries</a></li><li class="chapter-item expanded "><a href="guides/injection.html"><strong aria-hidden="true">5.4.</strong> Adding injection queries</a></li></ol></li></ol>
|
||
|
|
</div>
|
||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
<div id="menu-bar-hover-placeholder"></div>
|
||
|
|
<div id="menu-bar" class="menu-bar sticky bordered">
|
||
|
|
<div class="left-buttons">
|
||
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
|
|
<i class="fa fa-bars"></i>
|
||
|
|
</button>
|
||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
|
|
<i class="fa fa-paint-brush"></i>
|
||
|
|
</button>
|
||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="colibri">Colibri (default)</button></li>
|
||
|
|
</ul>
|
||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
||
|
|
<i class="fa fa-search"></i>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 class="menu-title"></h1>
|
||
|
|
|
||
|
|
<div class="right-buttons">
|
||
|
|
<a href="print.html" title="Print this book" aria-label="Print this book">
|
||
|
|
<i id="print-button" class="fa fa-print"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/helix-editor/helix" title="Git repository" aria-label="Git repository">
|
||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="search-wrapper" class="hidden">
|
||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
||
|
|
<input type="search" name="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
|
|
</form>
|
||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
||
|
|
<ul id="searchresults">
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<main>
|
||
|
|
<h1 id="installing-helix"><a class="header" href="#installing-helix">Installing Helix</a></h1>
|
||
|
|
<!--toc:start-->
|
||
|
|
<ul>
|
||
|
|
<li><a href="#pre-built-binaries">Pre-built binaries</a></li>
|
||
|
|
<li><a href="#linux-macos-windows-and-openbsd-packaging-status">Linux, macOS, Windows and OpenBSD packaging status</a></li>
|
||
|
|
<li><a href="#linux">Linux</a>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#ubuntu">Ubuntu</a></li>
|
||
|
|
<li><a href="#fedorarhel">Fedora/RHEL</a></li>
|
||
|
|
<li><a href="#arch-linux-community">Arch Linux community</a></li>
|
||
|
|
<li><a href="#nixos">NixOS</a></li>
|
||
|
|
<li><a href="#flatpak">Flatpak</a></li>
|
||
|
|
<li><a href="#appimage">AppImage</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a href="#macos">macOS</a>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#homebrew-core">Homebrew Core</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a href="#windows">Windows</a>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#winget">Winget</a></li>
|
||
|
|
<li><a href="#scoop">Scoop</a></li>
|
||
|
|
<li><a href="#chocolatey">Chocolatey</a></li>
|
||
|
|
<li><a href="#msys2">MSYS2</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a href="#building-from-source">Building from source</a>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#configuring-helixs-runtime-files">Configuring Helix's runtime files</a>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#linux-and-macos">Linux and macOS</a></li>
|
||
|
|
<li><a href="#windows">Windows</a></li>
|
||
|
|
<li><a href="#multiple-runtime-directories">Multiple runtime directories</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a href="#validating-the-installation">Validating the installation</a></li>
|
||
|
|
<li><a href="#configure-the-desktop-shortcut">Configure the desktop shortcut</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<!--toc:end-->
|
||
|
|
<p>To install Helix, follow the instructions specific to your operating system.
|
||
|
|
Note that:</p>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<p>To get the latest nightly version of Helix, you need to
|
||
|
|
<a href="#building-from-source">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/How-to-install-the-default-language-servers">wiki</a>
|
||
|
|
for instructions.</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="pre-built-binaries"><a class="header" href="#pre-built-binaries">Pre-built binaries</a></h2>
|
||
|
|
<p>Download pre-built binaries from the
|
||
|
|
<a href="https://github.com/helix-editor/helix/releases">GitHub Releases page</a>. Add the binary to your system's <code>$PATH</code> to use it from the command
|
||
|
|
line.</p>
|
||
|
|
<h2 id="linux-macos-windows-and-openbsd-packaging-status"><a class="header" href="#linux-macos-windows-and-openbsd-packaging-status">Linux, macOS, Windows and OpenBSD packaging status</a></h2>
|
||
|
|
<p><a href="https://repology.org/project/helix/versions"><img src="https://repology.org/badge/vertical-allrepos/helix.svg" alt="Packaging status" /></a></p>
|
||
|
|
<h2 id="linux"><a class="header" href="#linux">Linux</a></h2>
|
||
|
|
<p>The following third party repositories are available:</p>
|
||
|
|
<h3 id="ubuntu"><a class="header" href="#ubuntu">Ubuntu</a></h3>
|
||
|
|
<p>Add the <code>PPA</code> for Helix:</p>
|
||
|
|
<pre><code class="language-sh">sudo add-apt-repository ppa:maveonair/helix-editor
|
||
|
|
sudo apt update
|
||
|
|
sudo apt install helix
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="fedorarhel"><a class="header" href="#fedorarhel">Fedora/RHEL</a></h3>
|
||
|
|
<p>Enable the <code>COPR</code> repository for Helix:</p>
|
||
|
|
<pre><code class="language-sh">sudo dnf copr enable varlad/helix
|
||
|
|
sudo dnf install helix
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="arch-linux-community"><a class="header" href="#arch-linux-community">Arch Linux community</a></h3>
|
||
|
|
<p>Releases are available in the <code>community</code> repository:</p>
|
||
|
|
<pre><code class="language-sh">sudo pacman -S helix
|
||
|
|
</code></pre>
|
||
|
|
<p>Additionally, a <a href="https://aur.archlinux.org/packages/helix-git/">helix-git</a> package is available
|
||
|
|
in the AUR, which builds the master branch.</p>
|
||
|
|
<h3 id="nixos"><a class="header" href="#nixos">NixOS</a></h3>
|
||
|
|
<p>Helix is available as a <a href="https://nixos.wiki/wiki/Flakes">flake</a> in the project
|
||
|
|
root. Use <code>nix develop</code> to spin up a reproducible development shell. Outputs are
|
||
|
|
cached for each push to master using <a href="https://www.cachix.org/">Cachix</a>. The
|
||
|
|
flake is configured to automatically make use of this cache assuming the user
|
||
|
|
accepts the new settings on first use.</p>
|
||
|
|
<p>If you are using a version of Nix without flakes enabled,
|
||
|
|
<a href="https://docs.cachix.org/installation">install Cachix CLI</a> and use
|
||
|
|
<code>cachix use helix</code> to configure Nix to use cached outputs when possible.</p>
|
||
|
|
<h3 id="flatpak"><a class="header" href="#flatpak">Flatpak</a></h3>
|
||
|
|
<p>Helix is available on <a href="https://flathub.org/en-GB/apps/com.helix_editor.Helix">Flathub</a>:</p>
|
||
|
|
<pre><code class="language-sh">flatpak install flathub com.helix_editor.Helix
|
||
|
|
flatpak run com.helix_editor.Helix
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="appimage"><a class="header" href="#appimage">AppImage</a></h3>
|
||
|
|
<p>Install Helix using the Linux <a href="https://appimage.org/">AppImage</a> format.
|
||
|
|
Download the official Helix AppImage from the <a href="https://github.com/helix-editor/helix/releases/latest">latest releases</a> page.</p>
|
||
|
|
<pre><code class="language-sh">chmod +x helix-*.AppImage # change permission for executable mode
|
||
|
|
./helix-*.AppImage # run helix
|
||
|
|
</code></pre>
|
||
|
|
<h2 id="macos"><a class="header" href="#macos">macOS</a></h2>
|
||
|
|
<h3 id="homebrew-core"><a class="header" href="#homebrew-core">Homebrew Core</a></h3>
|
||
|
|
<pre><code class="language-sh">brew install helix
|
||
|
|
</code></pre>
|
||
|
|
<h2 id="windows"><a class="header" href="#windows">Windows</a></h2>
|
||
|
|
<p>Install on Windows using <a href="https://learn.microsoft.com/en-us/windows/package-manager/winget/">Winget</a>, <a href="https://scoop.sh/">Scoop</a>, <a href="https://chocolatey.org/">Chocolatey</a>
|
||
|
|
or <a href="https://msys2.org/">MSYS2</a>.</p>
|
||
|
|
<h3 id="winget"><a class="header" href="#winget">Winget</a></h3>
|
||
|
|
<p>Windows Package Manager winget command-line tool is by default available on Windows 11 and modern versions of Windows 10 as a part of the App Installer.
|
||
|
|
You can get <a href="https://www.microsoft.com/p/app-installer/9nblggh4nns1#activetab=pivot:overviewtab">App Installer from the Microsoft Store</a>. If it's already installed, make sure it is updated with the latest version.</p>
|
||
|
|
<pre><code class="language-sh">winget install Helix.Helix
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="scoop"><a class="header" href="#scoop">Scoop</a></h3>
|
||
|
|
<pre><code class="language-sh">scoop install helix
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="chocolatey"><a class="header" href="#chocolatey">Chocolatey</a></h3>
|
||
|
|
<pre><code class="language-sh">choco install helix
|
||
|
|
</code></pre>
|
||
|
|
<h3 id="msys2"><a class="header" href="#msys2">MSYS2</a></h3>
|
||
|
|
<p>For 64-bit Windows 8.1 or above:</p>
|
||
|
|
<pre><code class="language-sh">pacman -S mingw-w64-ucrt-x86_64-helix
|
||
|
|
</code></pre>
|
||
|
|
<h2 id="building-from-source"><a class="header" href="#building-from-source">Building from source</a></h2>
|
||
|
|
<p>Requirements:</p>
|
||
|
|
<ul>
|
||
|
|
<li>The <a href="https://www.rust-lang.org/tools/install">Rust toolchain</a></li>
|
||
|
|
<li>The <a href="https://git-scm.com/">Git version control system</a></li>
|
||
|
|
<li>A c++14 compatible compiler to build the tree-sitter grammars, for example GCC or Clang</li>
|
||
|
|
</ul>
|
||
|
|
<p>If you are using the <code>musl-libc</code> standard library instead of <code>glibc</code> the following environment variable must be set during the build to ensure tree-sitter grammars can be loaded correctly:</p>
|
||
|
|
<pre><code class="language-sh">RUSTFLAGS="-C target-feature=-crt-static"
|
||
|
|
</code></pre>
|
||
|
|
<ol>
|
||
|
|
<li>Clone the repository:</li>
|
||
|
|
</ol>
|
||
|
|
<pre><code class="language-sh">git clone https://github.com/helix-editor/helix
|
||
|
|
cd helix
|
||
|
|
</code></pre>
|
||
|
|
<ol start="2">
|
||
|
|
<li>Compile from source:</li>
|
||
|
|
</ol>
|
||
|
|
<pre><code class="language-sh">cargo install --path helix-term --locked
|
||
|
|
</code></pre>
|
||
|
|
<p>This command will create the <code>hx</code> executable and construct the tree-sitter
|
||
|
|
grammars in the local <code>runtime</code> folder.</p>
|
||
|
|
<blockquote>
|
||
|
|
<p>💡 Tree-sitter grammars can be fetched and compiled if not pre-packaged. Fetch
|
||
|
|
grammars with <code>hx --grammar fetch</code> and compile them with
|
||
|
|
<code>hx --grammar build</code>. This will install them in
|
||
|
|
the <code>runtime</code> directory within the user's helix config directory (more
|
||
|
|
<a href="#multiple-runtime-directories">details below</a>).</p>
|
||
|
|
</blockquote>
|
||
|
|
<h3 id="configuring-helixs-runtime-files"><a class="header" href="#configuring-helixs-runtime-files">Configuring Helix's runtime files</a></h3>
|
||
|
|
<h4 id="linux-and-macos"><a class="header" href="#linux-and-macos">Linux and macOS</a></h4>
|
||
|
|
<p>Either set the <code>HELIX_RUNTIME</code> environment variable to point to the runtime files and add it to your <code>~/.bashrc</code> or equivalent:</p>
|
||
|
|
<pre><code class="language-sh">HELIX_RUNTIME=/home/user-name/src/helix/runtime
|
||
|
|
</code></pre>
|
||
|
|
<p>Or, create a symlink in <code>~/.config/helix</code> that links to the source code directory:</p>
|
||
|
|
<pre><code class="language-sh">ln -s $PWD/runtime ~/.config/helix/runtime
|
||
|
|
</code></pre>
|
||
|
|
<h4 id="windows-1"><a class="header" href="#windows-1">Windows</a></h4>
|
||
|
|
<p>Either set the <code>HELIX_RUNTIME</code> environment variable to point to the runtime files using the Windows setting (search for
|
||
|
|
<code>Edit environment variables for your account</code>) or use the <code>setx</code> command in
|
||
|
|
Cmd:</p>
|
||
|
|
<pre><code class="language-sh">setx HELIX_RUNTIME "%userprofile%\source\repos\helix\runtime"
|
||
|
|
</code></pre>
|
||
|
|
<blockquote>
|
||
|
|
<p>💡 <code>%userprofile%</code> resolves to your user directory like
|
||
|
|
<code>C:\Users\Your-Name\</code> for example.</p>
|
||
|
|
</blockquote>
|
||
|
|
<p>Or, create a symlink in <code>%appdata%\helix\</code> that links to the source code directory:</p>
|
||
|
|
<div class="table-wrapper"><table><thead><tr><th>Method</th><th>Command</th></tr></thead><tbody>
|
||
|
|
<tr><td>PowerShell</td><td><code>New-Item -ItemType Junction -Target "runtime" -Path "$Env:AppData\helix\runtime"</code></td></tr>
|
||
|
|
<tr><td>Cmd</td><td><code>cd %appdata%\helix</code> <br/> <code>mklink /D runtime "%userprofile%\src\helix\runtime"</code></td></tr>
|
||
|
|
</tbody></table>
|
||
|
|
</div>
|
||
|
|
<blockquote>
|
||
|
|
<p>💡 On Windows, creating a symbolic link may require running PowerShell or
|
||
|
|
Cmd as an administrator.</p>
|
||
|
|
</blockquote>
|
||
|
|
<h4 id="multiple-runtime-directories"><a class="header" href="#multiple-runtime-directories">Multiple runtime directories</a></h4>
|
||
|
|
<p>When Helix finds multiple runtime directories it will search through them for files in the
|
||
|
|
following order:</p>
|
||
|
|
<ol>
|
||
|
|
<li><code>runtime/</code> sibling directory to <code>$CARGO_MANIFEST_DIR</code> directory (this is intended for
|
||
|
|
developing and testing helix only).</li>
|
||
|
|
<li><code>runtime/</code> subdirectory of OS-dependent helix user config directory.</li>
|
||
|
|
<li><code>$HELIX_RUNTIME</code>.</li>
|
||
|
|
<li><code>runtime/</code> subdirectory of path to Helix executable.</li>
|
||
|
|
</ol>
|
||
|
|
<p>This order also sets the priority for selecting which file will be used if multiple runtime
|
||
|
|
directories have files with the same name.</p>
|
||
|
|
<h3 id="validating-the-installation"><a class="header" href="#validating-the-installation">Validating the installation</a></h3>
|
||
|
|
<p>To make sure everything is set up as expected you should run the Helix health
|
||
|
|
check:</p>
|
||
|
|
<pre><code class="language-sh">hx --health
|
||
|
|
</code></pre>
|
||
|
|
<p>For more information on the health check results refer to
|
||
|
|
<a href="https://github.com/helix-editor/helix/wiki/Healthcheck">Health check</a>.</p>
|
||
|
|
<h3 id="configure-the-desktop-shortcut"><a class="header" href="#configure-the-desktop-shortcut">Configure the desktop shortcut</a></h3>
|
||
|
|
<p>If your desktop environment supports the
|
||
|
|
<a href="https://specifications.freedesktop.org/menu-spec/menu-spec-latest.html">XDG desktop menu</a>
|
||
|
|
you can configure Helix to show up in the application menu by copying the
|
||
|
|
provided <code>.desktop</code> and icon files to their correct folders:</p>
|
||
|
|
<pre><code class="language-sh">cp contrib/Helix.desktop ~/.local/share/applications
|
||
|
|
cp contrib/helix.png ~/.icons # or ~/.local/share/icons
|
||
|
|
</code></pre>
|
||
|
|
<p>To use another terminal than the system default, you can modify the <code>.desktop</code>
|
||
|
|
file. For example, to use <code>kitty</code>:</p>
|
||
|
|
<pre><code class="language-sh">sed -i "s|Exec=hx %F|Exec=kitty hx %F|g" ~/.local/share/applications/Helix.desktop
|
||
|
|
sed -i "s|Terminal=true|Terminal=false|g" ~/.local/share/applications/Helix.desktop
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="title-page.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<a rel="next" href="usage.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<div style="clear: both"></div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
|
|
<a rel="prev" href="title-page.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<a rel="next" href="usage.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
window.playground_copyable = true;
|
||
|
|
</script>
|
||
|
|
|
||
|
|
|
||
|
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
|
||
|
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
|
||
|
|
<!-- Custom JS scripts -->
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|