# Getting Started with the Installer

The easiest way to install tea is with our installer:

```sh
sh <(curl https://tea.xyz)
```

{% hint style="question" %}
`fish` user? Then you need `sh <(curl https://tea.xyz | psub)` instead.
{% endhint %}

The script installs to `~/.tea` and sets up magic (we ask politely first).

{% hint style="info" %}
### Want to Read the Sources for that Script First?
[https://github.com/teaxyz/setup/blob/main/install.sh]
{% endhint %}

> Linux and WSL2 users may need to install some pre-requisites.
> See [Linux Caveats](#linux-caveats) below.

## What Happens

* Firstly we confirm you’re cool before we do *anything*
    * If so we install tea to `~/.tea`
    * If not we exit with failure
* We then ask if you want [magic](../magic.md)
    * If so we add one line to your `~/.shellrc`
    * If not we exit successfully

<details><summary><code>`preview.gif`</code></summary>

![charm.sh/vhs recording](https://teaxyz.github.io/setup/sample.gif)

</details>


## It’s Not Just an Installer

If you run it again, it’ll update `tea`.

### That’s Not All

The tea one-liner can also be used to provide your users a temporary sandbox
for your projects. They can use the power of tea to try out your project
without installing tea or your project.

{% hint style="success" %}
See [The `tea` One-Liner](/docs/using-tea/the-tea-one-liner.md) for more details
{% endhint %}


## Requirements

Both aarch64 (arm64) and x86-64 for these platforms:

* macOS >= 11
* Linux glibc >=2.28 (consult [repology](https://repology.org/project/glibc/versions))
* WSL >=2

{% hint style="info" %}
`linux-aarch64` builds are done using a dockerized Debian image on Apple arm64
processors. We have tested and confirmed functionality on Raspberry Pi4 running
Ubuntu 22.04.2 LTS, and it should work on similar 64-bit Pi Foundation hardware
with a sufficient glibc, which should include the last several releases of
Raspbian Linux. 32-bit CPU builds are not being done at this time.
{% endhint %}

We want to support Windows native and after that every platform; yes even
your NAS and IoT devices. We’re going to get the above sorted first though.


### Linux / WSL Caveats

On Linux you may need some pre-requisite packages from your system packager.
This is a temporary situation that we are fixing.

We are keeping a list of pre-reqs in [this script].


[this script]: https://github.com/teaxyz/setup/blob/main/install-pre-reqs.sh
[https://github.com/teaxyz/setup/blob/main/install.sh]: https://github.com/teaxyz/setup/blob/main/install.sh
