
# Welcome

Welcome to the [Textual](https://github.com/Textualize/textual) framework documentation.

[Get started](./getting_started.md) or go straight to the [Tutorial](./tutorial.md)

## What is Textual?

Textual is a *Rapid Application Development* framework for Python, built by [Textualize.io](https://www.textualize.io).

Build sophisticated user interfaces with a simple Python API. Run your apps in the terminal *or* a [web browser](https://github.com/Textualize/textual-serve)!

- **Rapid development** - Uses your existing Python skills to build beautiful user interfaces.
- **Low requirements** - Run Textual on a single board computer if you want to.
- **Cross platform** - Textual runs just about everywhere.
- **Remote** - Textual apps can run over SSH.
- **CLI Integration** - Textual apps can be launched and run from the command prompt.
- **Open Source** - Textual is licensed under MIT.

---

# Built with Textual

Textual has enabled an ecosystem of applications and tools for developers and non-developers alike.

Here are a few examples.

## Toad

Toad is a beautiful terminal front-end for AI coding tools such as OpenHands, Claude Code, Gemini CLI, and many more.

[Toad Website](https://batrachian.ai/)

[Toad Github Repository](https://github.com/batrachianai/toad)

---

## Posting

The API client that lives in your terminal.
Posting is a beautiful open-source terminal app for developing and testing APIs.

[Posting Website](https://posting.sh/)

[Posting Github Repository](https://github.com/darrenburns/posting)

---

## Toolong

A terminal application to view, tail, merge, and search log files (plus JSONL).

[Toolong Github Repository](https://github.com/textualize/toolong)

---

## Memray

Memray is a memory profiler for Python, built by Bloomberg.

[Memray Github Repository](https://github.com/bloomberg/memray)

---

## Dolphie

Your single pane of glass for real-time analytics into MySQL/MariaDB & ProxySQL

[Dolphie Github Repository](https://github.com/charles-001/dolphie)

---

## Harlequin

An easy, fast, and beautiful database client for the terminal.

[Harlequin website](https://harlequin.sh/)

---

# Examples

The example source code referenced throughout these docs is in the [examples/](examples/) directory (also on [GitHub](https://github.com/Textualize/textual/tree/main/examples)).

Subdirectories mirror the doc structure:

- [examples/guide/](examples/guide/) - Guide chapter examples
- [examples/widgets/](examples/widgets/) - Widget examples
- [examples/styles/](examples/styles/) - CSS style examples
- [examples/events/](examples/events/) - Event examples
- [examples/how-to/](examples/how-to/) - How-to examples
- [examples/tutorial/](examples/tutorial/) - Tutorial (stopwatch) examples
- [examples/app/](examples/app/) - App examples
- [examples/themes/](examples/themes/) - Theme examples

---

# Documentation

| Section                               | Description                                       |
|---------------------------------------|---------------------------------------------------|
| [Getting Started](getting_started.md) | Installation and first steps with Textual         |
| [Tutorial](tutorial.md)               | Step-by-step tutorial for building your first app |
| [Guide](guide/index.md)               | In-depth guide to building Textual applications   |
| [Widgets](widgets/index.md)           | Reference for all built-in widgets                |
| [Styles](styles/index.md)             | CSS styles for customizing your app's appearance  |
| [Events](events/index.md)             | Events reference for handling user interactions   |
| [CSS Types](css_types/index.md)       | Data types accepted by CSS style rules            |
| [API Reference](api/index.md)         | Module-level API reference                        |
| [How-To](how-to/index.md)             | Practical how-to articles on various topics       |
| [Widget Gallery](widget_gallery.md)   | Visual overview of all built-in widgets           |
| [Reference](reference/index.md)       | Cross-cutting reference material                  |
| [FAQ](FAQ.md)                         | Frequently asked questions                        |
| [Help](help.md)                       | Getting help and reporting issues                 |
| [Roadmap](roadmap.md)                 | Project roadmap and planned features              |
| [Linux Console](linux-console.md)     | Notes on running Textual in the Linux console     |
