Helix

https://docs.helix-editor.com/master
Admin
Helix is a post-modern text editor written in Rust that provides vim-like keybindings, language...
Tokens:35,423
Snippets:616
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Helix from source

Source: https://docs.helix-editor.com/master/print.html

Standard installation command for the Helix terminal editor.

```bash
cargo install --path helix-term --locked
```

--------------------------------

### Indentation Query Examples

Source: https://docs.helix-editor.com/master/print.html

Examples demonstrating how syntax tree nodes are captured to determine indentation levels during line insertion.

```rust
#![allow(unused)]
fn main() {
fn need_hero(some_hero: Hero, life: Life) -> {
    matches!(some_hero, Hero { // ←─────────────────╮
        strong: true,//←╮  ↑  ↑                     │
        fast: true,  // │  │  ╰── query start       │
        sure: true,  // │  ╰───── cursor            ├─ traversal 
        soon: true,  // ╰──────── new line inserted │  start node
    }) &&            //                             │
//  ↑                                               │
//  ╰───────────────────────────────────────────────╯
    some_hero > life
}
}
```

```rust
#![allow(unused)]
fn main() {
fn need_hero(some_hero: Hero, life: Life) -> { // ←─╮
    matches!(some_hero, Hero { // ←╮          ↑     │
        strong: true,//    ↑   ╭───╯          │     │
        fast: true,  //    │   │ query start ─╯     │
        sure: true,  //    ╰───┼ cursor             ├─ traversal
        soon: true,  //        ╰ new line inserted  │  start node
    }) &&            //                             │
    some_hero > life //                             │
} // ←──────────────────────────────────────────────╯
}
```

--------------------------------

### Install and Run Helix on Arch Linux

Source: https://docs.helix-editor.com/master/package-managers.html

Install Helix from the extra repository and check its health.

```bash
sudo pacman -S helix
```

```bash
helix --health
```

--------------------------------

### Install Helix via Snap

Source: https://docs.helix-editor.com/master/package-managers.html

Install Helix using the snap package manager with classic confinement.

```bash
snap install --classic helix
```

--------------------------------

### Cursor Placement Example

Source: https://docs.helix-editor.com/master/guides/indent.html

Demonstration of cursor placement within a return statement scope.

```python
class Hero:
    def __init__(self, strong, fast, sure, soon):
        self.is_strong = strong
        self.is_fast = fast
        self.is_sure = sure
        self.is_soon = soon

    def need_hero(self, life):
        return (
            self.is_strong
            and self.is_fast
            and self.is_sure
            and self.is_soon
            and self > life
        ) # ←─── cursor
    #←────────── where cursor should go on new line
```

--------------------------------

### Install and Run Helix via Flatpak

Source: https://docs.helix-editor.com/master/package-managers.html

Install and execute Helix using the Flatpak package manager.

```bash
flatpak install flathub com.helix_editor.Helix
flatpak run com.helix_editor.Helix
```

--------------------------------

### Install Helix with optimizations

Source: https://docs.helix-editor.com/master/print.html

Builds the editor with native CPU optimizations for improved performance.

```bash
cargo install \
   --profile opt \
   --config 'build.rustflags=["-C", "target-cpu=native"]' \
   --path helix-term \
   --locked
```

--------------------------------

### Highlight strings as bash in Nix

Source: https://docs.helix-editor.com/master/guides/injection.html

A simple query example that targets string expressions to be highlighted as bash.

```scm

__
((string_expression (string_fragment) @injection.content)
  (#set! injection.language "bash"))

```

--------------------------------

### Configure indent guides

Source: https://docs.helix-editor.com/master/editor.html

Sets the visual appearance and behavior of vertical indentation guides.

```toml

__
[editor.indent-guides]
render = true
character = "╎" # Some characters that work well: "▏", "┆", "┊", "⸽"
skip-levels = 1
```

--------------------------------

### Install Helix on Windows

Source: https://docs.helix-editor.com/master/package-managers.html

Commands to install Helix on Windows using various package managers.

