> ## Documentation Index
> Fetch the complete documentation index at: https://docs.appsignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AppSignal para Ruby: Install

> Ferramenta de linha de comando para instalar o AppSignal em uma aplicação Ruby. Documentação sobre uso, opções e métodos de configuração.

A documentação informa tudo o que você precisa saber sobre como instalar o AppSignal via a ferramenta de linha de comando.

## Descrição

A ferramenta de linha de comando ajuda a configurar a aplicação. A integração com aplicações Ruby que não usam o framework Rails requer etapas adicionais, porque o instalador do AppSignal não sabe como sua aplicação está configurada. Recomendamos o nosso [guia de instalação](/guides/new-application) ao adicionar uma nova aplicação ao AppSignal.

Para aplicações Rails, a integração completa é automática. Para outros frameworks, consulte nossa [documentação de Integrações](/ruby/integrations/).

Após concluir a instalação, execute o [comando da ferramenta de demonstração](/ruby/command-line/demo) para verificar se a instalação foi bem-sucedida. O comando da ferramenta de demonstração envia dados de amostra da sua aplicação para os servidores do AppSignal, o que ajuda a verificar se tudo está funcionando corretamente.

## Métodos de configuração

Existem dois métodos de configuração fornecidos pelo instalador de linha de comando:

1. [Configuração via arquivo de configuração](#1-configuration-file)
2. [Configuração via variáveis de ambiente](#2-environment-variables).

### 1. Arquivo de configuração

O AppSignal pode ser configurado via um arquivo de configuração chamado `appsignal.rb` ou `appsignal.yml`, localizado na sua aplicação no diretório `config/`.
Ao escolher essa opção, nosso instalador irá gravar a sua configuração nesse arquivo.

Ao configurar sua integração do AppSignal via arquivo de configuração, a Push API key que você fornecer ao instalador será gravada no arquivo de configuração `appsignal.yml`. Não recomendamos adicionar essa chave a sistemas de controle de versão como Git, SVN ou Mercurial. Em vez disso, use a variável de ambiente `APPSIGNAL_PUSH_API_KEY` para armazenar sua API key.

Você pode ler mais sobre como configurar sua aplicação na nossa [documentação de configuração](/ruby/configuration).

### 2. Variáveis de ambiente

O AppSignal pode ser configurado por meio de variáveis de ambiente do sistema. Se você selecionar essa opção, nenhum [arquivo de configuração](#1-configuration-file) será gerado.

Você pode ler mais sobre como configurar sua aplicação na nossa [documentação de configuração](/ruby/configuration).

## Uso

Para instalar o appsignal via linha de comando, navegue até o diretório do seu projeto e execute o seguinte comando:

<CodeGroup>
  ```bash Bash theme={null}
  appsignal install <Push API key>
  # For example
  appsignal install 1234-1234-1234-1234
  ```
</CodeGroup>

A "Push API key" da sua aplicação será exibida no [assistente de instalação](https://appsignal.com/redirect-to/organization?to=sites/new) e também está disponível na seção de administração das configurações da sua organização, ou via [este link](https://appsignal.com/redirect-to/organization?to=admin/api_keys).

## Opções disponíveis

| Opção | Uso            | Descrição                       |
| ----- | -------------- | ------------------------------- |
| color | `--[no-]color` | Alterna a colorização da saída. |