diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-30 23:58:02 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-31 00:02:08 +0300 |
| commit | bdc189e32e7c9dd61811fe17e50ac171ca94c647 (patch) | |
| tree | 730e0e14d571e9bb693ad583b02e24622e4258d4 /docs | |
| parent | fc4e1bbf6b0fa2ec37445a5b72356514c7c6be6a (diff) | |
feat: support custom command descriptions
refs #362
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/next/CHANGELOG.md | 3 | ||||
| -rw-r--r-- | docs/next/website/src/content/docs/configuration.mdx | 3 |
2 files changed, 6 insertions, 0 deletions
diff --git a/docs/next/CHANGELOG.md b/docs/next/CHANGELOG.md index ec56a4b5..90e3e35c 100644 --- a/docs/next/CHANGELOG.md +++ b/docs/next/CHANGELOG.md @@ -2,6 +2,9 @@ ## Unreleased +### Added +- Custom command keybindings now accept an optional `description` field to provide user-defined descriptions shown in the keybind help panel instead of the default `'custom command'` label. (#362) + ### Fixed - The OpenCode integration no longer treats `session.created` or `session.updated` plugin events as idle signals, so active sessions stay marked working until OpenCode reports `session.status` or `session.idle`. (#351) - New interactive panes now use login-shell startup on macOS by default so Homebrew and other login PATH setup is available, with `terminal.shell_mode = "non_login"` as an opt-out. (#350) diff --git a/docs/next/website/src/content/docs/configuration.mdx b/docs/next/website/src/content/docs/configuration.mdx index 48a5a321..189e2121 100644 --- a/docs/next/website/src/content/docs/configuration.mdx +++ b/docs/next/website/src/content/docs/configuration.mdx @@ -189,12 +189,15 @@ Custom commands use the same keybinding syntax. key = "prefix+alt+g" type = "pane" command = "lazygit" +description = "run lazygit" ``` `type = "pane"` opens a temporary pane and closes it when the command exits. `type = "shell"` runs detached in the background. +An optional `description` can be provided. When specified, this description is displayed in the keybind help panel (opened with `prefix+?`) in place of the default `'custom command'` label. + Custom commands receive `HERDR_SOCKET_PATH`, `HERDR_BIN_PATH`, `HERDR_ACTIVE_WORKSPACE_ID`, `HERDR_ACTIVE_TAB_ID`, `HERDR_ACTIVE_PANE_ID`, and `HERDR_ACTIVE_PANE_CWD` when those values are available. Shell commands run from the focused pane's working directory when Herdr can detect it. ## Theme |