documentation/community/tutorials/artisan.md

Artisan CLI

::: tip Artisan is a file located within your Pterodactyl installation directory. If you followed the official guide, it should be /var/www/pterodactyl. :::

::: tip To simplify this documentaiton, in command usage you'll see things like the following:

<hello-world> - Required argument

[hello-wolrd] - Optional argument

{--hello-world} - Option

:::

The Artisan CLI, command line interface, is part of the Laravel framework, which Pterodactyl is built on. 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>

User Management

Create/Make User

php artisan p:user:make {--email=user@example.com}
                        {--username=myusername}
                        {--name-first=My}
                        {--name-last=Name}
                        {--password=supersecret}
                        {--admin=1|0}
                        {--no-password}

If you don't include the optional arguments, it will instead use an interactive prompt to guide you through the user creation process.

Delete/Remove User

php artisan p:user:delete {--user=username/email/UUID}

If you don't include the optional argument, it will instead use an interactive prompt to ask you for the information on the user to remove.

Disable 2FA

::: 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=user@example.com}

If you don't include the optional argument, it will instead use an interactive prompt to ask you for the email address associated with the user.

Server/Node Management

Create/Make Location

php artisan p:location:make {--short=us1}
                            {--long="A description of this location."}

Delete Location

php artisan p:location:delete {--short=us1}

Server Bulk Power

php artisan p:server:bulk-power <start, stop, kill, restart>
                                {--servers=1,2,3}
                                {--nodes=1,2,3}

Server Rebuild

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.

Panel Management

View Panel Info

php artisan p:info

Displays a variety of panel information which can be used to check the configuation of this like database and email.

Cleanup Service Backups

php artisan p:maintenance:clean-service-backups

When modifying services, backup files are created. This command cleans up these backups in the storage directory.

Cleanup API Keys

php artisan p:migration:clean-orphaned-keys

When API keys are created, they assigned a role. Over time, there may be keys created that are not assigned a role and removes them from the database completely.

Theme Management

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.

List All Themes

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.

Install a Theme

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.

Create a Theme

php artisan theme:create [theme-name]

Remove a Theme

php artisan theme:remove [theme-name]