diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-20 23:08:43 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-20 23:08:43 +0300 |
| commit | 43afaab582fd5e1428c51ecdbf6770d8e3917de6 (patch) | |
| tree | 0331505b04e5ca16a0bd1c2b2e108fef0bc6e5a8 /website/src/content | |
| parent | df357b250c0fcf4edf2681d4f114e199afb51899 (diff) | |
docs: finalize release docs
Diffstat (limited to 'website/src/content')
| -rw-r--r-- | website/src/content/docs/agents.mdx | 1 | ||||
| -rw-r--r-- | website/src/content/docs/concepts.mdx | 6 | ||||
| -rw-r--r-- | website/src/content/docs/configuration.mdx | 99 | ||||
| -rw-r--r-- | website/src/content/docs/integrations.mdx | 2 | ||||
| -rw-r--r-- | website/src/content/docs/quick-start.mdx | 16 |
5 files changed, 74 insertions, 50 deletions
diff --git a/website/src/content/docs/agents.mdx b/website/src/content/docs/agents.mdx index dfa2f204..f1499021 100644 --- a/website/src/content/docs/agents.mdx +++ b/website/src/content/docs/agents.mdx @@ -19,6 +19,7 @@ Automatic detection works out of the box for common coding agents. | OpenCode | yes | yes | yes | | Grok CLI | yes | yes | yes | | Hermes Agent | yes | yes | yes | +| Kiro CLI | yes | yes | no | | GitHub Copilot CLI | yes | yes | yes | Detected but less thoroughly tested: Gemini CLI, Cursor Agent, Cline, and Kimi. diff --git a/website/src/content/docs/concepts.mdx b/website/src/content/docs/concepts.mdx index ea77ac20..b1a7908f 100644 --- a/website/src/content/docs/concepts.mdx +++ b/website/src/content/docs/concepts.mdx @@ -67,11 +67,11 @@ herdr server stop ## Modes -Herdr has terminal mode and navigate mode. +Herdr has terminal mode, prefix mode, and navigate mode. -Terminal mode sends keys to the focused pane. Navigate mode sends keys to Herdr. +Terminal mode sends keys to the focused pane. Prefix mode waits for one Herdr action after the prefix key. Navigate mode is the persistent workspace navigation surface. -Press the prefix key, default `ctrl+b`, to enter navigate mode. Use navigate mode to create workspaces, split panes, switch tabs, resize, open menus, or detach. +Press the prefix key, default `ctrl+b`, then an action key such as `c` for a new tab or `w` for workspace navigation. ## Mouse UI diff --git a/website/src/content/docs/configuration.mdx b/website/src/content/docs/configuration.mdx index 558f01f1..9df7e41d 100644 --- a/website/src/content/docs/configuration.mdx +++ b/website/src/content/docs/configuration.mdx @@ -27,7 +27,7 @@ herdr --default-config > ~/.config/herdr/config.toml If a config value is invalid, Herdr falls back to a safe default and shows a startup warning. -Herdr shows first-run notification setup when `onboarding` is missing or true. Set it when you want to skip that flow after choosing your notification settings. +Herdr shows first-run setup when `onboarding` is missing or true. Continuing from onboarding writes `onboarding = false` and opens settings on the integrations tab. Set it when you want to skip that flow after setup. ```toml onboarding = false @@ -45,74 +45,93 @@ You can also open the global menu in Herdr and choose `reload config`. Reload applies most UI settings without restarting panes. Startup-only settings still need a restart. +## Default shell + +Set the executable Herdr uses for newly created interactive panes: + +```toml +[terminal] +default_shell = "nu" +``` + +When unset or empty, Herdr uses `$SHELL`, then `/bin/sh`. This is an executable name or path, not a shell command line. Existing panes keep their current shell until they are recreated. Command panes still run through `/bin/sh -c`; detached custom command keybindings use Herdr's existing `/bin/sh -lc` path. + ## Keybindings -Herdr has a prefix mode similar to tmux. The default prefix is `ctrl+b`. +Herdr has a prefix mode similar to tmux. The default prefix is `ctrl+b`. Keybinding strings are explicit: `prefix+n` means press the configured prefix and then `n`; `ctrl+alt+n` is a direct terminal-mode shortcut. A small keybinding override looks like this: ```toml [keys] prefix = "ctrl+b" -new_workspace = "n" -rename_workspace = "shift+n" -close_workspace = "shift+d" -new_tab = "c" -split_vertical = "v" -split_horizontal = "-" -close_pane = "x" -zoom = "f" -resize_mode = "r" -toggle_sidebar = "b" +new_tab = "prefix+c" +next_tab = "prefix+n" +previous_tab = "prefix+p" +focus_pane_left = "prefix+h" +split_horizontal = "prefix+minus" ``` -Optional actions are unset by default. Bind them when you want direct shortcuts: +The default keymap is prefix-first and avoids direct shortcuts that can steal input from shells, editors, tmux, or terminal apps. Common defaults include: ```toml [keys] -detach = "q" -reload_config = "R" -open_notification_target = "o" -previous_workspace = "H" -next_workspace = "L" -previous_agent = "A" -next_agent = "D" -previous_tab = "J" -next_tab = "K" -rename_tab = "T" -close_tab = "W" -rename_pane = "p" -edit_scrollback = "e" -focus_pane_left = "h" -focus_pane_down = "j" -focus_pane_up = "k" -focus_pane_right = "l" +detach = "prefix+q" +workspace_picker = "prefix+w" +new_workspace = "prefix+shift+n" +rename_workspace = "prefix+shift+w" +close_workspace = "prefix+shift+d" +new_tab = "prefix+c" +previous_tab = "prefix+p" +next_tab = "prefix+n" +switch_tab = "prefix+1..9" +rename_tab = "prefix+shift+t" +close_tab = "prefix+shift+x" +focus_pane_left = "prefix+h" +focus_pane_down = "prefix+j" +focus_pane_up = "prefix+k" +focus_pane_right = "prefix+l" +split_vertical = "prefix+v" +split_horizontal = "prefix+minus" +close_pane = "prefix+x" +zoom = "prefix+z" +resize_mode = "prefix+r" +toggle_sidebar = "prefix+b" ``` -Use the full default config to see every available action. +Optional actions are unset by default. Bind them with `prefix+` for prefix-mode behavior, or with an explicit modified chord when you intentionally want a direct shortcut: -Key strings accept plain keys, modifier combinations such as `ctrl+a`, `shift+n`, `alt+1`, `cmd+k`, and special keys such as `enter`, `tab`, `esc`, `left`, `right`, `up`, and `down`. Plain keys, `ctrl+letter`, Escape, Tab, Enter, and function keys are the most reliable. Alt, Cmd/Super, and punctuation with modifiers depend on your terminal and tmux settings. +```toml +[keys] +previous_workspace = "prefix+shift+left" +next_workspace = "prefix+shift+right" +next_tab = ["prefix+n", "ctrl+alt+]"] +``` + +Key strings accept plain keys, modifier combinations such as `ctrl+a`, `shift+n`, `alt+1`, `cmd+k`, and special keys such as `enter`, `tab`, `esc`, `left`, `right`, `up`, and `down`. Named punctuation such as `minus`, `comma`, `ampersand`, `plus`, and `backtick` is also accepted. Plain direct printable keys such as `n` are unsafe because they intercept typing; use `prefix+n` unless you intentionally want a direct binding. Alt, Cmd/Super, and punctuation with modifiers depend on your terminal and tmux settings. + +If you have old custom keybindings and want the new defaults, run `herdr config reset-keys`. Herdr backs up `config.toml`, removes `[keys]` and `[[keys.command]]`, and uses built-in v2 defaults after restart or `herdr server reload-config`. ## Indexed jumps -Indexed keybindings let you jump directly to visible positions. +Indexed keybindings use `1..9` in normal keybinding fields: ```toml -[keys.indexed] -workspaces = "ctrl+shift" -tabs = "ctrl" -agents = "alt" +[keys] +switch_tab = "prefix+1..9" +switch_workspace = "prefix+shift+1..9" +focus_agent = "prefix+alt+1..9" ``` -These expand over number keys 1 through 9. For example, `tabs = "ctrl"` makes `ctrl+1` through `ctrl+9` switch tabs. +The legacy `[keys.indexed]` table is still parsed for compatibility, but new configs should prefer the explicit action fields. ## Custom command keybindings -Custom prefix-mode commands can run shell helpers from inside Herdr. +Custom commands use the same keybinding syntax. ```toml [[keys.command]] -key = "g" +key = "prefix+g" type = "pane" command = "lazygit" ``` diff --git a/website/src/content/docs/integrations.mdx b/website/src/content/docs/integrations.mdx index 8303d142..18b759bc 100644 --- a/website/src/content/docs/integrations.mdx +++ b/website/src/content/docs/integrations.mdx @@ -9,6 +9,8 @@ Use integrations when you want reliable `working`, `blocked`, `idle`, and `done` ## Install integrations +Open settings inside Herdr and use the integrations tab to install recommended integrations for agents found on your `PATH`, or run commands manually: + ```bash herdr integration install pi herdr integration install claude diff --git a/website/src/content/docs/quick-start.mdx b/website/src/content/docs/quick-start.mdx index fddef6b8..f56048b9 100644 --- a/website/src/content/docs/quick-start.mdx +++ b/website/src/content/docs/quick-start.mdx @@ -29,19 +29,21 @@ pi Herdr detects supported agents automatically. The sidebar shows whether each agent is `working`, `blocked`, `done`, or `idle`. -## Navigate +## Keyboard control -Press `ctrl+b` to enter navigate mode. +Press `ctrl+b` to enter prefix mode, then press an action key. Common actions: | Action | Key | | --- | --- | -| Split right | `v` | -| Split down | `-` | -| New tab | `c` | -| New workspace | `n` | -| Detach client | `q` | +| Split right | `prefix+v` | +| Split down | `prefix+minus` | +| New tab | `prefix+c` | +| Next / previous tab | `prefix+n` / `prefix+p` | +| Workspace navigation | `prefix+w` | +| New workspace | `prefix+shift+n` | +| Detach client | `prefix+q` | After detaching, run `herdr` again to reattach to the same session. |
