portable_pty_flutter

Flutter controller for portable_pty sessions. Wraps the PTY behind a ChangeNotifier so terminal state integrates seamlessly with Flutter's widget tree.

Features

• FlutterPtyController — ChangeNotifier wrapper around PortablePtyController for reactive UI updates.
• Same API on native (real shell) and web (remote transport).
• Buffered output lines, revision counter, and automatic cleanup.
• Re-exports all of portable_pty so you only need one import.

Platform support

Installation

dependencies:
  portable_pty_flutter: ^0.0.1

No separate portable_pty dependency is needed — it's re-exported automatically.

Quick start

Native

import 'package:flutter/material.dart';
import 'package:portable_pty_flutter/portable_pty_flutter.dart';

class TerminalPage extends StatefulWidget {
  const TerminalPage({super.key});
  @override
  State<TerminalPage> createState() => _TerminalPageState();
}

class _TerminalPageState extends State<TerminalPage> {
  final _ctrl = FlutterPtyController(
    rows: 24,
    cols: 80,
    defaultShell: '/bin/bash',
  );

  @override
  void initState() {
    super.initState();
    _ctrl.start();
    _ctrl.addListener(() => setState(() {}));
  }

  @override
  void dispose() {
    _ctrl.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Terminal')),
      body: ListView.builder(
        itemCount: _ctrl.lineCount,
        itemBuilder: (_, i) => Text(
          _ctrl.lines[i],
          style: const TextStyle(fontFamily: 'monospace', fontSize: 13),
        ),
      ),
    );
  }
}

Web

On web targets, pass a WebSocket URL to connect to a remote PTY server:

final controller = FlutterPtyController(
  rows: 24,
  cols: 80,
  webSocketUrl: 'ws://localhost:8080/pty',
);

await controller.start();
controller.write('ls\n');

FlutterPtyController

FlutterPtyController extends Flutter's ChangeNotifier and delegates to the platform-resolved PortablePtyController from portable_pty.

Related packages

License

MIT — see LICENSE.