> For the complete documentation index, see [llms.txt](https://partners.tray.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://partners.tray.com.br/themes/tray-cli/instalacao.md).

# Instalação

O Tray CLI é uma interface de linha de comando desenvolvida em Node.js e TypeScript que se comunica com a plataforma Tray para auxiliar desenvolvedores a criar e customizar temas de maneira simples e eficiente.  

### Requisitos

Os seguintes requisitos são necessários para executar o Tray CLI:

* Sistema operacional Windows ou Linux.
* [**Node.js**](https://nodejs.org/pt-br/download/) **22 LTS** ou superior;
* Gerenciador de pacote `npm` ou da sua preferência.

{% hint style="info" %}
**Tenha em mente :)**

O Tray CLI **não** foi testado no macOS ou com outro gerenciadores de pacotes. Não podemos garantir o funcionamento em tais situações. O desenvolvedor assume o risco ao usar fora dos requisitos passados.
{% endhint %}

### Instale o Tray CLI

Selecione abaixo o sistema operacional do seu computador e siga os passos da instalação.

{% tabs %}
{% tab title="Windows" %}
**1.** Para instalar globalmente no sistema (recomendado) execute o seguinte comando.

{% code title="Terminal" %}

```opencl
npm install @tray-tecnologia/cli --global
```

{% endcode %}

Ou para instalar apenas na pasta local desejada execute o comando abaixo

{% code title="Terminal" %}

```opencl
npm install @tray-tecnologia/cli
```

{% endcode %}

**2.** Para verificar se a Tray CLI está instalada corretamente, execute o seguinte comando:

{% code title="Terminal" %}

```opencl
tray --version
```

{% endcode %}
{% endtab %}

{% tab title="Linux" %}
**1.** Para instalar globalmente no sistema (recomendado) execute o seguinte comando.

{% code title="Terminal" %}

```opencl
sudo npm install @tray-tecnologia/cli --global
```

{% endcode %}

Ou para instalar apenas na pasta local desejada execute o comando abaixo

{% code title="Terminal" %}

```opencl
sudo npm install @tray-tecnologia/cli
```

{% endcode %}

**2.** Para verificar se a Tray CLI está instalada corretamente, execute o seguinte comando:

{% code title="Terminal" %}

```opencl
tray --version
```

{% endcode %}
{% endtab %}
{% endtabs %}

{% hint style="warning" %}
Se desejar usar o Tray CLI instalado localmente, todos os comando precisaram ter acrescido **`npx`** antes para que sejam executados corretamente.
{% endhint %}

{% hint style="info" %}
Para mais informações acesse o [repositório](https://github.com/tray-tecnologia/tray-cli) do projeto no Github.
{% endhint %}