diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-15 15:14:19 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-15 15:14:19 +0300 |
| commit | 4bfc3a89c570aea8c9e4c91a7b249b50c112f1d2 (patch) | |
| tree | 6141328f8d71220f26ad2c70967df368b8940763 /.pi | |
| parent | 7c636e97f4568583651de3bc8c8550a3bab54743 (diff) | |
config: split experimental settings from advanced
Diffstat (limited to '.pi')
| -rw-r--r-- | .pi/docs/CONFIGURATION.md | 34 |
1 files changed, 27 insertions, 7 deletions
diff --git a/.pi/docs/CONFIGURATION.md b/.pi/docs/CONFIGURATION.md index 24bbe8c5..4336185e 100644 --- a/.pi/docs/CONFIGURATION.md +++ b/.pi/docs/CONFIGURATION.md @@ -44,12 +44,13 @@ Reloadable now: - `ui.agent_panel_scope` - `ui.toast.delivery` - server-side `ui.sound` policy; attached thin clients refresh local sound config after a successful sound-policy change +- `experimental.kitty_graphics` - `advanced.scrollback_limit_bytes` for panes created after reload - `ui.sidebar_width` as the default width; current width updates only while it is still config-owned Startup-only or special-case: - `onboarding` does not reopen onboarding during reload -- `advanced.allow_nested` is checked before launch and needs a restart +- `experimental.allow_nested` is checked before launch and needs a restart - existing pane scrollback buffers are not resized during reload - terminal notifications and sounds are client-local side effects and are sent to the foreground attached client @@ -365,20 +366,20 @@ available agent keys: - `droid` - `amp` -## advanced +## experimental ```toml -[advanced] +[experimental] allow_nested = false -scrollback_limit_bytes = 10000000 +kitty_graphics = false ``` ### options | option | default | description | |--------|---------|-------------| -| `advanced.allow_nested` | `false` | allow launching herdr from inside a herdr-managed pane | -| `advanced.scrollback_limit_bytes` | `10000000` | maximum scrollback buffer size in bytes retained per pane terminal | +| `experimental.allow_nested` | `false` | allow launching herdr from inside a herdr-managed pane | +| `experimental.kitty_graphics` | `false` | enable experimental local Kitty graphics rendering for attached clients | ### nested launches @@ -386,6 +387,25 @@ By default, herdr blocks nested launches when `HERDR_ENV=1` is already present. Set `allow_nested = true` only for debugging or intentionally nested setups. +### Kitty graphics + +`kitty_graphics` enables experimental local Kitty graphics rendering for attached clients. + +It requires a Kitty graphics-compatible outer terminal. + +## advanced + +```toml +[advanced] +scrollback_limit_bytes = 10000000 +``` + +### options + +| option | default | description | +|--------|---------|-------------| +| `advanced.scrollback_limit_bytes` | `10000000` | maximum scrollback buffer size in bytes retained per pane terminal | + ### scrollback `scrollback_limit_bytes` limits retained terminal scrollback per pane. @@ -394,7 +414,7 @@ The default matches Ghostty's `scrollback-limit` value. Set `scrollback_limit_bytes = 0` to disable pane scrollback entirely. -The old `advanced.scrollback_lines` key is still accepted as a compatibility alias, but it uses the same byte-based value. +The legacy `scrollback_lines` key is still accepted inside `[advanced]`, but it uses the same byte-based value. ## environment variables |