![, etc.](#n35<h1 id="using-helix"><a class="toclink" href="#using-helix">Using Helix</a></h1>
<!--toc:start-->
<ul>
<li><a href="#registers">Registers</a></li>
<li><a href="#user-defined-registers">User-defined registers</a></li>
<li><a href="#special-registers">Special registers</a></li>
<li><a href="#surround">Surround</a></li>
<li><a href="#selecting-and-manipulating-text-with-textobjects">Selecting and manipulating text with textobjects</a></li>
<li><a href="#navigating-using-tree-sitter-textobjects">Navigating using tree-sitter textobjects</a></li>
<li><a href="#moving-the-selection-with-syntax-aware-motions">Moving the selection with syntax-aware motions</a></li>
</ul>
<!--toc:end-->
<p>For a full interactive introduction to Helix, refer to the
<a href="https://github.com/helix-editor/helix/blob/master/runtime/tutor">tutor</a> which
can be accessed via the command <code>hx --tutor</code> or <code>:tutor</code>.</p>
<blockquote>
<p>💡 Currently, not all functionality is fully documented, please refer to the
<a href="./keymap.md">key mappings</a> list.</p>
</blockquote>
<h2 id="registers"><a class="toclink" href="#registers">Registers</a></h2>
<p>In Helix, registers are storage locations for text and other data, such as the
result of a search. Registers can be used to cut, copy, and paste text, similar
to the clipboard in other text editors. Usage is similar to Vim, with <code>"</code> being
used to select a register.</p>
<h3 id="user-defined-registers"><a class="toclink" href="#user-defined-registers">User-defined registers</a></h3>
<p>Helix allows you to create your own named registers for storing text, for
example:</p>
<ul>
<li><code>"ay</code> - Yank the current selection to register <code>a</code>.</li>
<li><code>"op</code> - Paste the text in register <code>o</code> after the selection.</li>
</ul>
<p>If a register is selected before invoking a change or delete command, the selection will be stored in the register and the action will be carried out:</p>
<ul>
<li><code>"hc</code> - Store the selection in register <code>h</code> and then change it (delete and enter insert mode).</li>
<li><code>"md</code> - Store the selection in register <code>m</code> and delete it.</li>
</ul>
<h3 id="default-registers"><a class="toclink" href="#default-registers">Default registers</a></h3>
<p>Commands that use registers, like yank (<code>y</code>), use a default register if none is specified.
These registers are used as defaults:</p>
<table>
<thead>
<tr>
<th>Register character</th>
<th>Contains</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>/</code></td>
<td>Last search</td>
</tr>
<tr>
<td><code>:</code></td>
<td>Last executed command</td>
</tr>
<tr>
<td><code>"</code></td>
<td>Last yanked text</td>
</tr>
<tr>
<td><code>@</code></td>
<td>Last recorded macro</td>
</tr>
</tbody>
</table>
<h3 id="special-registers"><a class="toclink" href="#special-registers">Special registers</a></h3>
<p>Some registers have special behavior when read from and written to.</p>
<table>
<thead>
<tr>
<th>Register character</th>
<th>When read</th>
<th>When written</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>_</code></td>
<td>No values are returned</td>
<td>All values are discarded</td>
</tr>
<tr>
<td><code>#</code></td>
<td>Selection indices (first selection is <code>1</code>, second is <code>2</code>, etc.)</td>
<td>This register is not writable</td>
</tr>
<tr>
<td><code>.</code></td>
<td>Contents of the current selections</td>
<td>This register is not writable</td>
</tr>
<tr>
<td><code>%</code></td>
<td>Name of the current file</td>
<td>This register is not writable</td>
</tr>
<tr>
<td><code>+</code></td>
<td>Reads from the system clipboard</td>
<td>Joins and yanks to the system clipboard</td>
</tr>
<tr>
<td><code>*</code></td>
<td>Reads from the primary clipboard</td>
<td>Joins and yanks to the primary clipboard</td>
</tr>
</tbody>
</table>
<p>When yanking multiple selections to the clipboard registers, the selections
are joined with newlines. Pasting from these registers will paste multiple
selections if the clipboard was last yanked to by the Helix session. Otherwise
the clipboard contents are pasted as one selection.</p>
<h2 id="surround"><a class="toclink" href="#surround">Surround</a></h2>
<p>Helix includes built-in functionality similar to <a href="https://github.com/tpope/vim-surround">vim-surround</a>.
The keymappings have been inspired from <a href="https://github.com/machakann/vim-sandwich">vim-sandwich</a>:</p>
<p><img alt="Surround demo" src="https://user-images.githubusercontent.com/23398472/122865801-97073180-d344-11eb-8142-8f43809982c6.gif"></p>
<table>
<thead>
<tr>
<th>Key Sequence</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>ms<char></code> (after selecting text)</td>
<td>Add surround characters to selection</td>
</tr>
<tr>
<td><code>mr<char_to_replace><new_char></code></td>
<td>Replace the closest surround characters</td>
</tr>
<tr>
<td><code>md<char_to_delete></code></td>
<td>Delete the closest surround characters</td>
</tr>
</tbody>
</table>
<p>You can use counts to act on outer pairs.</p>
<p>Surround can also act on multiple selections. For example, to change every occurrence of <code>(use)</code> to <code>[use]</code>:</p>
<ol>
<li><code>%</code> to select the whole file</li>
<li><code>s</code> to split the selections on a search term</li>
<li>Input <code>use</code> and hit Enter</li>
<li><code>mr([</code> to replace the parentheses with square brackets</li>
</ol>
<p>Multiple characters are currently not supported, but planned for future release.</p>
<h2 id="selecting-and-manipulating-text-with-textobjects"><a class="toclink" href="#selecting-and-manipulating-text-with-textobjects">Selecting and manipulating text with textobjects</a></h2>
<p>In Helix, textobjects are a way to select, manipulate and operate on a piece of
text in a structured way. They allow you to refer to blocks of text based on
their structure or purpose, such as a word, sentence, paragraph, or even a
function or block of code.</p>
<p><img alt="Textobject demo" src="https://user-images.githubusercontent.com/23398472/124231131-81a4bb00-db2d-11eb-9d10-8e577ca7b177.gif">
<img alt="Textobject tree-sitter demo" src="https://user-images.githubusercontent.com/23398472/132537398-2a2e0a54-582b-44ab-a77f-eb818942203d.gif"></p>
<ul>
<li><code>ma</code> - Select around the object (<code>va</code> in Vim, <code><alt-a></code> in Kakoune)</li>
<li><code>mi</code> - Select inside the object (<code>vi</code> in Vim, <code><alt-i></code> in Kakoune)</li>
</ul>
<table>
<thead>
<tr>
<th>Key after <code>mi</code> or <code>ma</code></th>
<th>Textobject selected</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>w</code></td>
<td>Word</td>
</tr>
<tr>
<td><code>W</code></td>
<td>WORD</td>
</tr>
<tr>
<td><code>p</code></td>
<td>Paragraph</td>
</tr>
<tr>
<td><code>(</code>, <code>[</code>, <code>){kind=link}
💡
f,t, etc. need a tree-sitter grammar active for the current document and a special tree-sitter query file to work properly. Only some grammars currently have the query file implemented. Contributions are welcome!
Navigating using tree-sitter textobjects
Navigating between functions, classes, parameters, and other elements is
possible using tree-sitter and textobject queries. For
example to move to the next function use ]f, to move to previous
type use [t, and so on.
For the full reference see the unimpaired section of the key bind documentation.
💡 This feature relies on tree-sitter textobjects and requires the corresponding query file to work properly.
Moving the selection with syntax-aware motions
Alt-p, Alt-o, Alt-i, and Alt-n (or Alt and arrow keys) allow you to move the
selection according to its location in the syntax tree. For example, many languages have the
following syntax for function calls:
func(arg1, arg2, arg3);
A function call might be parsed by tree-sitter into a tree like the following.
(call
function: (identifier) ; func
arguments:
(arguments ; (arg1, arg2, arg3)
(identifier) ; arg1
(identifier) ; arg2
(identifier))) ; arg3
Use :tree-sitter-subtree to view the syntax tree of the primary selection. In
a more intuitive tree format:
┌────┐
│call│
┌─────┴────┴─────┐
│ │
┌─────▼────┐ ┌────▼────┐
│identifier│ │arguments│
│ "func" │ ┌────┴───┬─────┴───┐
└──────────┘ │ │ │
│ │ │
┌─────────▼┐ ┌────▼─────┐ ┌▼─────────┐
│identifier│ │identifier│ │identifier│
│ "arg1" │ │ "arg2" │ │ "arg3" │
└──────────┘ └──────────┘ └──────────┘
If you have a selection that wraps arg1 (see the tree above), and you use
Alt-n, it will select the next sibling in the syntax tree: arg2.
// before
func([arg1], arg2, arg3)
// after
func(arg1, [arg2], arg3);
Similarly, Alt-o will expand the selection to the parent node, in this case, the
arguments node.
func[(arg1, arg2, arg3)];
There is also some nuanced behavior that prevents you from getting stuck on a
node with no sibling. When using Alt-p with a selection on arg1, the previous
child node will be selected. In the event that arg1 does not have a previous
sibling, the selection will move up the syntax tree and select the previous
element. As a result, using Alt-p with a selection on arg1 will move the
selection to the "func" identifier.