mirror of
https://github.com/harivansh-afk/clanker-agent.git
synced 2026-04-15 09:01:13 +00:00
Harivansh Rathi
536241053c
Complete the remaining pi-to-companion rename across companion-os, web, vm-orchestrator, docker, and archived fixtures. Verification: - semantic rg sweeps for Pi/piConfig/getPi/.pi runtime references - npm run check in apps/companion-os (fails in this worktree: biome not found) Co-authored-by: Codex <noreply@openai.com>
71 lines
1.7 KiB
Markdown
71 lines
1.7 KiB
Markdown
# Terminal Setup
|
|
|
|
Companion uses the [Kitty keyboard protocol](https://sw.kovidgoyal.net/kitty/keyboard-protocol/) for reliable modifier key detection. Most modern terminals support this protocol, but some require configuration.
|
|
|
|
## Kitty, iTerm2
|
|
|
|
Work out of the box.
|
|
|
|
## Ghostty
|
|
|
|
Add to your Ghostty config (`~/.config/ghostty/config`):
|
|
|
|
```
|
|
keybind = alt+backspace=text:\x1b\x7f
|
|
keybind = shift+enter=text:\n
|
|
```
|
|
|
|
## WezTerm
|
|
|
|
Create `~/.wezterm.lua`:
|
|
|
|
```lua
|
|
local wezterm = require 'wezterm'
|
|
local config = wezterm.config_builder()
|
|
config.enable_kitty_keyboard = true
|
|
return config
|
|
```
|
|
|
|
## VS Code (Integrated Terminal)
|
|
|
|
`keybindings.json` locations:
|
|
|
|
- macOS: `~/Library/Application Support/Code/User/keybindings.json`
|
|
- Linux: `~/.config/Code/User/keybindings.json`
|
|
- Windows: `%APPDATA%\\Code\\User\\keybindings.json`
|
|
|
|
Add to `keybindings.json` to enable `Shift+Enter` for multi-line input:
|
|
|
|
```json
|
|
{
|
|
"key": "shift+enter",
|
|
"command": "workbench.action.terminal.sendSequence",
|
|
"args": { "text": "\u001b[13;2u" },
|
|
"when": "terminalFocus"
|
|
}
|
|
```
|
|
|
|
## Windows Terminal
|
|
|
|
Add to `settings.json` (Ctrl+Shift+, or Settings → Open JSON file):
|
|
|
|
```json
|
|
{
|
|
"actions": [
|
|
{
|
|
"command": { "action": "sendInput", "input": "\u001b[13;2u" },
|
|
"keys": "shift+enter"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
If you already have an `actions` array, add the object to it.
|
|
|
|
## IntelliJ IDEA (Integrated Terminal)
|
|
|
|
The built-in terminal has limited escape sequence support. Shift+Enter cannot be distinguished from Enter in IntelliJ's terminal.
|
|
|
|
If you want the hardware cursor visible, set `COMPANION_HARDWARE_CURSOR=1` before running companion (disabled by default for compatibility).
|
|
|
|
Consider using a dedicated terminal emulator for the best experience.
|