Documentation

Get up and running in 60 seconds.

Everything you need to install, scan, and secure your WordPress infrastructure with CleanShift.

Quick Start Guide

Run the installer on your server with your license key. The agent is only 600KB and has zero dependencies.

$ curl -fsSL https://get.cleanshift.osg.co.in | bash

$ cleanshift-installer --license-key=CS_YOUR_KEY

Scan files and the database for threats — rogue admins, wp_options injections, SEO spam, persistence backdoors.

$ cleanshift scan --server --scan-mode deep

# Scans all WordPress sites on the server

Review findings in the dashboard or CLI. Auto-remediate with CVE-specific playbooks (paid plans).

$ cleanshift report --format table

$ cleanshift clean --server --mode auto

Command	Description
cleanshift scan --server	Scan all WordPress sites on the server
cleanshift scan --site /path	Scan a specific WordPress site
cleanshift scan --scan-mode deep	Deep scan including database analysis
cleanshift clean --server --mode auto	Auto-remediate all detected threats
cleanshift report --format table	Display scan results as a table
cleanshift report --format json	Export results as JSON
cleanshift guard install	Install the real-time mu-plugin guard
cleanshift status	Check agent status and license info
cleanshift update	Update agent to the latest version

POST/api/v1/scanTrigger a new scan on a target server or site.

GET/api/v1/scan/:idRetrieve scan results by scan ID.

POST/api/v1/cleanRun auto-remediation on detected threats.

GET/api/v1/nodesList all registered nodes and their status.

GET/api/v1/reportsList historical scan reports with filtering.

All endpoints require an Authorization: Bearer <API_KEY> header. API access is available on Server and Fleet plans.

How the agent works, what leaves your server, rollback safety, clean uninstall, and audit logging.

See an anonymized deep scan report showing database threats, cross-site correlation, and remediation output.

REST API documentation for authentication, servers, scans, threats, and agent endpoints.

Reach our engineering team directly on WhatsApp for onboarding, integration support, or custom playbook requests.