Skip to main content
Instale a CLI e, em seguida, faça login para conectá-la à sua conta do AppSignal.

​
Instalação

A CLI roda em macOS e Linux, tanto em máquinas Intel (x86_64) quanto Apple Silicon / ARM (arm64). Distribuições Linux baseadas em musl, como Alpine, também são suportadas.
Instale a fórmula. O Homebrew faz o tap de appsignal/appsignal-cli automaticamente:
Para atualizar depois, execute:
Prefere não encaminhar um script para o seu shell? Baixe o binário para sua plataforma diretamente da última release.

​
Verifique a instalação

Verifique se a CLI está no seu PATH:
Shell
Em seguida, execute appsignal-cli about para uma visão geral da sua configuração, incluindo sua versão, endpoint, organização padrão e status de autenticação:
Shell
Antes de você autenticar, aparecerá Auth: Not authenticated e ele indicará os comandos a executar em seguida.

​
Autenticação

Antes que a CLI possa acessar seus dados, você precisa fazer login. Ela usa OAuth, um login baseado em navegador, então você nunca precisa copiar ou armazenar um token manualmente. Você pode verificar se está autenticado a qualquer momento com appsignal-cli auth status. Execute:
Shell
Isso abre seu navegador para autorizar a CLI com sua conta do AppSignal, depois devolve o controle através de um callback local em http://127.0.0.1:9789/callback. Uma vez aprovado, a CLI armazena os tokens e os renova para você, então você não precisará fazer login novamente.
O fluxo do navegador precisa de um navegador na mesma máquina da CLI.

​
Definir uma organização padrão

Se você pertence a mais de uma organização, defina um padrão enquanto faz login, para não precisar passá-lo em cada comando:
Shell
O slug da sua organização é o nome curto na sua URL do AppSignal: appsignal.com/<org-slug>. Executar appsignal-cli apps list depois de fazer login também salva a organização da sua conta como o padrão.

​
Verificar seu status

Para ver se você está autenticado e qual configuração a CLI está lendo, execute:
Shell
appsignal-cli about mostra o mesmo status de autenticação junto com sua versão, endpoint e organização padrão.

​
Fazer logout

Para remover suas credenciais armazenadas:
Shell

​
Onde suas credenciais ficam

A CLI armazena suas credenciais em um arquivo de configuração global, no diretório de configuração padrão do seu sistema operacional. A localização exata varia por SO, então execute appsignal-cli auth status para ver o caminho que a CLI está usando.

​
Configuração local do projeto

Você também pode manter a configuração junto com um projeto, em um arquivo .appsignal.toml no diretório do projeto. Crie um com:
Shell
Uma configuração local do projeto é útil para fixar um repositório a uma organização específica. Para definir a organização padrão para o projeto ao criá-lo:
Shell
Quando um .appsignal.toml local de projeto está presente, a CLI usa o mais próximo como a única configuração para comandos executados nesse diretório ou em seus subdiretórios. Para a lista completa de chaves de configuração e como elas se resolvem, veja Configuração.
project init não copia suas credenciais OAuth globais para a configuração do projeto. Após criá-la, execute appsignal-cli auth login novamente dentro do projeto para configurar credenciais específicas do projeto.

​
Próximos passos

Você está autenticado. Em seguida, liste suas aplicações para encontrar as aplicações que você consultará.