```bash
winget install Helix.Helix
```

```bash
scoop install helix
```

```bash
choco install helix
```

```bash
packl install helix
```

```bash
pacman -S mingw-w64-ucrt-x86_64-helix
```

--------------------------------

### Install cargo-deb

Source: https://docs.helix-editor.com/master/building-from-source.html

Installs the cargo-deb utility required for packaging Helix as a .deb file.

```bash
cargo install cargo-deb
```

--------------------------------

### Unicode and Shell Expansions

Source: https://docs.helix-editor.com/master/command-line.html

Examples of using Unicode codepoints and shell commands for calculations.

```text
:echo %u{25CF}
:echo %sh{echo "20 * 5" | bc}
%sh{echo '%{buffer_name}:%{cursor_line}'}
```

--------------------------------

### Install Desktop Integration Files

Source: https://docs.helix-editor.com/master/building-from-source.html

Copies the desktop entry and icon files to local user directories to enable Helix in the application menu.

```bash
cp contrib/Helix.desktop ~/.local/share/applications
cp contrib/helix.png ~/.icons # or ~/.local/share/icons
```

--------------------------------

### YAML Indentation Example

Source: https://docs.helix-editor.com/master/print.html

Example of YAML structure used to demonstrate indentation behavior.

```yaml
  - foo: bar
```

--------------------------------

### Install Helix on Debian

Source: https://docs.helix-editor.com/master/package-managers.html

Use the apt package manager to install Helix on Debian systems.

```bash
sudo apt install hx
```

--------------------------------

### Basic Indentation Query Syntax

Source: https://docs.helix-editor.com/master/print.html

A simple query example showing how to apply @indent and @outdent to specific syntax nodes.

```scheme
((block) @indent)
["}" ")"] @outdent
```

--------------------------------

### Run Helix health check

Source: https://docs.helix-editor.com/master/building-from-source.html

Verify the installation and configuration.

```bash
hx --health
```

--------------------------------

### Configure Buffer Picker Start Position

Source: https://docs.helix-editor.com/master/editor.html

Set the initial selection behavior for the buffer picker in the editor configuration.

```toml
[editor.buffer-picker]
start-position = "previous"
```

--------------------------------

### Example function call syntax

Source: https://docs.helix-editor.com/master/syntax-aware-motions.html

A standard function call structure used to demonstrate syntax tree navigation.

```text
func(arg1, arg2, arg3);
```

--------------------------------

### Install and Configure Helix AppImage

Source: https://docs.helix-editor.com/master/package-managers.html

Commands to make the AppImage executable and optionally move it to a local binary directory.

```bash
chmod +x helix-*.AppImage # change permission for executable mode
./helix-*.AppImage # run helix
```

```bash
mkdir -p "$HOME/.local/bin"
mv helix-*.AppImage "$HOME/.local/bin/hx"
```

--------------------------------

### Install Helix on Fedora/RHEL

Source: https://docs.helix-editor.com/master/package-managers.html

Use the dnf package manager to install Helix on Fedora or RHEL systems.

```bash
sudo dnf install helix
```

--------------------------------

### Install Helix on macOS via MacPorts

Source: https://docs.helix-editor.com/master/package-managers.html

Install Helix using the MacPorts package manager.

```bash
sudo port install helix
```

--------------------------------

### Indentation and Outdentation Example

Source: https://docs.helix-editor.com/master/guides/indent.html

Demonstrates how @indent and @outdent captures affect block nesting levels.

```rust
__
#![allow(unused)]
fn main() {
fn shout(things: Vec<Thing>) {
    //                       ↑
    //                       ├───────────────────────╮ indent level
    //                    @indent                    ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄
    //                                               │
    let it_all = |out| { things.filter(|thing| { //  │      1
    //                 ↑                       ↑     │
    //                 ├───────────────────────┼─────┼┄┄┄┄┄┄┄┄┄┄┄┄┄┄
    //              @indent                 @indent  │
    //                                               │      2
        thing.can_do_with(out) //                    │
    })}; //                                          ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄
  //↑↑↑                                              │      1
} //╰┼┴──────────────────────────────────────────────┴┄┄┄┄┄┄┄┄┄┄┄┄┄┄
// 3x @outdent
}
```

