1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
All you need to get started building Textual apps.
## Requirements
Textual requires Python 3.8 or later (if you have a choice, pick the most recent Python). Textual runs on Linux, macOS, Windows and probably any OS where Python also runs.
!!! info "Your platform"
### :fontawesome-brands-linux: Linux (all distros)
All Linux distros come with a terminal emulator that can run Textual apps.
### :material-apple: macOS
The default terminal app is limited to 256 colors. We recommend installing a newer terminal such as [iterm2](https://iterm2.com/), [Ghostty](https://ghostty.org/), [Kitty](https://sw.kovidgoyal.net/kitty/), or [WezTerm](https://wezfurlong.org/wezterm/).
### :material-microsoft-windows: Windows
The new [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701?hl=en-gb&gl=GB) runs Textual apps beautifully.
## Installation
Here's how to install Textual.
### From PyPI
You can install Textual via PyPI, with the following command:
```
pip install textual
```
If you plan on developing Textual apps, you should also install textual developer tools:
```
pip install textual-dev
```
If you would like to enable syntax highlighting in the [TextArea](./widgets/text_area.md) widget, you should specify the "syntax" extras when you install Textual:
```
pip install "textual[syntax]"
```
### From conda-forge
Textual is also available on [conda-forge](https://conda-forge.org/). The preferred package manager for conda-forge is currently [micromamba](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html):
```
micromamba install -c conda-forge textual
```
And for the textual developer tools:
```
micromamba install -c conda-forge textual-dev
```
### Textual CLI
If you installed the developer tools you should have access to the `textual` command. There are a number of sub-commands available which will aid you in building Textual apps. Run the following for a list of the available commands:
```bash
textual --help
```
See [devtools](guide/devtools.md) for more about the `textual` command.
## Demo
Once you have Textual installed, run the following to get an impression of what it can do:
```bash
python -m textual
```
## Examples
The Textual repository comes with a number of example apps. To try out the examples, first clone the Textual repository:
=== "HTTPS"
```bash
git clone https://github.com/Textualize/textual.git
```
=== "SSH"
```bash
git clone git@github.com:Textualize/textual.git
```
=== "GitHub CLI"
```bash
gh repo clone Textualize/textual
```
With the repository cloned, navigate to the `/examples/` directory where you will find a number of Python files you can run from the command line:
```bash
cd textual/examples/
python code_browser.py ../
```
### Widget examples
In addition to the example apps, you can also find the code listings used to generate the screenshots in these docs in the `docs/examples` directory.
## Need help?
See the [help](./help.md) page for how to get help with Textual, or to report bugs.
|
