Plugin panes
A plugin can bring its own screen into tt-git. A plugin pane runs one of the plugin’s programs in a terminal inside tt-git and shows it live: a list of pull requests, a project board, a log tailer, anything that runs in a terminal. You keep tt-git’s panes and keys; the plugin draws only inside its own box. Panes come from installed plugins, so you’ll only see them once you have one that provides them.
Placements
Section titled “Placements”A plugin decides where its pane goes. There are three kinds:
| Placement | Where it goes | Keys |
|---|---|---|
| overlay | Covers the whole screen | All keys go to the pane |
| popup | A centred box over the layout, sized by the plugin (in cells or a percentage) | All keys go to the pane |
| split | Takes the place of the details pane | Keys go to the pane while it’s focused |
Plugins written for herdr may ask for tab or zoomed; tt-git has neither, so those open as
overlays. Only one popup can be open at a time.
The pane’s border carries its title, and the bottom edge reminds you how to leave it, for example
ctrl+\ to leave.
Opening a pane
Section titled “Opening a pane”- Press : or ctrl+p to open the command palette.
- Type part of the pane’s name. Panes are listed as Open and their title, for example Open Pull requests, with the plugin’s name on the right.
- Press enter.
Plugins can also open panes from their own actions, and you can open one from a script with
tt-git plugin pane open. See CLI and socket API.
Leaving and closing a pane
Section titled “Leaving and closing a pane”ctrl+\ or F12 gets you out of a pane:
- Overlay and popup: closes the pane. It also closes by itself when its program exits.
- Split: gives focus back to tt-git and leaves the program running. Press 4 to go back
to it. When the program exits, the pane shows its exit status in the title, for example
[process exited with code 1], and any key closes it.
When a pane’s program ends, the help bar also says so, for example Pull requests: process exited.
You can change the keys that leave a pane with pane_release_keys in the
configuration file.
Writing your own pane is covered in Writing a plugin.
| Key | Does |
|---|---|
| : ctrl+p | Command palette, where panes are listed as Open … |
| ctrl+\ F12 | Leave the pane (closes an overlay or popup) |
| 4 | Focus a split pane again |
| any key | Close a split pane whose program has exited |