CLI Reference

These commands are for panel administrators with authorized shell access to the panel server. VPS users should contact their hosting provider instead of running them inside a VPS.

Run commands from your Pterodactyl panel directory, commonly /var/www/pterodactyl, using the PHP executable and service account configured by your installation. Command availability and options depend on the installed release.

Command Help

Check the installed help before using options or following advice for another release:

php artisan help pterocloud:diagnose
php artisan help pterocloud:support:bundle

If a command is not registered, check the installed package and its release instructions. Do not substitute guessed command names or install source files.

Installation and Setup Checks

php artisan pterocloud:compatibility
php artisan pterocloud:setup:verify
php artisan pterocloud:verify

• compatibility reports the detected environment against the release's compatibility checks.
• setup:verify checks readiness for the first VPS and identifies incomplete setup.
• verify runs installation and service verification checks.

Review failures and warnings. A compatibility report is not a guarantee that every optional feature or infrastructure configuration is supported.

PteroCloud Health

php artisan pterocloud:health
php artisan pterocloud:diagnose

Use health for an operational overview and diagnose for diagnostic findings. The commands above are checks, not instructions to repair or reset the installation. Follow Troubleshooting for next steps.

Test Provider

php artisan pterocloud:proxmox:test PROVIDER_UUID

Replace PROVIDER_UUID with the provider reference from the admin interface. This tests the Proxmox connection and access; review permission warnings even if the connection succeeds. See Test Connection.

Support Bundle

Preview the proposed contents first, then generate a bundle if needed:

php artisan pterocloud:support:bundle --preview
php artisan pterocloud:support:bundle

Preview lists the proposed sections without creating an archive. The second command creates a support archive; it does not send it to support automatically. The Support Center may also provide bundle controls in your release.

Sharing Diagnostics

Output, screenshots and bundles can contain private host or customer information, even when credentials are automatically redacted. Review the actual contents before sharing, not just the preview. Keep archives outside public web access.

Send only relevant, reviewed information privately to [email protected] or your agreed support channel. Never include license keys, passwords, API tokens, private SSH keys, session links or unredacted configuration files.