docs

Termwright Documentation

Comprehensive documentation for Termwright - Playwright for terminals.

📚 Documentation Index

Core Documentation

• API Reference - Complete API documentation for programmatic usage
• MCP Tools - MCP server tools reference for AI agents
• Examples Guide - Complete guide to all examples

Example Code

• Getting Started Examples - Basic terminal operations
• Advanced Examples - Pattern matching and multi-session
• Testing Examples - CLI testing automation

🚀 Quick Links

I want to...	Go to...
Use as a library	API Reference
Use with AI/MCP	MCP Tools
See code examples	Examples Guide
Browse examples	Examples Directory

📖 Documentation Structure

docs/
├── README.md          # This file
├── api.md            # API reference for library usage
├── mcp-tools.md      # MCP tools reference for AI agents
└── examples.md       # Examples guide and overview

examples/
├── getting-started/  # Basic examples
├── advanced/         # Advanced patterns
└── testing/         # Testing examples

🎯 Documentation by Role

For Developers (Library Usage)

1. API Reference
2. Getting Started Examples
3. Advanced Examples

For QA Engineers (Testing)

1. Testing Examples
2. API Reference
3. Advanced Examples

For AI/ML Engineers (MCP Integration)

1. MCP Tools Reference
2. Examples Guide
3. Main README

🔧 Key Features

• Universal tmux-based terminals - Works with any terminal emulator
• Headless and visible modes - PTY for automation, tmux for visibility
• Pattern matching - Wait for regex patterns in output
• Session management - Spawn, control, and cleanup multiple sessions
• MCP integration - Built-in Model Context Protocol server for AI agents

📝 Contributing to Documentation

Found an error or want to improve the docs?

1. Fork the repository
2. Edit the markdown files in docs/
3. Submit a pull request

📄 License

MIT License - see LICENSE for details.