git.iko.soy/helix
on 609f736 help sign in
helix/book/src/usage.md
76 lines 3.6 kB history raw
1# Usage
3(Currently not fully documented, see the [keymappings](./keymap.md) list for more.)
5See [tutor.txt](https://github.com/helix-editor/helix/blob/master/runtime/tutor.txt) (accessible via `hx --tutor` or `:tutor`) for a vimtutor-like introduction.
7## Registers
9Vim-like registers can be used to yank and store text to be pasted later. Usage is similar, with `"` being used to select a register:
11- `"ay` - Yank the current selection to register `a`.
12- `"op` - Paste the text in register `o` after the selection.
14If there is a selected register before invoking a change or delete command, the selection will be stored in the register and the action will be carried out:
16- `"hc` - Store the selection in register `h` and then change it (delete and enter insert mode).
17- `"md` - Store the selection in register `m` and delete it.
19### Special Registers
21| Register character | Contains |
22| --- | --- |
23| `/` | Last search |
24| `:` | Last executed command |
25| `"` | Last yanked text |
26| `_` | Black hole |
28> There is no special register for copying to system clipboard, instead special commands and keybindings are provided. See the [keymap](keymap.md#space-mode) for the specifics.
29> The black hole register works as a no-op register, meaning no data will be written to / read from it.
31## Surround
33Functionality similar to [vim-surround](https://github.com/tpope/vim-surround) is built into
34helix. The keymappings have been inspired from [vim-sandwich](https://github.com/machakann/vim-sandwich):
36![surround demo](https://user-images.githubusercontent.com/23398472/122865801-97073180-d344-11eb-8142-8f43809982c6.gif)
38- `ms` - Add surround characters
39- `mr` - Replace surround characters
40- `md` - Delete surround characters
42`ms` acts on a selection, so select the text first and use `ms<char>`. `mr` and `md` work
43on the closest pairs found and selections are not required; use counts to act in outer pairs.
45It can also act on multiple seletions (yay!). For example, to change every occurance of `(use)` to `[use]`:
47- `%` to select the whole file
48- `s` to split the selections on a search term
49- Input `use` and hit Enter
50- `mr([` to replace the parens with square brackets
52Multiple characters are currently not supported, but planned.
54## Textobjects
56Currently supported: `word`, `surround`, `function`, `class`, `parameter`.
58![textobject-demo](https://user-images.githubusercontent.com/23398472/124231131-81a4bb00-db2d-11eb-9d10-8e577ca7b177.gif)
59![textobject-treesitter-demo](https://user-images.githubusercontent.com/23398472/132537398-2a2e0a54-582b-44ab-a77f-eb818942203d.gif)
61- `ma` - Select around the object (`va` in vim, `<alt-a>` in kakoune)
62- `mi` - Select inside the object (`vi` in vim, `<alt-i>` in kakoune)
64| Key after `mi` or `ma` | Textobject selected |
65| --- | --- |
66| `w` | Word |
67| `W` | WORD |
68| `(`, `[`, `'`, etc | Specified surround pairs |
69| `f` | Function |
70| `c` | Class |
71| `p` | Parameter |
73Note: `f`, `c`, etc need a tree-sitter grammar active for the current
74document and a special tree-sitter query file to work properly. [Only
75some grammars](https://github.com/search?q=repo%3Ahelix-editor%2Fhelix+filename%3Atextobjects.scm&type=Code&ref=advsearch&l=&l=)
76currently have the query file implemented. Contributions are welcome !