Overview
The Commands section serves as a detailed reference for administrators and advanced users to efficiently manage and configure the PteroCA panel through the command-line interface (CLI). Each command is designed to perform a specific action, such as managing configurations, maintaining system health, managing plugins, or troubleshooting issues.
Command Naming in v0.6+
Starting with PteroCA v0.6, all CLI commands use the pteroca: namespace with hierarchical organization (e.g., pteroca:user:create, pteroca:plugin:enable).
Deprecation Timeline:
v0.6 (Current): New names available with aliases. Old names show deprecation warnings
v0.7-v0.9: Old names continue to work with warnings
v1.0.0: Old names removed completely ⚠️
Action Required: Update your scripts and cron jobs to use new command names before upgrading to v1.0.0.
Command Categories
User Management Commands - Create and manage user accounts
Server Management Commands - Sync, suspend, and delete servers
System Configuration & Maintenance Commands - Configure and maintain the system
Data Operations Commands - Data synchronization and migration
Plugin Management Commands - Complete plugin management system
Cron Scheduler Command - Automated task scheduling
Development Tools Commands - Developer utilities
Theme Commands - List, activate, and reset themes
Getting Help
Command Help
Get detailed help for any command using the --help flag:
List All Commands
List all available commands or filter by category:
Command Migration Guide
If you're upgrading from an earlier version of PteroCA, here's a quick reference for updating your scripts:
Common Command Migrations
Update Your Crontab
Before (v0.5.x):
After (v0.6+):
Update Your Scripts
Before:
After:
Running Commands
All commands should be run from the root directory of your PteroCA installation:
Additional Resources
Command Migration Guide - Full migration details
Crontab Configuration - Automation setup
System Configuration - Initial setup via CLI
Last updated