> ## 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 CLI: Install

> Command-line tool to install AppSignal in a PHP application. Documentation for usage, options and configuration methods.

export const VersionRequirements = ({versions = []}) => {
  if (!Array.isArray(versions) || versions.length === 0) {
    return null;
  }
  const boundaries = {
    upper: " or lower",
    exact: "",
    lower: " or higher"
  };
  const containerStyle = {
    marginTop: "0.5rem",
    marginBottom: "1.5rem"
  };
  const lineStyle = {
    display: "block",
    margin: "0 0 0.35rem 0",
    fontSize: "0.875rem",
    lineHeight: "1.4"
  };
  const pillBaseStyle = {
    display: "inline-block",
    padding: "0.1em 0.4em",
    borderRadius: "0.25rem",
    border: "1px solid",
    fontFamily: "ui-monospace, SFMono-Regular, Menlo, monospace",
    fontSize: "0.85em",
    fontWeight: 500
  };
  const pillColors = {
    "AppSignal for Elixir": {
      background: "#f3e8ff",
      borderColor: "#e9d5ff",
      color: "#9333ea"
    },
    "AppSignal for Front-end": {
      background: "#fef9c3",
      borderColor: "#fde68a",
      color: "#ca8a04"
    },
    "AppSignal for Go": {
      background: "#ccfbf1",
      borderColor: "#99f6e4",
      color: "#0d9488"
    },
    "AppSignal for JavaScript": {
      background: "#fef9c3",
      borderColor: "#fde68a",
      color: "#ca8a04"
    },
    "AppSignal for Node.js": {
      background: "#dcfce7",
      borderColor: "#bbf7d0",
      color: "#16a34a"
    },
    "AppSignal for Python": {
      background: "#dbeafe",
      borderColor: "#bfdbfe",
      color: "#2563eb"
    },
    "AppSignal for Ruby": {
      background: "#fee2e2",
      borderColor: "#fecaca",
      color: "#dc2626"
    },
    "AppSignal for Rust": {
      background: "#ffedd5",
      borderColor: "#fed7aa",
      color: "#ea580c"
    }
  };
  const defaultPillColor = {
    background: "#f4f4f5",
    borderColor: "#e4e4e7",
    color: "#52525b"
  };
  const getPillStyle = name => ({
    ...pillBaseStyle,
    ...pillColors[name] || defaultPillColor
  });
  const getBoundText = bound => {
    return boundaries[bound] || boundaries.lower;
  };
  return <div style={containerStyle}>
      {versions.map((v, i) => <p key={`${v.name}-${v.version}-${v.bound || "lower"}-${i}`} style={lineStyle}>
          This feature requires{" "}
          <code style={getPillStyle(v.name)}>{v.name}</code> version {v.version}
          {getBoundText(v.bound)}.
        </p>)}
    </div>;
};

<VersionRequirements
  versions={[
{ name: "AppSignal for PHP", version: "0.5.0" }
]}
/>

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:

```bash Shell theme={null}
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](/php/command-line/demo) 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](/php/configuration/options).