<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>book/src/remapping.md - fork/helix @ 25.07</title>
<meta name="description" content="book/src/remapping.md in fork/helix at 25.07.">
<meta property="og:title" content="book/src/remapping.md - fork/helix @ 25.07">
<meta property="og:description" content="book/src/remapping.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">James Rogers</span><span class="commit-message" data-commit="4130b162a7bbc7de739807abc05a0e8ba3712133">Update docs link to Commands.md in Remapping.md (#13284)</span><span class="snapshot-sha sha" data-commit="4130b162a7bbc7de739807abc05a0e8ba3712133">4130b162</span><time datetime="2025-04-07T17:08:09+01:00" title="2025-04-07 17:08:09 +0100">2025-04-07</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">remapping.md</span></nav>
<span class="view-stats"><span>5.0 KiB</span><span>122 lines</span></span><span class="actions"><a class="raw" href="/fork/helix/raw/23bb80c55cbd6cb9cc0a7a75b9ecb4b38b818e03/book/src/remapping.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"><h2>Key remapping</h2>
<p>Helix currently supports one-way key remapping through a simple TOML configuration
file. (More powerful solutions such as rebinding via commands will be
available in the future).</p>
<p>There are three kinds of commands that can be used in keymaps:</p>
<ul>
<li>Static commands: commands like <code>move_char_right</code> which are usually bound to
keys and used for movement and editing. A list of static commands is
available in the <a href="./keymap.html">Keymap</a> documentation and in the source code
in <a href="https://github.com/helix-editor/helix/blob/master/helix-term/src/commands.rs"><code>helix-term/src/commands.rs</code></a>
at the invocation of <code>static_commands!</code> macro.</li>
<li>Typable commands: commands that can be executed from command mode (<code>:</code>), for
example <code>:write!</code>. See the <a href="/fork/helix/ref/25.07/blob/book/src/commands.md">Commands</a> documentation for a
list of available typeable commands or the <code>TypableCommandList</code> declaration in
the source code at <a href="https://github.com/helix-editor/helix/blob/master/helix-term/src/commands/typed.rs"><code>helix-term/src/commands/typed.rs</code></a>.</li>
<li>Macros: sequences of keys that are executed in order. These keybindings
start with <code>@</code> and then list any number of keys to be executed. For example
<code>@miw</code> can be used to select the surrounding word. For now, macro keybindings
are not allowed in keybinding sequences due to limitations in the way that
command sequences are executed. Modifier keys (e.g. Alt+o) can be used
like <code>"&lt;A-o&gt;"</code>, e.g. <code>"@miw&lt;A-o&gt;"</code></li>
</ul>
<p>To remap keys, create a <code>config.toml</code> file in your <code>helix</code> configuration
directory (default <code>~/.config/helix</code> on Linux systems) with a structure like
this:</p>
<blockquote>
<p>💡 To set a modifier + key as a keymap, type <code>A-X = ...</code> or  <code>C-X = ...</code> for Alt + X or Ctrl + X. Combine with Shift using a dash, e.g. <code>C-S-esc</code>.
Within macros, wrap them in <code>&lt;&gt;</code>, e.g. <code>&lt;A-X&gt;</code> and <code>&lt;C-X&gt;</code> to distinguish from the <code>A</code> or <code>C</code> keys.</p>
</blockquote>
<pre class="language-toml"><a-c># At most one section each of &#39;keys.normal&#39;, &#39;keys.insert&#39; and &#39;keys.select&#39;</a-c>
<a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>normal</a-pr><a-p>]</a-p>
<a-pr>C-s</a-pr> <a-o>=</a-o> <a-s>&quot;:w&quot;</a-s> <a-c># Maps Ctrl-s to the typable command :w which is an alias for :write (save file)</a-c>
<a-pr>C-o</a-pr> <a-o>=</a-o> <a-s>&quot;:open ~/.config/helix/config.toml&quot;</a-s> <a-c># Maps Ctrl-o to opening of the helix config file</a-c>
<a-pr>a</a-pr> <a-o>=</a-o> <a-s>&quot;move_char_left&quot;</a-s> <a-c># Maps the &#39;a&#39; key to the move_char_left command</a-c>
<a-pr>w</a-pr> <a-o>=</a-o> <a-s>&quot;move_line_up&quot;</a-s> <a-c># Maps the &#39;w&#39; key move_line_up</a-c>
<a-s>&quot;C-S-esc&quot;</a-s> <a-o>=</a-o> <a-s>&quot;extend_line&quot;</a-s> <a-c># Maps Ctrl-Shift-Escape to extend_line</a-c>
<a-pr>g</a-pr> <a-o>=</a-o> <a-p>{</a-p> <a-pr>a</a-pr> <a-o>=</a-o> <a-s>&quot;code_action&quot;</a-s> <a-p>}</a-p> <a-c># Maps `ga` to show possible code actions</a-c>
<a-s>&quot;ret&quot;</a-s> <a-o>=</a-o> <a-p>[</a-p><a-s>&quot;open_below&quot;</a-s><a-p>,</a-p> <a-s>&quot;normal_mode&quot;</a-s><a-p>]</a-p> <a-c># Maps the enter key to open_below then re-enter normal mode</a-c>
<a-s>&quot;A-x&quot;</a-s> <a-o>=</a-o> <a-s>&quot;@x&lt;A-d&gt;&quot;</a-s> <a-c># Maps Alt-x to a macro selecting the whole line and deleting it without yanking it</a-c>

