Colemak configs

[k4lizen]

Imo there isn't really a centralized place in the repo where one can find information about this so I'd like to create one here. The trouble with alternate keyboard layouts and modal editors is as old as time, particularly with what to do with hljk since they were chosen due to their position on qwerty rather than as a mneumonic.

Some discussion on this can be seen here: #10227
The main solutions that exist for colemak are:

1. Don't rebind hljk
2. Rebind them to HNEI
3. Rebind them to UNEI

The argument for not rebinding hljk is stronger when using vim, since it means logging into another computer (possibly remotely) and using vim (or vi, since they are always installed) will be painless. However it's hard to expect that a random computer you log in to will have helix installed, and if you can install it you can also bring your config with you. So imo it makes more sense with helix to rebind hljk. Especially nice is that it can be done without moving too much stuff around (when I was looking at vim solutions it looked much more painful).

The best rebind I found is this one: #10227 (comment) and I particularly like UNEI since I use colemak-dh and so H is not on the home row so there isn't much point to HNEI. Also UNEI just sort of feels right to me as it's similar to WASD and the arrow keys.

That comment doesn't give the whole story however since visual mode needs to be rebound as well. For the common pitfalls see #7700, #8906 and #11534.

In total these are my current bindings (that are relevant for colemak) (UNEI):

[keys.normal]
# -------------------------
# from @mattmc3 (https://github.com/helix-editor/helix/issues/5520#issuecomment-1386428351)
# QWERTY to Colemak remaps
# [JY] [LU] [UI] [..]
#  [..] [NJ] [EK] [IL]
#   [KN] [..] [..] [..]
# -------------------------
# N <=> K (K is in the QWERTY N position)
n = "move_char_left"
N = "keep_selections"
k = "search_next"
K = "search_prev"
# E <=> J (J now 'jumps words')
e = "move_line_down"
E = "join_selections"
j = "move_next_word_end"
J = "move_next_long_word_end"
# H <=> I (H is just a sideways I)
i = "move_char_right"
I = "no_op"
h = "insert_mode"
H = "insert_at_line_start"
# U <=> L (L is in the QWERTY U position)
u = "move_line_up"
U = "no_op"
l = "undo"
L = "redo"

[keys.select]
# -------------------------
# from @mattmc3 (https://github.com/helix-editor/helix/issues/5520#issuecomment-1386428351)
# QWERTY to Colemak remaps
# [JY] [LU] [UI] [..]
#  [..] [NJ] [EK] [IL]
#   [KN] [..] [..] [..]
# -------------------------
# N <=> K (K is in the QWERTY N position)
n = "extend_char_left"
N = "keep_selections"
k = "extend_search_next"
K = "extend_search_prev"
# E <=> J (J now 'jumps words')
e = "extend_visual_line_down"
E = "join_selections"
j = "extend_next_word_end"
J = "extend_next_long_word_end"
# H <=> I (H is just a sideways I)
i = "extend_char_right"
I = "no_op"
h = "insert_mode"
H = "insert_at_line_start"
# U <=> L (L is in the QWERTY U position)
u = "extend_visual_line_up"
U = "no_op"
l = "undo"
L = "redo"

Here are two other colemak configs: #10227 (comment), #10227 (comment).

Please share your (or others) solutions for using colemak(-dh) with helix, and config options related to this!

update:
The goto line end and goto line start bindings are gl and gh which are made with the hljk movement in mind, you can rebind those too (and gk, gj) if you want, here is how it would be done for UNEI:

# == Colemak (dh) UNEI goto minor modes (normal)
[keys.normal.g]
# gl (line end) <=> gi (implementation)
l = "goto_implementation"
i = "goto_line_end"
# gh (line start) <=> gn (next buffer)
h = "goto_next_buffer"
n = "goto_line_start"
# gj (down) <=> ge (last line)
j = "goto_last_line" 
e = "move_line_down"
# gk (up) => gu (no_op)
k = "no_op"
u = "move_line_up"

