# xterm-addon-attach

> An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables attaching to a web socket. This addon requires xterm.js v4+.

Latest version **0.9.0** (published 2023-09-07) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install xterm-addon-attach
pnpm add xterm-addon-attach
yarn add xterm-addon-attach
bun add xterm-addon-attach
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.9.0 |
| Published | 2023-09-07 |
| First published | 2019-01-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 21155 |
| Author | The xterm.js authors |
| Maintainers | tyriar |
| Keywords | terminal, xterm, xterm.js |

## Links

- npm: https://www.npmjs.com/package/xterm-addon-attach
- Repository: https://github.com/xtermjs/xterm.js
- Homepage: https://github.com/xtermjs/xterm.js#readme
- Issues: https://github.com/xtermjs/xterm.js/issues
- npm.io page: https://npm.io/package/xterm-addon-attach

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 0.9.0 (latest) — 2023-09-07
- 0.10.0-beta.37 (beta) — 2023-10-31
- 0.10.0-beta.36 — 2023-10-31
- 0.10.0-beta.35 — 2023-10-30
- 0.10.0-beta.34 — 2023-10-19
- 0.10.0-beta.33 — 2023-10-19
- 0.10.0-beta.32 — 2023-10-17
- 0.10.0-beta.31 — 2023-10-13
- 0.10.0-beta.30 — 2023-10-02
- 0.10.0-beta.29 — 2023-10-02
- 0.10.0-beta.28 — 2023-09-27
- 0.10.0-beta.27 — 2023-09-20
- 0.10.0-beta.26 — 2023-09-20
- 0.10.0-beta.25 — 2023-09-16
- 0.10.0-beta.24 — 2023-09-15
- … 110 more at https://npm.io/package/xterm-addon-attach/versions

## README

## xterm-addon-attach

An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables attaching to a web socket. This addon requires xterm.js v4+.

### Install

```bash
npm install --save xterm-addon-attach
```

### Usage

```ts
import { Terminal } from 'xterm';
import { AttachAddon } from 'xterm-addon-attach';

const terminal = new Terminal();
const attachAddon = new AttachAddon(webSocket);
terminal.loadAddon(attachAddon);
```

See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/xterm-addon-attach/typings/xterm-addon-attach.d.ts) for more advanced usage.

---
_Source: https://npm.io/package/xterm-addon-attach · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._