<a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>insert</a-pr><a-p>]</a-p>
<a-s>&quot;A-x&quot;</a-s> <a-o>=</a-o> <a-s>&quot;normal_mode&quot;</a-s>     <a-c># Maps Alt-X to enter normal mode</a-c>
<a-pr>j</a-pr> <a-o>=</a-o> <a-p>{</a-p> <a-pr>k</a-pr> <a-o>=</a-o> <a-s>&quot;normal_mode&quot;</a-s> <a-p>}</a-p> <a-c># Maps `jk` to exit insert mode</a-c></pre>
<h2>Minor modes</h2>
<p>Minor modes are accessed by pressing a key (usually from normal mode), giving access to dedicated bindings. Bindings
can be modified or added by nesting definitions.</p>
<pre class="language-toml"><a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>insert</a-pr><a-p>.</a-p><a-pr>j</a-pr><a-p>]</a-p>
<a-pr>k</a-pr> <a-o>=</a-o> <a-s>&quot;normal_mode&quot;</a-s> <a-c># Maps `jk` to exit insert mode</a-c>

<a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>normal</a-pr><a-p>.</a-p><a-pr>g</a-pr><a-p>]</a-p>
<a-pr>a</a-pr> <a-o>=</a-o> <a-s>&quot;code_action&quot;</a-s> <a-c># Maps `ga` to show possible code actions</a-c>

<a-c># invert `j` and `k` in view mode</a-c>
<a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>normal</a-pr><a-p>.</a-p><a-pr>z</a-pr><a-p>]</a-p>
<a-pr>j</a-pr> <a-o>=</a-o> <a-s>&quot;scroll_up&quot;</a-s>
<a-pr>k</a-pr> <a-o>=</a-o> <a-s>&quot;scroll_down&quot;</a-s>

