<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>book/src/configuration.md - fork/helix @ 25.07.1</title>
<meta name="description" content="book/src/configuration.md in fork/helix at 25.07.1.">
<meta property="og:title" content="book/src/configuration.md - fork/helix @ 25.07.1">
<meta property="og:description" content="book/src/configuration.md in fork/helix at 25.07.1.">
<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.1" data-tip="a05c151bb6e8e9c65ec390b0ae2afe7a5efd619b">
<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">Raghu Saxena</span><span class="commit-message" data-commit="4e2faa0be9faef50c7f86b8f8fdaf8c1ca85e79e">Add `:config-reload` to configuration docs (#11086)</span><span class="snapshot-sha sha" data-commit="4e2faa0be9faef50c7f86b8f8fdaf8c1ca85e79e">4e2faa0b</span><time datetime="2024-11-21T06:08:06+08:00" title="2024-11-21 06:08:06 +0800">2024-11-21</time></p>
<header class="topbar"><details class="switcher"><summary>25.07.1</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 href="/fork/helix/ref/25.07/">25.07</a><a class="current" 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.1/tree/book/">book</a> / <a href="/fork/helix/ref/25.07.1/tree/book/src/">src</a> / <span class="cur">configuration.md</span></nav>
<span class="view-stats"><span>1.1 KiB</span><span>35 lines</span></span><span class="actions"><a class="raw" href="/fork/helix/raw/317007efc7b4a739ec352a594f344d885ec6b891/book/src/configuration.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>Configuration</h1>
<p>To override global configuration parameters, create a <code>config.toml</code> file located in your config directory:</p>
<ul>
<li>Linux and Mac: <code>~/.config/helix/config.toml</code></li>
<li>Windows: <code>%AppData%\helix\config.toml</code></li>
</ul>
<blockquote>
<p>💡 You can easily open the config file by typing <code>:config-open</code> within Helix normal mode.</p>
</blockquote>
<p>Example config:</p>
<pre class="language-toml"><a-pr>theme</a-pr> <a-o>=</a-o> <a-s>&quot;onedark&quot;</a-s>

<a-p>[</a-p><a-pr>editor</a-pr><a-p>]</a-p>
<a-pr>line-number</a-pr> <a-o>=</a-o> <a-s>&quot;relative&quot;</a-s>
<a-pr>mouse</a-pr> <a-o>=</a-o> <a-co>false</a-co>

<a-p>[</a-p><a-pr>editor</a-pr><a-p>.</a-p><a-pr>cursor-shape</a-pr><a-p>]</a-p>
<a-pr>insert</a-pr> <a-o>=</a-o> <a-s>&quot;bar&quot;</a-s>
<a-pr>normal</a-pr> <a-o>=</a-o> <a-s>&quot;block&quot;</a-s>
<a-pr>select</a-pr> <a-o>=</a-o> <a-s>&quot;underline&quot;</a-s>

<a-p>[</a-p><a-pr>editor</a-pr><a-p>.</a-p><a-pr>file-picker</a-pr><a-p>]</a-p>
<a-pr>hidden</a-pr> <a-o>=</a-o> <a-co>false</a-co></pre>
<p>You can use a custom configuration file by specifying it with the <code>-c</code> or
<code>--config</code> command line argument, for example <code>hx -c path/to/custom-config.toml</code>.
You can reload the config file by issuing the <code>:config-reload</code> command. Alternatively, on Unix operating systems, you can reload it by sending the USR1
signal to the Helix process, such as by using the command <code>pkill -USR1 hx</code>.</p>
<p>Finally, you can have a <code>config.toml</code> local to a project by putting it under a <code>.helix</code> directory in your repository.
Its settings will be merged with the configuration directory <code>config.toml</code> and the built-in configuration.</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>Configuration</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">To override global configuration parameters, create a `config.toml` file located in your config directory:</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"><a-p>- </a-p>Linux and Mac: `~/.config/helix/config.toml`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>- </a-p>Windows: `%AppData%\helix\config.toml`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></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>&gt; 💡 You can easily open the config file by typing `:config-open` within Helix normal mode.</a-p></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>Example config:</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"></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>```</a-p><a-tl>toml</a-tl></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>theme </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;onedark&quot;</a-s></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-pr>editor</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>line-number </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;relative&quot;</a-s></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>mouse </a-p><a-o>=</a-o><a-p> </a-p><a-co>false</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></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>[</a-p><a-pr>editor</a-pr><a-p>.</a-p><a-pr>cursor-shape</a-pr><a-p>]</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"><a-p>insert </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;bar&quot;</a-s></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>normal </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;block&quot;</a-s></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>select </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;underline&quot;</a-s></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"><a-p>[</a-p><a-pr>editor</a-pr><a-p>.</a-p><a-pr>file-picker</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>hidden </a-p><a-o>=</a-o><a-p> </a-p><a-co>false</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">You can use a custom configuration file by specifying it with the `-c` or</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">`--config` command line argument, for example `hx -c path/to/custom-config.toml`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">You can reload the config file by issuing the `:config-reload` command. Alternatively, on Unix operating systems, you can reload it by sending the USR1</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">signal to the Helix process, such as by using the command `pkill -USR1 hx`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">Finally, you can have a `config.toml` local to a project by putting it under a `.helix` directory in your repository.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text">Its settings will be merged with the configuration directory `config.toml` and the built-in configuration.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
