Skip to content

Repository files navigation

Patcherly

Patcherly PHP connector

Auto-detect and fix production errors in your PHP apps. Standalone agent for Laravel, Symfony, and custom PHP: pairs with your Patcherly account.

For a limited time: 30-day Pro trial - no credit card required. Cancel anytime. Sign up.

Packagist patcherly/php-connector Documentation Discord - join

Prefer @latest / unpinned Composer installs, pin a version on Packagist, or download archives from the Patcherly downloads CDN.


Recommended install (universal installer)

One command downloads the PHP agent and launches OAuth pairing:

Platform Command
macOS / Linux / WSL curl -sSL https://api.patcherly.com/install | sudo CONNECTOR_TYPE=php bash
Windows PowerShell $env:CONNECTOR_TYPE = 'php'; irm "https://api.patcherly.com/install.ps1" | iex

The CLI prints a verification URL and a short user code - open the URL, sign in, pick your site, and confirm. Credentials are saved to ~/.patcherly/credentials.json (or /root/.patcherly/ when run as root). Then start the agent - see After install.

Full installer options (paths, SKIP_LOGIN, older versions): Installing a connector.

Package install (Composer)

composer global require patcherly/php-connector
patcherly login

Then run the long-lived agent (from the package tree or your install directory):

php patcherly_agent.php

Optional on quiet hosts: patcherly heartbeat from a daily cron / systemd timer so the connection stays fresh - see the PHP guide.

Pair later (or re-pair)

Install method Command
Universal installer (Linux/macOS) sudo /opt/patcherly-connector/start.sh login
Universal installer (Windows) & "$env:USERPROFILE\patcherly-connector\start.ps1" login
Composer patcherly login

On Linux, use sudo when the installer enabled the root-run patcherly-connector systemd unit so credentials land in /root/.patcherly/.

After install

  • Status and approvals: Sites in your Patcherly dashboard.
  • Start and keep the agent running - on Linux with the universal installer: systemctl start patcherly-connector. Otherwise run start.sh / start.ps1, or php patcherly_agent.php. Details: PHP connector guide.
  • Path exclusions and patch policies: Path rules for sites.

Test Mode (sample error)

  1. In the dashboard: Sites → your site → Test Mode ON (30-minute window).
  2. On the host:
patcherly send-test
# or: php patcherly_cli.php send-test

Samples are flagged and do not affect metrics or notifications. See Verify detection with send-test.

Context consent

Default is full. Change with:

patcherly context get
patcherly context set full|minimal|off
patcherly context upload

Env override: PATCHERLY_CONTEXT_CONSENT.

Security

OAuth pairing and per-token HMAC signing; fix payloads are verified before apply. Built-in redaction runs before ingest; you can add custom sanitizer patterns per site.

Documentation & support

License

Proprietary limited-use - run and modify only to connect your own apps to Patcherly; no redistribute or competitive reuse.

Patcherly is a registered trademark, property of Shambix.

Using the Patcherly service is governed by our Terms of Service and Acceptable Use policy. Official product support applies only to unmodified connector releases from our official sources.