The Artisan CLI, command line interface, is part of the Laravel framework, which Pterodactyl is built on. The Artisan file is located in /var/www/pterodactyl
if you followed the official guide. This guide goes over some more Pterodactyl specific/related Artisan commands, which are all prefixed with the letter p
(e.g. p:user:make
). If you'd like to view all commands, you can do so by running:
php artisan list
To get information regarding a specific command you can do so by running:
php artisan help <command>
TIP
To simplify this documentation, in command usage you'll see things like the following:
<hello-world>
- Required argument
[hello-world]
- Optional argument
{--hello-world}
- Option
When running any of the following commands, you can either use the options or don't pass through anything and use the interactive prompt. You can also do both passing through options and using interactive prompts as well.
php artisan p:user:make {--email=[email protected]}
{--username=myusername}
{--name-first=My}
{--name-last=Name}
{--password=supersecret}
{--admin=1|0}
{--no-password}
php artisan p:user:delete {--user=username/email/UUID}
WARNING
Disabling 2-factor authentication should only be used as a last restort for user recovery. Please use this with caution.
php artisan p:user:disable2fa {--email=[email protected]}
php artisan p:location:make {--short=us1}
{--long="A description of this location."}
php artisan p:location:delete {--short=us1}
php artisan p:server:bulk-power <start, stop, kill, restart>
{--servers=1,2,3}
{--nodes=1,2,3}
php artisan p:server:rebuild [server-id] {--node=1}
This will initiate a rebuild on all servers, all servers on a node, or a specific server depending on the information given.
php artisan p:info
Displays a variety of panel information which can be used to check the configuation of this like database and email.
This is a commonly missed section of commands, but they exist and more people should be aware of them. Pterodactyl has a built in theming system and with that comes a variety of commands for managing them easier.
php artisan theme:list
This is will show a table of all currently installed themes along with their views and asset paths. This does not show themes that are ready to be installed, only installed themes.
php artisan theme:install [theme-name]
This will search for the file with the theme name followed by a .theme.tar.gz
(standard Igaster theme packaged). If no theme name is provided, it will load all themes and give you a selection to install from.
php artisan theme:create [theme-name]
php artisan theme:remove [theme-name]