sideshell

sideshell

AI sidecar terminal — let Claude/Cursor run commands in a visible, persistent terminal you control.

Category
访问服务器

README

sideshell

AI sidecar terminal — let any MCP client (Claude Code, Cursor, Codex, OpenCode, Pi, …) run commands in a visible, persistent terminal you control.

PyPI version License: MIT

Why?

When AI assistants run shell commands, they execute in a hidden terminal:

  • ❌ No visible history
  • ❌ Can't intervene (enter password, confirm prompts)
  • ❌ Output mixed with AI conversation

sideshell runs commands in a separate visible terminal:

  • ✅ Full command history visible
  • ✅ Persistent session (survives AI restarts)
  • ✅ Intervene anytime (passwords, confirmations)
  • ✅ Clean separation from AI conversation

Supported Terminals

Terminal Platform Status
iTerm2 macOS ✅ Full support (native Python API)
tmux macOS, Linux, WSL ✅ Full support
WezTerm macOS, Linux, Windows ✅ Full support
Kitty macOS, Linux ✅ Full support
Ghostty macOS ✅ Full support (ghostty_tmux hybrid: native AppleScript splits + per-surface tmux engine, Ghostty 1.3+)
maquake macOS ✅ Full support (drop-down terminal via Unix socket)
VS Code / Cursor macOS, Linux, Windows ✅ Full support (via extension, Unix-socket bridge)
JetBrains IDEs macOS, Linux, Windows ✅ Full support (via plugin, Unix-socket bridge)

Features

  • Multi-Backend - Works with iTerm2, tmux, WezTerm, Kitty, Ghostty, maquake, VS Code/Cursor, or JetBrains IDEs
  • Sidecar Terminal - AI commands run in a visible terminal pane
  • You Stay in Control - See everything, intervene anytime
  • Session Persistence - Terminal survives AI session restarts
  • TUI Support - Arrow keys, F1-F12, Ctrl+C/D/Z for interactive apps
  • Focus Management - Optionally returns focus after operations

Installation

Using uvx (Recommended)

# Install uv first
curl -LsSf https://astral.sh/uv/install.sh | sh

# Run sideshell
uvx sideshell-mcp

Claude Desktop (~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "sideshell": {
      "command": "uvx",
      "args": ["sideshell-mcp"]
    }
  }
}

Using pipx

pipx install sideshell-mcp
sideshell-mcp

Backend Selection

# Auto-detect (default)
uvx sideshell-mcp

# Force specific backend
uvx sideshell-mcp --backend=tmux
uvx sideshell-mcp --backend=iterm2

Available Tools (17)

Tool Description
execute Execute commands (supports wait, timeout, targets for broadcast)
read Read terminal output
control-char Send special keys: Ctrl+C/D/Z, arrows, F1-F12, Home/End, PageUp/Down
list List all windows/tabs/sessions
split Split pane horizontally or vertically
new-window Create new window
new-tab Create new tab
new-session Smart session creation (splits if window exists)
focus Focus specific session
close-session Close terminal session
set-appearance Set tab title, badge, and color
get-terminal-state Get detailed terminal state
list-color-presets List available color presets
set-color-preset Apply color preset
show-alert Show alert dialog
clear Clear terminal screen
paste Paste text to terminal

MCP Resources

Resource Description
sideshell://sessions List all terminal sessions
sideshell://capabilities Backend features and system info
sideshell://sessions/{id} Session details
sideshell://sessions/{id}/screen Screen content

Prerequisites

iTerm2 (macOS)

  1. Open iTerm2 → Preferences → General → Magic
  2. Enable "Enable Python API"
  3. Restart iTerm2

tmux

# macOS
brew install tmux

# Ubuntu/Debian
sudo apt install tmux

WezTerm

Download from wezfurlong.org/wezterm

Kitty

# macOS
brew install --cask kitty

# Linux
curl -L https://sw.kovidgoyal.net/kitty/installer.sh | sh

Architecture

┌─────────────┐     ┌──────────────┐     ┌─────────────┐
│ MCP Client  │────▶│  sideshell   │────▶│  Terminal   │
│   (Claude)  │     │  MCP Server  │     │   Backend   │
└─────────────┘     └──────────────┘     └─────────────┘
                            │
                    ┌───────┴────────────┐
                    │      Backends      │
                    ├────────────────────┤
                    │ • iTerm2           │
                    │ • tmux             │
                    │ • WezTerm          │
                    │ • Kitty            │
                    │ • Ghostty          │
                    │ • maquake          │
                    │ • VS Code / Cursor │
                    │ • JetBrains IDEs   │
                    └────────────────────┘

VS Code/Cursor and JetBrains backends talk to their IDE extension/plugin over a local Unix domain socket (~/.sideshell/<ide>.sock) using newline-delimited JSON-RPC 2.0 with a token handshake.

Development

git clone https://github.com/menemy/sideshell
cd sideshell
uv pip install -e ".[dev]"

# Run tests
python tests/test_iterm2_backend.py   # iTerm2
python tests/test_tmux_backend.py     # tmux
python tests/test_wezterm_backend.py  # WezTerm
python tests/test_kitty_backend.py    # Kitty

# Lint & format
ruff format .
ruff check . --fix

Requirements

  • Python 3.11+
  • One of: iTerm2, tmux, WezTerm, Kitty, Ghostty, maquake, VS Code/Cursor, or a JetBrains IDE

License

MIT

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Add tests for new functionality
  4. Ensure all tests pass
  5. Submit a pull request

推荐服务器

Baidu Map

Baidu Map

百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。

官方
精选
JavaScript
Playwright MCP Server

Playwright MCP Server

一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。

官方
精选
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。

官方
精选
本地
TypeScript
Audiense Insights MCP Server

Audiense Insights MCP Server

通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。

官方
精选
本地
TypeScript
VeyraX

VeyraX

一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。

官方
精选
本地
graphlit-mcp-server

graphlit-mcp-server

模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。

官方
精选
TypeScript
Kagi MCP Server

Kagi MCP Server

一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。

官方
精选
Python
e2b-mcp-server

e2b-mcp-server

使用 MCP 通过 e2b 运行代码。

官方
精选
Neon MCP Server

Neon MCP Server

用于与 Neon 管理 API 和数据库交互的 MCP 服务器

官方
精选
Exa MCP Server

Exa MCP Server

模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。

官方
精选