> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wrapper.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Keep your real shell on your machine and reach it from an authorized device.

Wrapper wraps the interactive shell you already use on macOS or Linux. Your
prompt, plugins, history, files, and credentials stay on the host. Attach from
another local terminal, or share one session with an authorized device when you
choose.

![A macOS terminal running wrapper share, showing the controls hint, a redacted share code, and the join command, next to an iPhone viewing the same session over P2P](https://mintcdn.com/wrapper/JLMnFS4G4wmSxZil/images/wrapper-session-overview.webp?fit=max\&auto=format\&n=JLMnFS4G4wmSxZil\&q=85\&s=62bec6f8705a9ce4c9900e160d923039)

## What you get

* Your real shell (`zsh`, `bash`, or `fish`) runs on the host machine.
* Local attach joins that live PTY over loopback with a per-session token.
* Remote share (Pro) routes through an authenticated Fly.io relay, with a
  default WebRTC P2P fast path for lower latency.
* People you invite watch unless you allow typing. You always type.
* Free: attach from the same computer. Pro: attach from another device.

## Prerequisites

* macOS or Linux (Windows via WSL)
* `zsh`, `bash`, or `fish`
* A Wrapper account for backend auth and remote sharing

## Install

Homebrew:

```bash theme={null}
brew install heycupola/tap/wrapper
```

Checksum-verified installer:

```bash theme={null}
curl -fsSL https://wrapper.sh/install | bash
```

Supported installer targets today: `darwin-arm64`, `darwin-x86_64`,
`linux-arm64`, and `linux-x86_64`.

## First session

**1. Sign in**

```bash theme={null}
wrapper auth login
```

Approve the device code in the browser. Local attach does not require
login. Remote share does.

**2. Share a session**

```bash theme={null}
wrapper share
```

Does not patch your shell config. Wrap a command without sharing yet with
`wrapper run -- claude`. Optional: `wrapper install` wraps every new
terminal.

**3. Attach locally**

From another terminal on the same machine:

```bash theme={null}
wrapper attach
```

**4. Share remotely (Pro)**

`wrapper share` already shares. In a running host, press `Ctrl+\` then `s`.
Join with:

```bash theme={null}
wrapper attach --relay --id <sessionId>
```

Owners skip the share code. Guests enter it in a hidden prompt.

> [!NOTE]
>
> Remote sharing requires Pro. Local attach does not use the relay and does not require Pro.

## Controls and HUD

Wrapper prints controls once, then keeps status in the terminal title so
full-screen tools like Vim stay intact.

| Keys | Host | Viewer |
| - | - | - |
| `Ctrl+\` `s` | Share | |
| `Ctrl+\` `u` | Unshare | |
| `Ctrl+\` `w` | Typing | |
| `Ctrl+\` `d` | | Detach |
| `Ctrl+\` `?` | Status | Status |

HUD transport labels: `local`, `connecting`, `relay`, `p2p`, `offline`.

## Next steps

* [Quickstart](https://docs.wrapper.sh/guides/installation.md)
* [Authentication](https://docs.wrapper.sh/guides/auth.md)
* [Local attach](https://docs.wrapper.sh/guides/local-attach.md)
* [Remote Linux box](https://docs.wrapper.sh/guides/linux-remote.md)
* [Remote share](https://docs.wrapper.sh/guides/remote-share.md)
* [Pricing](https://docs.wrapper.sh/reference/pricing.md)
* [Security and privacy](https://docs.wrapper.sh/configuration/security.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.