AppSignal CLI: Install
Command-line tool to install AppSignal in a PHP application. Documentation for usage, options and configuration methods.
This feature requires AppSignal for PHP version 0.5.0 or higher.
The install command sets up AppSignal in your PHP application. The command goes through six steps:
- Detects your application framework (Laravel, Symfony, or plain PHP),
- Installs auto-instrumentation packages,
- Scaffolds config file in
config/appsignal.phpif it doesn't exist, - Collects required config values interactively, pre-filling any that were found in your environment,
- Sends example data (trace, exception, and log) to AppSignal to verify configuration,
- Updates
.envfile 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.
| Option | Description |
|---|---|
--push-api-key | AppSignal Push API key |
--collector-endpoint | AppSignal collector endpoint URL |
--app-name | Your application name |
--app-environment | Your application environment (e.g. production, development) |
--skip-demo | Skip 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.