Skip to main content

sideshell

AI sidecar terminal — let Claude/Cursor 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

Metadata

Release files for sideshell-mcp 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sideshell-mcp 1.0.0
File Size Uploaded
sideshell_mcp-1.0.0.tar.gz 179.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sideshell-mcp 1.0.0
File Interpreter ABI Platform
sideshell_mcp-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 245.9 kB

Release files / sideshell_mcp-1.0.0.tar.gz

Download URL sideshell_mcp-1.0.0.tar.gz
Size 179.9 kB
Tags Source
SHA-256 checksum
How to use checksums
e2081b7694f15de8325a27a3e04f86badafeb2eedca5a9f40ad701f4bf839617
BLAKE2b-256 checksum
How to use checksums
73c7e55ca17dc6c41f3b1c791f9b4ddf2fefa5dd3e84be37b9330a876d82a77c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 18, 2026.

Transparency log

Release files / sideshell_mcp-1.0.0-py3-none-any.whl

Download URL sideshell_mcp-1.0.0-py3-none-any.whl
Size 66.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6898e771fdc567a6bb40d5f786ae0f90f59d968ee1f758e73aa7d6e9d624f593
BLAKE2b-256 checksum
How to use checksums
854d922fed5f5421fea649c7c5db4c7c1d60b56a6782db01968da2dff03ed22b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 18, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page