```scheme
__
((block) @indent)
["}" ")"] @outdent
```

--------------------------------

### View syntax tree structure

Source: https://docs.helix-editor.com/master/guides/rainbow_bracket_queries.html

An example of an HTML element syntax tree structure.

```scm
(element                   ; <a>link</a>
  (start_tag               ; <a>
    (tag_name))            ; a
  (text)                   ; link
  (end_tag                 ; </a>
    (tag_name)))           ; a
```

--------------------------------

### Register Expansion

Source: https://docs.helix-editor.com/master/command-line.html

Example of retrieving content from a register using the %reg expansion.

```text
:set-register a hello world
echo %reg{a}
```

--------------------------------

### Configure Git Blame Keybinding

Source: https://docs.helix-editor.com/master/command-line.html

Example of mapping a key to display git blame information using a shell expansion.

```toml
__
[keys.normal]
# Print the current line's git blame information to the statusline.
space.B = ":echo %sh{git blame -L %{cursor_line},+1 %{buffer_name}}"
```

--------------------------------

### Install Helix on macOS via Homebrew

Source: https://docs.helix-editor.com/master/package-managers.html

Install either the latest release or the latest nightly version of Helix using Homebrew.

```bash
brew install helix
```

```bash
brew install --HEAD helix
```

--------------------------------

### Configure language settings in languages.toml

Source: https://docs.helix-editor.com/master/languages.html

Example of defining a language server and overriding default language settings like auto-formatting.

```toml
# in <config_dir>/helix/languages.toml

[language-server.mylang-lsp]
command = "mylang-lsp"

[[language]]
name = "rust"
auto-format = false
```

--------------------------------

### YAML indentation example

Source: https://docs.helix-editor.com/master/guides/indent.html

Example of YAML structure where multiple indentation levels occur on the same line.

```yaml
  - foo: bar
# ↑ ↑
# │ ╰─────────────── start of map
# ╰───────────────── start of list element
    baz: quux # ←─── cursor
    # ←───────────── where the cursor should go on a new line
    garply: waldo
  - quux:
      bar: baz
    xyzzy: thud
    fred: plugh
```

--------------------------------

### Method Chain Indentation Example

Source: https://docs.helix-editor.com/master/print.html

Demonstrates how method chains are flattened by collapsing multiple scopes that open on the same line.

```rust
#![allow(unused)]
fn main() {
let x = thing       // ← chain opens here
    .foo()          // each link aligned one level in,
    .bar()          // not progressively deeper
    .baz();
}
```

```scheme
(call_expression) @indent
```

--------------------------------

### Example tree-sitter grammar definition

Source: https://docs.helix-editor.com/master/guides/rainbow_bracket_queries.html

An example of how brackets are defined as literal strings in tree-sitter grammars.

```javascript
{
  // ...
  arguments: $ => seq("(", repeat($.argument), ")"),
  // ...
}
```

--------------------------------

### Define Helix editor configuration in TOML

Source: https://docs.helix-editor.com/master/configuration.html

Example configuration file demonstrating theme selection, editor settings, cursor shapes, and file picker behavior.

```toml
theme = "onedark"

[editor]
line-number = "relative"
mouse = false

[editor.cursor-shape]
insert = "bar"
normal = "block"
select = "underline"

[editor.file-picker]
hidden = false
```

--------------------------------

### Python Class Example

Source: https://docs.helix-editor.com/master/guides/indent.html

Example of a Python class structure used to demonstrate indentation traversal issues.

