aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-04-14 00:02:03 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-04-14 00:02:03 +0300
commit5ae1cea94bcd77c8a75abfbe6c996e5cf2a91ab7 (patch)
treed66c8c7026208be254a3874a9bb1c7a9aae47a99 /README.md
parent37d52729100e9ed1e42ee71941899be79929cfd3 (diff)
docs add custom command keybind docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 14a864be..7a29a1d9 100644
--- a/README.md
+++ b/README.md
@@ -209,6 +209,8 @@ common defaults:
optional direct bindings are available but **unset by default**. you can bind workspace, tab, and pane switching directly in terminal mode without going through the prefix first.
+prefix mode also supports custom commands with `[[keys.command]]`. that lets you launch detached shell helpers or temporary overlay panes. two common examples are opening `lazygit` in a pane and running your own script with the active herdr ids and cwd.
+
example:
```toml
@@ -221,6 +223,15 @@ focus_pane_left = "alt+h"
focus_pane_down = "alt+j"
focus_pane_up = "alt+k"
focus_pane_right = "alt+l"
+
+[[keys.command]]
+key = "g"
+type = "pane"
+command = "lazygit"
+
+[[keys.command]]
+key = "o"
+command = "~/bin/herdr-open-current \"$HERDR_ACTIVE_WORKSPACE_ID\" \"$HERDR_ACTIVE_TAB_ID\" \"$HERDR_ACTIVE_PANE_ID\" \"$HERDR_ACTIVE_PANE_CWD\""
```
full keybinding and config reference: [`CONFIGURATION.md`](./CONFIGURATION.md)