Galaxy CLI

1. # About Galaxy CLI
2. # Accessing DB From Galaxy CLI on Host Machine
3. # TypeRocket Commands
4. # Cache
5. # Config
6. # Core
7. # Extension
8. # Make
9. # Root
10. # Other
11. # WP Commands
12. # Manullay Configuring WP
13. # Galaxy For the TypeRocket WordPress Plugin
14. # Trouble Shooting
15. # Making a Command
16. # Coding Commands

#About Galaxy CLI

The Galaxy CLI comes with TypeRocket out of the box and has a number of commands to aid in the development process. You can access the CLI and the list of commands by entering the following in the command line:

php galaxy list

#Accessing DB From Galaxy CLI on Host Machine

When you are using a host machine for your development like Laravel Homestead you will want to be able to run DB enabled commands from the command line. To do this, you need to make sure your wp-config.php file can access the correct DB from your CLI.

Here is an example of a wp-config.php file designed to be run on the host and guest machine.

define('DB_NAME', 'wordpress');
define('DB_USER', 'homestead');
define('DB_PASSWORD', 'secret');

/** MySQL hostname with CLI access */
if( php_sapi_name() !== 'cli' || gethostname() == 'homestead' ) {
    define('DB_HOST', 'localhost');
} else {
    define('DB_HOST', '127.0.0.1:33060');
}

Note: You can always run your commands from the guest machine without extra configuration.

#TypeRocket Commands

There are a number of Galaxy commands.

#Cache

Commands to interface with the TypeRocket cache.

cache:clear        Clear Cache

#Config

Commands to interface with the TypeRocket config.

config:seed        Generate seed for app.php

#Core

Commands used to interface with TypeRocket core.

core:update        Update Core

#Extension

To publish custom TypeRocket enabled extensions.

extension:publish  Publish extension package

#Make

The make commands generate template code for you. These commands do not change configuration information or modify files. They create new files so you do not need to manually.

make:command       Make new command
make:component     Make new component
make:controller    Make new controller
make:middleware    Make new middleware
make:migration     Make new migration
make:model         Make new model
make:policy        Make new auth policy
make:service       Make new service

#Root

If you are using TypeRocket as the root of your project.

root:install       Install TypeRocket as root
root:mu            Install root MU plugin

#Other

Other commands.

help               Displays help for a command
list               Lists commands
migrate            Run migrations

#WP Commands

Commands to interface with WordPress.

wp:download        Download WordPress
wp:flush           Hard flush the WordPress rewrites
wp:maintenance     WordPress maintenance mode
wp:sql             WordPress database SQL script

To access WordPress command, you might need to configure the Galaxy CLI. In most cases, the tr_wp_root() function will do the work for you automatically.

Note: Be sure your CLI can access the database from its current host. For example, if you are using a VM, you might not be able to access the database of the guest machine.

#Manullay Configuring WP

To manually configure WP commands, locate your config/galaxy.php file, and find the wordpress setting. Change the wordpress setting to the directory that your wp-load.php file is located in. The wp-load.php file should be located at the root of your WordPress installation, where the wp-config-sample.php is located as well.

Note: The path that you choose might be different than what is located below.

/*
|--------------------------------------------------------------------------
| WordPress
|--------------------------------------------------------------------------
|
| Set to the WordPress root directory. This will enable new WP specific
| Galaxy commands like: SQL, Migrations, and Flushing Permalinks
|
| Example of root installation: TR_PATH . '/wordpress'
|
*/
'wordpress' => TR_PATH . '/wordpress',

#Galaxy For the TypeRocket WordPress Plugin

Navigate to the public root of your WordPress project. This is the location where the wp-settings.php file is located. In your main WordPress directory, copy the galaxy file to this location and add a file named galaxy-config.php .

Add the following code to your galaxy-config.php and point the $typerocket variable to your typerocket folder.

<?php
// galaxy-config.php
$typerocket = __DIR__ . '/wp-content/plugins/typerocket-pro-plugin/typerocket';
define('TR_GALAXY_PATH', $typerocket);
define('TR_CORE_CONFIG_PATH', $typerocket . '/config' );

Also, you might want to update where the galaxy command creates new files like models and controllers.

// The folder that contains your app folder
// not the app folder itself
define('TR_APP_ROOT_PATH', __DIR__ . '/wp-content/themes/my-theme');

#Trouble Shooting

If you have trouble connecting to MySQL from the Galaxy CLI, you may need to change your wp-config.php file. You can learn more about VM CLI access above.

#Making a Command

To make your own galaxy CLI command use the galaxy command make:command. Galaxy commands use the Symfony Console Package. Let's make a command named app:test.

php galaxy make:command Test app:test

This will output,

Command created: Test
Configure Command Test: Add your command to config/galaxy.php

You can now find your new command at app/Commands/Test.php. We will take a look at it next, but first, add the command to the galaxy.php configuration file.

'commands' => [
    \App\Commands\Test::class
]

Now run php galaxy list and check for:

app
  app:test         Short description here

Now run the command:

 php galaxy app:test

This will output,

Executed!

You are now ready to start building your command.

#Coding Commands

Here is the Test command class we just created. If you want to make your commands without the galaxy CLI, this can serve as a working template.

<?php
namespace App\Commands;

use \TypeRocket\Console\Command;

class Test extends Command
{

    protected $command = [
        'app:test',
        'Short description here',
        'Longer help text goes here.',
    ];

    protected function config()
    {
        // If you want to accept arguments
        // $this->addArgument('arg', self::REQUIRED, 'Description');
    }

    public function exec()
    {
        // When command executes
        $this->success('Execute!');
    }
}