# == Colemak (dh) UNEI goto minor modes (select)
[keys.select.g]
# gl (line end) <=> gi (implementation)
l = "goto_implementation"
i = "goto_line_end"
# gh (line start) <=> gn (next buffer)
h = "goto_next_buffer"
n = "goto_line_start"
# gj (down) <=> ge (last line)
j = "goto_last_line" 
e = "extend_line_down"
# gk (up) => gu (no_op)
k = "no_op"
u = "extend_line_up"

[pascalkuthe]

I have a seperatw arrow key layer kn my keyboard so I use colmak-dh entirely without any remapping.

[k4lizen]

Oh interesting! Can I read somewhere how multiple layers like that work?

[sicher]

I do the same, with regular Colemak. I have a modifier under the right thumb and holding it gives me a layer with arrows on HNEI. I run qmk keyboards so it's easy to set up layers like that.

[k4lizen]

Under your right thumb? Does it not usually hover over the space bar?

[sicher]

Sort of... :) I type on Lily58 keyboards.

[humb1t]

Hello and thanks for the inspiration. I have corne choc split keyboard with following colemak dh mapping:

/*
 * Copyright (c) 2020 The ZMK Contributors
 *
 * SPDX-License-Identifier: MIT
 */

#include <behaviors.dtsi>
#include <dt-bindings/zmk/bt.h>
#include <dt-bindings/zmk/rgb.h>
#include <dt-bindings/zmk/ext_power.h>
#include <dt-bindings/zmk/keys.h>
#include <dt-bindings/zmk/pointing.h>

/ {
    chosen { zmk,underglow = &led_strip; };
};

&led_strip { chain-length = <42>; };

/ {
    behaviors {
        hml: homerow_mods_left {
            compatible = "zmk,behavior-hold-tap";
            label = "HOMEROW_MODS_LEFT_HAND";
            bindings = <&kp>, <&kp>;

            #binding-cells = <2>;
            tapping-term-ms = <280>;
            hold-trigger-key-positions = <6 18 30 39 40 7 8 9 10 11 19 20 21 22 23 31 32 33 34 35 41>;
            quick-tap-ms = <175>;
            require-prior-idle-ms = <150>;
            flavor = "tap-preferred";
        };

        hmr: homerow_mods_right {
            compatible = "zmk,behavior-hold-tap";
            label = "HOMEROW_MODS_RIGHT_HAND";
            bindings = <&kp>, <&kp>;

            #binding-cells = <2>;
            tapping-term-ms = <280>;
            hold-trigger-key-positions = <0 1 2 3 4 5 12 13 14 15 16 17 24 25 26 27 28 29 36 37 38>;
            quick-tap-ms = <175>;
            require-prior-idle-ms = <150>;
            flavor = "tap-preferred";
        };
    };

    combos { compatible = "zmk,combos"; };

    macros {
        left_word: left_word {
            compatible = "zmk,behavior-macro";
            #binding-cells = <0>;
            bindings = <&kp LC(LEFT)>;
            label = "LEFT_WORD";
        };

        right_word: right_word {
            compatible = "zmk,behavior-macro";
            #binding-cells = <0>;
            bindings = <&kp LC(RIGHT)>;
            label = "RIGHT_WORD";
        };
    };

    keymap {
        compatible = "zmk,keymap";

        alpha {
            display-name = "ALPHA";

            bindings = <
&kp ESC    &kp Q  &kp W  &kp F           &kp P         &kp B        &kp J      &kp L      &kp U      &kp Y    &kp SEMICOLON  &kp TAB
&kp LSHFT  &kp A  &kp R  &kp S           &kp T         &kp G        &kp M      &kp N      &kp E      &kp I    &kp O          &lt 3 SQT
&kp LCTRL  &kp Z  &kp X  &kp C           &kp D         &kp V        &kp K      &kp H      &kp SLASH  &kp DOT  &kp COMMA      &kp RSHFT
                         &lt 2 LEFT_ALT  &kp LEFT_GUI  &kp SPACE    &kp ENTER  &lt 1 DEL  &kp BSPC
            >;
        };

        num-nav {
            display-name = "NUM-NAV";

            bindings = <
&trans    &sk LEFT_ALT  &kp N7        &kp N8        &kp N9        &kp PRINTSCREEN    &trans  &left_word      &kp UP    &right_word  &kp PAGE_UP    &kp DELETE
&kp CAPS  &sk LSHFT     &kp NUMBER_4  &kp N5        &kp NUMBER_6  &kp N0             &trans  &kp LEFT_ARROW  &kp DOWN  &kp RIGHT    &kp INS        &trans
&trans    &sk LCTRL     &kp NUMBER_1  &kp NUMBER_2  &kp NUMBER_3  &trans             &trans  &kp HOME        &trans    &kp END      &kp PAGE_DOWN  &trans
                                      &trans        &trans        &trans             &trans  &trans          &trans
            >;
        };

        sym {
            display-name = "SYMBOLS";
            bindings = <
&trans  &kp DLLR  &kp AT          &kp EXCL          &kp PLUS       &kp PERCENT      &kp GRAVE  &kp SINGLE_QUOTE  &kp AMPS           &kp ASTRK        &kp EQUAL  &trans
&trans  &kp LPAR  &kp LEFT_BRACE  &kp LEFT_BRACKET  &kp LESS_THAN  &kp BACKSLASH    &kp SLASH  &kp GT            &kp RIGHT_BRACKET  &kp RIGHT_BRACE  &kp RPAR   &trans
&trans  &trans    &trans          &trans            &kp MINUS      &kp CARET        &kp HASH   &kp UNDER         &trans             &trans           &trans     &trans
                                  &trans            &trans         &trans           &trans     &trans            &trans
            >;
        };

        fun {
            display-name = "FUNCTIONS";
            bindings = <
&trans  &kp F12  &kp F7  &kp F8  &kp N9  &trans    &trans      &mkp LCLK     &mkp MCLK     &mkp RCLK     &trans        &ext_power EP_ON
&trans  &kp F11  &kp F4  &kp F5  &kp F6  &trans    &bt BT_CLR  &bt BT_SEL 0  &bt BT_SEL 1  &bt BT_SEL 2  &bt BT_SEL 3  &trans
&trans  &kp F10  &kp F1  &kp F2  &kp F3  &trans    &trans      &kp NUMBER_1  &kp NUMBER_2  &kp NUMBER_3  &trans        &bootloader
                         &trans  &trans  &trans    &trans      &trans        &trans
            >;

            label = "FUNCTION";
        };
    };

    conditional_layers { compatible = "zmk,conditional-layers"; };
};

