shippercli/provider-cpanel

cPanel provider plugin for Shipper CLI

v1.1.0 2026-07-28 12:18 UTC

Requires

• php: ^8.3
• composer-runtime-api: ^2.1
• guzzlehttp/guzzle: ^7.9
• shippercli/contracts: ^1.0

Requires (Dev)

• pestphp/pest: ^3.8

MIT

Published on Packagist.org on 2026-07-28 12:19 UTC

README

Deploy and operate applications on cPanel accounts from Shipper CLI.

Install

composer require shippercli/provider-cpanel

Shipper discovers the provider through Composer's plugin metadata. No cPanel implementation is bundled into the CLI.

Configure

Use a cPanel API token when the hosting provider allows one. Password authentication remains available for hosts that do not expose account tokens.

providers:
  cpanel:
    host: "cpanel.hosting.com"
    port: 2083
    username: "${CPANEL_USERNAME}"
    api_token: "${CPANEL_API_TOKEN}"

projects:
  app:
    provider: cpanel
    path: "."
    web_directory: /public
    profiles:
      production:
        branch: main
        domain: "api.example.com"
        deploy_path: "/api"
        runtime:
          type: php
          version: "8.4"
          install_dependencies: true
        cpanel:
          domain_type: existing
          backup_before_deploy: true
          release_retention: 5

See configuration for runtime, database, cron, SSL, release, and account-specific options.

Operate

shipper validate
shipper plan app --profile=production
shipper apply app --profile=production
shipper status app --profile=production
shipper logs app --profile=production --lines=100
shipper rollback app --profile=production
shipper destroy app --profile=production

The implementation targets cPanel account UAPI, the remaining operations that only exist in cPanel API 2, and optional privileged WHM API operations. See the capability model for availability rules and the operations guide for rollback and cleanup safety.