Skip to content

docs: document remote-use keybindings for sessionizer flows #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andrewchng wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: document remote-use keybindings for sessionizer flows #42

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39a9234
docs: document remote-use keybindings for sessionizer flows
Aug 2, 2026
7737282
docs: drop ineffective remote-binding alternative
Aug 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,18 @@ command = "sessionizer.worktree-open"
description = "open worktree workspace"
```

### Remote use (`herdr --remote`)

When you attach to a remote Herdr server, the Sessionizer keybindings above are read from the **remote** server's config, but Herdr's remote client may resolve keybindings from the machine you launched it from instead. If `sessionizer.open` / `sessionizer.worktree-open` do nothing under `herdr --remote`, attach with the server's keybindings:

```sh
herdr --remote <target> --remote-keybindings server
```

Bindings added to the machine that launches `herdr --remote` do **not** trigger the plugin in a remote session — they must come from the remote server's keybindings.

> The plugin itself runs on the remote host — bun, fzf, and the plugin checkout must be present there. See [Requirements](#requirements) for the runtime prerequisites.

## Layout configuration

When Sessionizer **creates** a new project or worktree workspace, it applies the layout from `config.toml`. Existing workspaces are only focused — the layout is not reapplied.
Expand Down
Loading