```python
class Hero:
    def __init__(self, strong, fast, sure, soon):#  ←─╮
        self.is_strong = strong #                     │
        self.is_fast = fast     # ╭─── query start    │
        self.is_sure = sure     # │ ╭─ cursor         │
        self.is_soon = soon     # │ │                 │
        #     ↑            ↑      │ │                 │
        #     │            ╰──────╯ │                 │
        #     ╰─────────────────────╯                 │
        #                                             ├─ traversal
    def need_hero(self, life):         #              │  start node
        return (                       #              │
            self.is_strong             #              │
            and self.is_fast           #              │
            and self.is_sure           #              │
            and self.is_soon           #              │
            and self > life            #              │
        ) # ←─────────────────────────────────────────╯
```

--------------------------------

### Example of inline diagnostics

Source: https://docs.helix-editor.com/master/print.html

Visual representation of how diagnostics appear within the text.

```rust
fn main() {
  let foo = bar;
            └─ no such value in this scope
}
```

--------------------------------

### Define typescript language server entry

Source: https://docs.helix-editor.com/master/print.html

Example entry for the typescript language server configuration.

```toml
[language-server.typescript-language-server]
```

--------------------------------

### Configure the statusline in Helix

Source: https://docs.helix-editor.com/master/editor.html

Example configuration for the statusline, defining elements for the left, center, and right sections, as well as custom mode labels and diagnostic settings.

```toml
[editor.statusline]
left = ["mode", "spinner"]
center = ["file-name"]
right = ["diagnostics", "selections", "position", "file-encoding", "file-line-ending", "file-type"]
separator = "│"
mode.normal = "NORMAL"
mode.insert = "INSERT"
mode.select = "SELECT"
diagnostics = ["warning", "error"]
workspace-diagnostics = ["warning", "error"]
```

--------------------------------

### Access Helix Tutor

Source: https://docs.helix-editor.com/master/print.html

Commands to launch the interactive tutorial for learning Helix.

```text
hx --tutor
```

```text
:tutor
```

--------------------------------

### Execute shell command with expansions

Source: https://docs.helix-editor.com/master/command-line.html

Demonstrates passing expanded buffer and cursor information to a shell command.

```shell
:sh echo "%{buffer_name}:%{cursor_column}"
```

--------------------------------

### Build Helix from Source

Source: https://docs.helix-editor.com/master/print.html

Environment configuration and build commands for compiling Helix from source.

```bash
RUSTFLAGS="-C target-feature=-crt-static"
```

```bash
git clone https://github.com/helix-editor/helix
cd helix
```

```bash
cargo install --path helix-term --features "embed-grammars"
```

--------------------------------

### Cycle through string configuration values

Source: https://docs.helix-editor.com/master/command-line.html

Cycles through a list of string values for a configuration option.

```shell
:toggle-option indent-heuristic hybrid tree-sitter simple
```

--------------------------------

### Build Debian package from source

Source: https://docs.helix-editor.com/master/print.html

Instructions for building a custom .deb package to resolve libc version mismatches.

```bash
cargo install cargo-deb
```

```bash
cargo deb -- --locked
```

--------------------------------

### Clone the Helix repository

Source: https://docs.helix-editor.com/master/building-from-source.html

Initial steps to download the source code.

```bash
git clone https://github.com/helix-editor/helix
cd helix
```

--------------------------------

### Configure runtime directory on Linux/macOS

Source: https://docs.helix-editor.com/master/building-from-source.html

Methods to point Helix to the runtime files.

```bash
export HELIX_RUNTIME=~/src/helix/runtime
```

```bash
ln -Tsf $PWD/runtime ~/.config/helix/runtime
```

--------------------------------

### Extended Traversal Example

Source: https://docs.helix-editor.com/master/guides/indent.html

Visual representation of how @extend affects node traversal in Python.

```python
class Hero:
    def __init__(self, strong, fast, sure, soon):#  ←─╮
        self.is_strong = strong #                     │
        self.is_fast = fast     # ╭─── query start    ├─ traversal
        self.is_sure = sure     # │ ╭─ cursor         │  start node
        self.is_soon = soon     # │ │ ←───────────────╯
        #     ↑            ↑      │ │                 
        #     │            ╰──────╯ │
        #     ╰─────────────────────╯
    def need_hero(self, life):
        return (
            self.is_strong
            and self.is_fast
            and self.is_sure
            and self.is_soon
            and self > life
        )
```

