# tauri-plugin-pty

**Repository Path**: web/tauri-plugin-pty

## Basic Information

- **Project Name**: tauri-plugin-pty
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-08
- **Last Updated**: 2026-01-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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))
```