Skip to main content
The install command sets up AppSignal in your PHP application. The command goes through six steps:
  1. Detects your application framework (Laravel, Symfony, or plain PHP),
  2. Installs auto-instrumentation packages,
  3. Scaffolds config file in config/appsignal.php if it doesn’t exist,
  4. Collects required config values interactively, pre-filling any that were found in your environment,
  5. Sends example data (trace, exception, and log) to AppSignal to verify configuration,
  6. Updates .env file with missing configuration values.

​
Usage

Run the following terminal command from your project’s root folder:
Shell
vendor/bin/appsignal install

​
Command options

The install command options allow you to pass required configuration values or skip the demo.
OptionDescription
--push-api-keyAppSignal Push API key
--collector-endpointAppSignal collector endpoint URL
--app-nameYour application name
--app-environmentYour application environment (e.g. production, development)
--skip-demoSkip sending demo data (also skips .env updates)
Unless --skip-demo option is passed, the install command runs the demo command automatically. If all configuration values are passed in through command options, the interactive prompts are skipped entirely. To learn more about configuration options, visit AppSignal for PHP Configuration documentation.