mirror of
https://github.com/harivansh-afk/clanker-agent.git
synced 2026-04-17 05:00:17 +00:00
chore: rebrand companion-os to clanker-agent
- Rename all package names from companion-* to clanker-* - Update npm scopes from @mariozechner to @harivansh-afk - Rename config directories .companion -> .clanker - Rename environment variables COMPANION_* -> CLANKER_* - Update all documentation, README files, and install scripts - Rename package directories (companion-channels, companion-grind, companion-teams) - Update GitHub URLs to harivansh-afk/clanker-agent - Preserve full git history from companion-cloud monorepo
This commit is contained in:
parent
f93fe7d1a0
commit
67168d8289
356 changed files with 2249 additions and 10223 deletions
71
packages/coding-agent/clanker-out/docs/terminal-setup.md
Normal file
71
packages/coding-agent/clanker-out/docs/terminal-setup.md
Normal file
|
|
@ -0,0 +1,71 @@
|
|||
# Terminal Setup
|
||||
|
||||
Clanker 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 `CLANKER_HARDWARE_CURSOR=1` before running clanker (disabled by default for compatibility).
|
||||
|
||||
Consider using a dedicated terminal emulator for the best experience.
|
||||
Loading…
Add table
Add a link
Reference in a new issue