AppSignal for Ruby: Install

The documentation tells you everything you need to know about installing AppSignal via the command-line tool.


The command-line tool helps with setting up the configuration for your application. Integration with Ruby applications not using the Rails framework requires additional steps, because the AppSignal installer does not know how your application is set up. We recommend you our installation guide when adding a new application to AppSignal.

For Rails applications, full integration is automatic. For other frameworks, please refer to our Integrations documentation.

Once the installation is complete, run the demo tool command to verify that the installation was successful. The demo tool command sends sample data from your application to the AppSignal servers, which helps you verify that everything is working properly.

Configuration methods

There are two configuration methods provided by the command-line installer:

  1. Configuration via a configuration file
  2. Configuration via environment variables.

1. Configuration file

AppSignal can be configured via a configuration file called appsignal.yml, located in your application at config/appsignal.yml. When chosing this option our installer will write your configuration to this file.

When configuring your AppSignal integration via the configuration file, the Push API key you provide to the installer will be written into the appsignal.yml configuration file. We do not recommend adding this key to version control systems such as Git, SVN or Mercurial. Instead, use the APPSIGNAL_PUSH_API_KEY environment variable to store your API key.

You can read more about configuring your application in our configuration documentation.

2. Environment variables

AppSignal can be configured through system environment variables. If you select this option, no configuration file will be generated.

You can read more about configuring your application in our configuration documentation.


To install appsignal via the command-line, navigate to your project directory and run the following command:

appsignal install <Push API key> # For example appsignal install 1234-1234-1234-1234

Your application's "Push API key" will be displayed in the installation wizard and is also available in the administration section of your organization's settings, or via this link.

Available Options

color--[no-]colorToggle the colorization of the output.