<a-c># create a new minor mode bound to `+`</a-c>
<a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>normal</a-pr><a-p>.</a-p><a-s>&quot;+&quot;</a-s><a-p>]</a-p>
<a-pr>m</a-pr> <a-o>=</a-o> <a-s>&quot;:run-shell-command make&quot;</a-s>
<a-pr>c</a-pr> <a-o>=</a-o> <a-s>&quot;:run-shell-command cargo build&quot;</a-s>
<a-pr>t</a-pr> <a-o>=</a-o> <a-s>&quot;:run-shell-command cargo test&quot;</a-s></pre>
<h2>Special keys and modifiers</h2>
<p>Ctrl, Shift and Alt modifiers are encoded respectively with the prefixes <code>C-</code>, <code>S-</code> and <code>A-</code>.</p>
<p>The <a href="https://en.wikipedia.org/wiki/Super_key_(keyboard_button)">Super key</a> - the Windows/Linux
key or the Command key on Mac keyboards - is also supported when using a terminal emulator that
supports the <a href="https://github.com/helix-editor/helix/wiki/Terminal-Support#enhanced-keyboard-protocol">enhanced keyboard protocol</a>.
The super key is encoded with prefixes <code>Meta-</code>, <code>Cmd-</code> or <code>Win-</code>. These are all synonyms for the
super modifier - binding a key with a <code>Win-</code> modifier will mean it can be used with the
Windows/Linux key or the Command key.</p>
<pre class="language-toml"><a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>normal</a-pr><a-p>]</a-p>
<a-pr>C-s</a-pr> <a-o>=</a-o> <a-s>&quot;:write&quot;</a-s> <a-c># Ctrl and &#39;s&#39; to write</a-c>
<a-pr>Cmd-s</a-pr> <a-o>=</a-o> <a-s>&quot;:write&quot;</a-s> <a-c># Cmd or Win or Meta and &#39;s&#39; to write</a-c></pre>
<p>Special keys are encoded as follows:</p>
<table><thead><tr><th>Key name</th><th>Representation</th></tr></thead><tbody>
<tr><td>Backspace</td><td><code>"backspace"</code></td></tr>
<tr><td>Space</td><td><code>"space"</code></td></tr>
<tr><td>Return/Enter</td><td><code>"ret"</code></td></tr>
<tr><td>Left</td><td><code>"left"</code></td></tr>
<tr><td>Right</td><td><code>"right"</code></td></tr>
<tr><td>Up</td><td><code>"up"</code></td></tr>
<tr><td>Down</td><td><code>"down"</code></td></tr>
<tr><td>Home</td><td><code>"home"</code></td></tr>
<tr><td>End</td><td><code>"end"</code></td></tr>
<tr><td>Page Up</td><td><code>"pageup"</code></td></tr>
<tr><td>Page Down</td><td><code>"pagedown"</code></td></tr>
<tr><td>Tab</td><td><code>"tab"</code></td></tr>
<tr><td>Delete</td><td><code>"del"</code></td></tr>
<tr><td>Insert</td><td><code>"ins"</code></td></tr>
<tr><td>Null</td><td><code>"null"</code></td></tr>
<tr><td>Escape</td><td><code>"esc"</code></td></tr>
</tbody></table>
<p>Keys can be disabled by binding them to the <code>no_op</code> command.</p>
<p>All other keys such as <code>?</code>, <code>!</code>, <code>-</code> etc. can be used literally:</p>
<pre class="language-toml"><a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>normal</a-pr><a-p>]</a-p>
<a-s>&quot;?&quot;</a-s> <a-o>=</a-o> <a-s>&quot;:write&quot;</a-s>
<a-s>&quot;!&quot;</a-s> <a-o>=</a-o> <a-s>&quot;:write&quot;</a-s>
<a-s>&quot;-&quot;</a-s> <a-o>=</a-o> <a-s>&quot;:write&quot;</a-s></pre>
<p>Note: <code>-</code> can't be used when combined with a modifier, for example <code>Alt</code> + <code>-</code> should be written as <code>A-minus</code>. <code>A--</code> is not accepted.</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>Key remapping</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">Helix currently supports one-way key remapping through a simple TOML configuration</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">file. (More powerful solutions such as rebinding via commands will be</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">available in the future).</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">There are three kinds of commands that can be used in keymaps:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>* </a-p>Static commands: commands like `move_char_right` which are usually bound to</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>  </a-p>keys and used for movement and editing. A list of static commands is</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>  </a-p>available in the [Keymap](./keymap.html) documentation and in the source code</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>in [`helix-term/src/commands.rs`](https://github.com/helix-editor/helix/blob/master/helix-term/src/commands.rs)</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>  </a-p>at the invocation of `static_commands!` macro.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>* </a-p>Typable commands: commands that can be executed from command mode (`:`), for</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>example `:write!`. See the [Commands](./commands.md) documentation for a</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>  </a-p>list of available typeable commands or the `TypableCommandList` declaration in</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>  </a-p>the source code at [`helix-term/src/commands/typed.rs`](https://github.com/helix-editor/helix/blob/master/helix-term/src/commands/typed.rs).</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>* </a-p>Macros: sequences of keys that are executed in order. These keybindings</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>start with `@` and then list any number of keys to be executed. For example</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>  </a-p>`@miw` can be used to select the surrounding word. For now, macro keybindings</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>  </a-p>are not allowed in keybinding sequences due to limitations in the way that</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>  </a-p>command sequences are executed. Modifier keys (e.g. Alt+o) can be used</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>  </a-p>like `&quot;&lt;A-o&gt;&quot;`, e.g. `&quot;@miw&lt;A-o&gt;&quot;`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></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>To remap keys, create a `config.toml` file in your `helix` configuration</a-p></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>directory (default `~/.config/helix` on Linux systems) with a structure like</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"><a-p>this:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>&gt; 💡 To set a modifier + key as a keymap, type `A-X = ...` or  `C-X = ...` for Alt + X or Ctrl + X. Combine with Shift using a dash, e.g. `C-S-esc`. </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>&gt; Within macros, wrap them in `&lt;&gt;`, e.g. `&lt;A-X&gt;` and `&lt;C-X&gt;` to distinguish from the `A` or `C` keys.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</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="L33" href="#L33">33</a><span class="code-text"><a-p># At most one section each of &#39;keys.normal&#39;, &#39;keys.insert&#39; and &#39;keys.select&#39;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>normal</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>C-s </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:w&quot;</a-s><a-p> </a-p><a-c># Maps Ctrl-s to the typable command :w which is an alias for :write (save file)</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>C-o </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:open ~/.config/helix/config.toml&quot;</a-s><a-p> </a-p><a-c># Maps Ctrl-o to opening of the helix config file</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>a </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;move_char_left&quot;</a-s><a-p> </a-p><a-c># Maps the &#39;a&#39; key to the move_char_left command</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>w </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;move_line_up&quot;</a-s><a-p> </a-p><a-c># Maps the &#39;w&#39; key move_line_up</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>&quot;C-S-esc&quot; </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;extend_line&quot;</a-s><a-p> </a-p><a-c># Maps Ctrl-Shift-Escape to extend_line</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>g </a-p><a-o>=</a-o><a-p> { </a-p><a-pr>a</a-pr><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;code_action&quot;</a-s><a-p> } </a-p><a-c># Maps `ga` to show possible code actions</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>&quot;ret&quot; </a-p><a-o>=</a-o><a-p> [</a-p><a-s>&quot;open_below&quot;</a-s><a-p>, </a-p><a-s>&quot;normal_mode&quot;</a-s><a-p>] </a-p><a-c># Maps the enter key to open_below then re-enter normal mode</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>&quot;A-x&quot; </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;@x&lt;A-d&gt;&quot;</a-s><a-p> </a-p><a-c># Maps Alt-x to a macro selecting the whole line and deleting it without yanking it</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>insert</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>&quot;A-x&quot; </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;normal_mode&quot;</a-s><a-p>     </a-p><a-c># Maps Alt-X to enter normal mode</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>j </a-p><a-o>=</a-o><a-p> { </a-p><a-pr>k</a-pr><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;normal_mode&quot;</a-s><a-p> } </a-p><a-c># Maps `jk` to exit insert mode</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>## </a-p><a-tt>Minor modes</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>Minor modes are accessed by pressing a key (usually from normal mode), giving access to dedicated bindings. Bindings</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>can be modified or added by nesting definitions.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</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="L55" href="#L55">55</a><span class="code-text"><a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>insert</a-pr><a-p>.</a-p><a-pr>j</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>k </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;normal_mode&quot;</a-s><a-p> </a-p><a-c># Maps `jk` to exit insert mode</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>normal</a-pr><a-p>.</a-p><a-pr>g</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>a </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;code_action&quot;</a-s><a-p> </a-p><a-c># Maps `ga` to show possible code actions</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p># invert `j` and `k` in view mode</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>normal</a-pr><a-p>.</a-p><a-pr>z</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>j </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;scroll_up&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>k </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;scroll_down&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p># create a new minor mode bound to `+`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>normal</a-pr><a-p>.</a-p><a-s>&quot;+&quot;</a-s><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>m </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:run-shell-command make&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>c </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:run-shell-command cargo build&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>t </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:run-shell-command cargo test&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>## </a-p><a-tt>Special keys and modifiers</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>Ctrl, Shift and Alt modifiers are encoded respectively with the prefixes `C-`, `S-` and `A-`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>The [Super key](https://en.wikipedia.org/wiki/Super_key_(keyboard_button)) - the Windows/Linux</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>key or the Command key on Mac keyboards - is also supported when using a terminal emulator that</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>supports the [enhanced keyboard protocol](https://github.com/helix-editor/helix/wiki/Terminal-Support#enhanced-keyboard-protocol).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>The super key is encoded with prefixes `Meta-`, `Cmd-` or `Win-`. These are all synonyms for the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>super modifier - binding a key with a `Win-` modifier will mean it can be used with the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>Windows/Linux key or the Command key.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</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="L85" href="#L85">85</a><span class="code-text"><a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>normal</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>C-s </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:write&quot;</a-s><a-p> </a-p><a-c># Ctrl and &#39;s&#39; to write</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>Cmd-s </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:write&quot;</a-s><a-p> </a-p><a-c># Cmd or Win or Meta and &#39;s&#39; to write</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>Special keys are encoded as follows:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>| Key name     | Representation |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>| ---          | ---            |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>| Backspace    | `&quot;backspace&quot;`  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>| Space        | `&quot;space&quot;`      |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>| Return/Enter | `&quot;ret&quot;`        |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>| Left         | `&quot;left&quot;`       |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>| Right        | `&quot;right&quot;`      |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>| Up           | `&quot;up&quot;`         |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>| Down         | `&quot;down&quot;`       |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>| Home         | `&quot;home&quot;`       |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>| End          | `&quot;end&quot;`        |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>| Page Up      | `&quot;pageup&quot;`     |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>| Page Down    | `&quot;pagedown&quot;`   |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>| Tab          | `&quot;tab&quot;`        |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>| Delete       | `&quot;del&quot;`        |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>| Insert       | `&quot;ins&quot;`        |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>| Null         | `&quot;null&quot;`       |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>| Escape       | `&quot;esc&quot;`        |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>Keys can be disabled by binding them to the `no_op` command.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p>All other keys such as `?`, `!`, `-` etc. can be used literally:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</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="L116" href="#L116">116</a><span class="code-text"><a-p>[</a-p><a-pr>keys</a-pr><a-p>.</a-p><a-pr>normal</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"><a-p>&quot;?&quot; </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:write&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>&quot;!&quot; </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:write&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"><a-p>&quot;-&quot; </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;:write&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text">Note: `-` can&#39;t be used when combined with a modifier, for example `Alt` + `-` should be written as `A-minus`. `A--` is not accepted.</span></span></pre></div></div>
</main>
</body>
</html>
