Recommended install (universal installer)

One command downloads the Python agent and launches OAuth pairing:

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 (PyPI)

pip install patcherly-connector
patcherly login

With the release-tree / universal-installer layout, start the agent:

python patcherly_agent.py

Or from your app (credentials from ~/.patcherly/credentials.json):

from patcherly_agent import PatcherlyAgent

agent = PatcherlyAgent(log_file="logs/error.log")
await agent.start()

Optional on quiet hosts: patcherly heartbeat from a daily cron / systemd timer — see the Python guide.

Pair later (or re-pair)

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 python patcherly_agent.py. Details: Python 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

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 (overrides {PATCHERLY_CACHE_DIR}/context_consent). off skips uploads; minimal sends runtime/OS/framework only.

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.

• Connectors overview
• Python connector — HMAC
• Prompt injection protection
• Custom sanitizer patterns
• Post-apply restart safety
• Hardening: backup folders

Documentation & support

• Python connector guide — install, systemd, troubleshooting
• Connectors overview · All connectors
• Discord · Dashboard · Report a bug

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.