and I made this helix bindings:

[keys.normal]
# navigation
n = "move_prev_word_start"
e = "page_cursor_half_down"
i = "move_next_word_start"
u = "page_cursor_half_up"
h = "search_next"
H = "search_prev"

# actions
l = "yank"
y = "undo"
Y = "redo"
m = "insert_mode"
M = "insert_at_line_start"
d = "change_selection"
t = "delete_selection"
E = "join_selections"

[keys.select]
# navigation
n = "move_prev_word_start"
e = "page_cursor_half_down"
i = "move_next_word_start"
u = "page_cursor_half_up"
h = "search_next"
H = "search_prev"

# actions
l = "yank"
y = "undo"
Y = "redo"
m = "insert_mode"
M = "insert_at_line_start"
d = "change_selection"
t = "delete_selection"
E = "join_selections"


[keys.insert]
C-w = "commit_undo_checkpoint"
C-k = "completion"
C-h = "insert_register"
C-n = "delete_word_backward"
C-i = "delete_word_forward"
C-m = "kill_to_line_start"
C-o = "kill_to_line_end"


# minor modes

[keys.normal.z]
f = "align_view_top"
s = "align_view_center"
S = "align_view_middle"
c = "align_view_bottom"
[keys.select.z]
f = "align_view_top"
s = "align_view_center"
S = "align_view_middle"
c = "align_view_bottom"

