# tauri-pty

> API package for tauri-plugin-pty

Latest version **0.3.1** (published 2026-07-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install tauri-pty
pnpm add tauri-pty
yarn add tauri-pty
bun add tauri-pty
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2026-07-08 |
| First published | 2023-12-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 1 |
| Unpacked size | 27.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | Tnze |
| Maintainers | tnze |
| Keywords | tauri-plugin |

## Links

- npm: https://www.npmjs.com/package/tauri-pty
- Repository: https://github.com/Tnze/tauri-plugin-pty
- Issues: https://github.com/Tnze/tauri-plugin-pty/issues
- npm.io page: https://npm.io/package/tauri-pty

## Dependencies (1)

- [@tauri-apps/api](https://npm.io/package/@tauri-apps/api.md) ^2.11.0

## Recent versions

- 0.3.1 (latest) — 2026-07-08
- 0.3.0 — 2026-06-06
- 0.2.1 — 2026-01-18
- 0.2.0 — 2026-01-04
- 0.1.1 — 2025-08-22
- 0.1.0 — 2025-03-10
- 0.0.8 — 2023-12-24
- 0.0.7 — 2023-12-24
- 0.0.6 — 2023-12-24
- 0.0.5 — 2023-12-23
- 0.0.4 — 2023-12-23
- 0.0.3 — 2023-12-23
- 0.0.2 — 2023-12-21
- 0.0.1 — 2023-12-21

## README

# Tauri Plugin Pseudo Terminal

Developing! Wellcome to contribute!

## Example

Full example at: <https://github.com/Tnze/tauri-plugin-pty/tree/main/examples/vanilla>

```sh
# Install this plugin in your Cargo.toml
cargo add tauri-plugin-pty
# Install the api package
npm install tauri-pty
```

```rust
tauri::Builder::default()
    .plugin(tauri_plugin_pty::init()) // add this
    .run(tauri::generate_context!())
    .expect("error while running tauri application");
...
```

```typescript
import { Terminal } from "xterm"
import { spawn } from "tauri-pty";

// init xterm.js
const term = new Terminal();
term.open(/* DOM Elem */);
// spawn shell
const pty = spawn("powershell.exe", [/* args */], {
    cols: term.cols,
    rows: term.rows,
})
// transport data
pty.onData(data => term.write(data))
term.onData(data => pty.write(data))
```

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