Puppetty.NET 1.0.1

dotnet add package Puppetty.NET --version 1.0.1
                    
NuGet\Install-Package Puppetty.NET -Version 1.0.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Puppetty.NET" Version="1.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Puppetty.NET" Version="1.0.1" />
                    
Directory.Packages.props
<PackageReference Include="Puppetty.NET" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Puppetty.NET --version 1.0.1
                    
#r "nuget: Puppetty.NET, 1.0.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Puppetty.NET@1.0.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Puppetty.NET&version=1.0.1
                    
Install as a Cake Addin
#tool nuget:?package=Puppetty.NET&version=1.0.1
                    
Install as a Cake Tool

Build and TestNuGet

Logo

Puppetty

Cross-platform Playwright for terminals, in .NET. Run any CLI or TUI program in a real pseudo-terminal, emulate its screen headlessly, and drive it from tests, scripts or AI agents: type, press keys, click, wait for the screen, assert, snapshot and replay.

  • Emulator: XTerm.NET, a headless xterm-compatible emulator.
  • PTY: Porta.Pty. It uses the bundled ConPTY (OpenConsole) on Windows and openpty on Linux and macOS.
  • Target: net10.0. Tested on Windows and Linux.
using Puppetty;
using static Puppetty.Testing.Assertions;

await using var term = await Terminal.LaunchAsync("python3", new LaunchOptions { Args = ["-i", "-q"] });
await term.WaitForTextAsync(">>> ");
await term.TypeAsync("print(6*7)");
await term.PressAsync("Enter");
await Expect(term.GetByText("42")).ToBeVisibleAsync();
await Expect(term).ToMatchSnapshotAsync("python-42");

Packages

Package Install What it is
Puppetty.NET dotnet add package Puppetty.NET The library, namespace Puppetty: Terminal, Screen, locators, key/mouse/paste encoding, settling, snapshots, traces. Also auto-retrying Expect(...) assertions and golden snapshots (namespace Puppetty.Testing) for xUnit, NUnit and MSTest.
Puppetty dotnet tool install -g Puppetty The puppetty tool: shell commands with daemon-backed sessions and a live attach view, and puppetty mcp, an MCP server giving AI agents the terminal_* tools.

Docs

  • docs/api.md: the library: launching, input, reading the screen, locators, assertions, settling, snapshots, traces.

  • docs/mcp.md: the MCP server, setup in Claude Code, the annotated screenshot format.

  • docs/cli.md: the puppetty CLI and its daemon.

Build and test

dotnet build Puppetty.slnx
dotnet test Puppetty.slnx

The end-to-end tests drive small fixture apps (tests/fixtures/Puppetty.Fixture). The smoke tests drive real programs (vim, less, top/htop, pwsh, python) and skip any that aren't installed. samples/Puppetty.Samples.XUnit is a small xUnit suite to copy from.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 92 11/4/2026
1.0.0 92 11/4/2026