[keys.normal.g]
u = "goto_file_start"
e = "goto_last_line"
n = "goto_line_start"
i = "goto_line_end"
f = "goto_window_top"
s = "goto_window_center"
c = "goto_window_bottom"
# LSP
t = "goto_definition"
T = "goto_type_definition"
p = "goto_reference"
g = "goto_implementation"
# buffers
l = "goto_last_accessed_file"
L = "goto_last_modified_file"
h = "goto_next_buffer"
d = "goto_previous_buffer"
w = "goto_last_modification"
b = "goto_word"               #show labels for jump
# no op
j = "no_op"
k = "no_op"
[keys.select.g]
u = "goto_file_start"
e = "goto_last_line"
n = "goto_line_start"
i = "goto_line_end"
f = "goto_window_top"
s = "goto_window_center"
c = "goto_window_bottom"
# LSP
t = "goto_definition"
T = "goto_type_definition"
p = "goto_reference"
g = "goto_implementation"
# buffers
l = "goto_last_accessed_file"
L = "goto_last_modified_file"
h = "goto_next_buffer"
d = "goto_previous_buffer"
w = "goto_last_modification"
b = "goto_word"               #show labels for jump
# no op
j = "no_op"
k = "no_op"

[keys.normal.b] # ex m
n = "match_brackets"
m = "surround_add"
r = "surround_replace"
t = "surround_delete"
u = "select_textobject_around"
e = "select_textobject_inner"
[keys.select.b]
n = "match_brackets"
m = "surround_add"
r = "surround_replace"
t = "surround_delete"
u = "select_textobject_around"
e = "select_textobject_inner"

[keys.normal.C-w]
s = "vsplit"
t = "hsplit"
n = "jump_view_left"
e = "jump_view_down"
u = "jump_view_up"
i = "jump_view_right"
j = "wonly"
N = "swap_view_left"
E = "swap_view_down"
U = "swap_view_up"
I = "swap_view_right"
[keys.select.C-w]
s = "vsplit"
t = "hsplit"
n = "jump_view_left"
e = "jump_view_down"
u = "jump_view_up"
i = "jump_view_right"
j = "wonly"
N = "swap_view_left"
E = "swap_view_down"
U = "swap_view_up"
I = "swap_view_right"

[keys.normal.space]
t = "file_picker_in_current_directory"
T = "file_picker"
g = "buffer_picker"
G = "jumplist_picker"
C-g = "changed_file_picker"
"'" = "last_picker"
"/" = "global_search"
"," = "command_palette"
# LSP
d = "hover"
s = "symbol_picker"
S = "workspace_symbol_picker"
r = "diagnostics_picker"
R = "workspace_diagnostics_picker"
b = "rename_symbol"
a = "code_action"
f = "select_references_to_symbol_under_cursor"
# comments
j = "toggle_comments"
J = "toggle_block_comments"
C-j = "toggle_line_comments"
# clipboard
l = "yank_to_clipboard"
L = "yank_main_selection_to_clipboard"
B = "replace_selections_with_clipboard"
# ";" = "debug" # experimental
[keys.select.space]
t = "file_picker_in_current_directory"
T = "file_picker"
g = "buffer_picker"
G = "jumplist_picker"
C-g = "changed_file_picker"
"'" = "last_picker"
"/" = "global_search"
"," = "command_palette"
# LSP
d = "hover"
s = "symbol_picker"
S = "workspace_symbol_picker"
r = "diagnostics_picker"
R = "workspace_diagnostics_picker"
b = "rename_symbol"
a = "code_action"
f = "select_references_to_symbol_under_cursor"
# comments
j = "toggle_comments"
J = "toggle_block_comments"
C-j = "toggle_line_comments"
# clipboard
l = "yank_to_clipboard"
L = "yank_main_selection_to_clipboard"
B = "replace_selections_with_clipboard"
# ";" = "debug" # experimental

# unimpaired
[keys.normal."["]
h = "goto_prev_diag"
H = "goto_first_diag"
[keys.normal."]"]
h = "goto_next_diag"
H = "goto_last_diag"

[seungjin]

I am a colemak user.
I personally do not trust homerow keys to navigate.
Instead I use

l = "move_line_up"
h = "move_line_down"
n = "move_char_right"
k = "move_char_left"
j = "search_next"

When you see your fingers and its position, this is more natural.
Most of us have longer middle finger than index finger.

[hotemetoot]

Thanks so much for sharing. I copied your setup with a small change using k/n for moving down/up which means h and l don't have to be changed.
k = "move_line_down"
n = "move_line_up"
j = "search_next"

[seungjin]

I give a shot for that.

[seungjin]

@hotemetoot
Yours has a less modification - only 3 chars but I have little big hands and with my key combinations, setting lhnkj is much convenient.