--------------------------------

### Build Debian Package

Source: https://docs.helix-editor.com/master/building-from-source.html

Builds the release binary and packages it into a .deb file using the configured build profile.

```bash
cargo deb -- --locked
```

--------------------------------

### Compile Helix from source

Source: https://docs.helix-editor.com/master/building-from-source.html

Commands to build the hx executable and construct grammars.

```bash
# Reproducible
cargo install --path helix-term --locked
```

```bash
# Optimized
cargo install \
   --profile opt \
   --config 'build.rustflags=["-C", "target-cpu=native"]' \
   --path helix-term \
   --locked
```

--------------------------------

### Display Cursor Line Number

Source: https://docs.helix-editor.com/master/command-line.html

Example of using the cursor_line variable to print the current line number to the statusline.

```text
:echo %{cursor_line}
```

--------------------------------

### Cargo Deb Dependency Warning

Source: https://docs.helix-editor.com/master/building-from-source.html

Example of a non-critical warning message displayed by cargo-deb regarding dependency specification.

```text
warning: Failed to find dependency specification
```

--------------------------------

### Configure Smart-Tab Keybindings

Source: https://docs.helix-editor.com/master/editor.html

Set custom keybindings for smart-tab navigation in normal, insert, and select modes.

```toml
[keys.normal]
tab = "move_parent_node_end"
S-tab = "move_parent_node_start"

[keys.insert]
S-tab = "move_parent_node_start"

[keys.select]
tab = "extend_parent_node_end"
S-tab = "extend_parent_node_start"
```

--------------------------------

### Parent node expansion with Alt-o

Source: https://docs.helix-editor.com/master/syntax-aware-motions.html

Demonstrates how Alt-o expands the current selection to the parent node.

```text
func[(arg1, arg2, arg3)];
```

--------------------------------

### Highlight comments as dedicated comment language

Source: https://docs.helix-editor.com/master/guides/injection.html

A query example that highlights comment nodes using the dedicated comment language.

```scm

__
((comment) @injection.content
  (#set! injection.language "comment"))

```

--------------------------------

### Indentation traversal for 'o' command

Source: https://docs.helix-editor.com/master/guides/indent.html

Illustrates the query start position and traversal scope when inserting a new line below the cursor using the 'o' command.

```rust
#![allow(unused)]
fn main() {
fn need_hero(some_hero: Hero, life: Life) -> {
    matches!(some_hero, Hero { // ←─────────────────╮
        strong: true,//←╮  ↑  ↑                     │
        fast: true,  // │  │  ╰── query start       │
        sure: true,  // │  ╰───── cursor            ├─ traversal 
        soon: true,  // ╰──────── new line inserted │  start node
    }) &&            //                             │
//  ↑                                               │
//  ╰───────────────────────────────────────────────╯
    some_hero > life
}
}
```

--------------------------------

### Build Helix with cargo deb

Source: https://docs.helix-editor.com/master/print.html

Instructions for packaging Helix using cargo deb while maintaining the release profile.

```bash
cargo deb --no-build
```

--------------------------------

### Configure runtime directory on Windows

Source: https://docs.helix-editor.com/master/building-from-source.html

Methods to set the runtime path on Windows systems.

```batch
setx HELIX_RUNTIME "%userprofile%\src\helix\runtime"
```

--------------------------------

### Disable Insert Mode Navigation Keys

Source: https://docs.helix-editor.com/master/keymap.html

Example configuration to disable default arrow key navigation in insert mode by mapping them to no_op in config.toml.

```toml
[keys.insert]
up = "no_op"
down = "no_op"
left = "no_op"
right = "no_op"
pageup = "no_op"
pagedown = "no_op"
home = "no_op"
end = "no_op"
```

--------------------------------

### Indentation traversal for 'O' command

Source: https://docs.helix-editor.com/master/guides/indent.html

Illustrates the query start position and traversal scope when inserting a new line at the current cursor position using the 'O' command.

```rust
#![allow(unused)]
fn main() {
fn need_hero(some_hero: Hero, life: Life) -> { // ←─╮
    matches!(some_hero, Hero { // ←╮          ↑     │
        strong: true,//    ↑   ╭───╯          │     │
        fast: true,  //    │   │ query start ─╯     │
        sure: true,  //    ╰───┼ cursor             ├─ traversal
        soon: true,  //        ╰ new line inserted  │  start node
    }) &&            //                             │
    some_hero > life //                             │
} // ←──────────────────────────────────────────────╯
}
```

--------------------------------

### Toggle configuration with duplicate values

Source: https://docs.helix-editor.com/master/command-line.html

Demonstrates that duplicate values are ignored when cycling through options.

```shell
:toggle-option indent-heuristic hybrid simple tree-sitter simple
```

--------------------------------

### Configure formatter command line arguments

Source: https://docs.helix-editor.com/master/languages.html

Use the %{buffer_name} variable to pass the current file path to a formatter command.

```toml
formatter = { command = "mylang-formatter" , args = ["--stdin", "--stdin-filename", "%{buffer_name}"] }
```

--------------------------------

### Configure code actions on save

Source: https://docs.helix-editor.com/master/languages.html

Specify a list of LSP code actions to execute automatically when a buffer is saved for specific languages.

```toml
# Python with ruff
[[language]]
name = "python"
code-actions-on-save = ["source.organizeImports", "source.fixAll"]

# TS/JS with tsserver
[[language]]
name = "typescript"
code-actions-on-save = ["source.addMissingImports.ts"]

# TS/JS with eslint
[[language]]
name = "javascript"
code-actions-on-save = ["source.fixAll.eslint", "source.organizeImports"]
```

--------------------------------

### Configure Git Blame Keybinding

Source: https://docs.helix-editor.com/master/print.html

Maps a keybinding to display git blame information for the current line in the statusline.

```toml
[keys.normal]
# Print the current line's git blame information to the statusline.
space.B = ":echo %sh{git blame -L %{cursor_line},+1 %{buffer_name}}"
```

--------------------------------

### Configure Language Server and Rust Formatting

Source: https://docs.helix-editor.com/master/print.html

Define a language server command and disable auto-formatting for Rust in the global configuration.

```toml
[language-server.mylang-lsp]
command = "mylang-lsp"

[[language]]
name = "rust"
auto-format = false
```

--------------------------------

### Configure rainbow bracket highlighting

Source: https://docs.helix-editor.com/master/themes.html

Define a list of styles for rainbow bracket matching using the rainbow key.

```toml

__
rainbow = ["#ff0000", "#ffa500", "#fff000", { fg = "#00ff00", modifiers = ["bold"] }]

```

--------------------------------

### Configure runtime directory on Windows

Source: https://docs.helix-editor.com/master/print.html

Methods to point Helix to its runtime files on Windows systems.

```cmd
setx HELIX_RUNTIME "%userprofile%\src\helix\runtime"
```

```powershell
New-Item -ItemType Junction -Target "runtime" -Path "$Env:AppData\helix\runtime"
```

```cmd
cd %appdata%\helix
mklink /D runtime "%userprofile%\src\helix\runtime"
```

--------------------------------

### Configure desktop integration

Source: https://docs.helix-editor.com/master/print.html

Commands to register Helix in the application menu and update desktop file paths.

```bash
cp contrib/Helix.desktop ~/.local/share/applications
cp contrib/helix.png ~/.icons # or ~/.local/share/icons
```

```bash
sed -i -e "s|Exec=hx %F|Exec=$(readlink -f ~/.cargo/bin/hx) %F|g" \
  -e "s|Icon=helix|Icon=$(readlink -f ~/.icons/helix.png)|g" ~/.local/share/applications/Helix.desktop
```

```bash
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
```
Tokens:
Raw