gem-hunter

Kirby CLI

Installation

Via Composer

composer global require getkirby/cli

composer -n config --global home

export PATH=~/.composer/vendor/bin:$PATH

Did it work?

kirby

Available core commands

- kirby backup
- kirby clean:content
- kirby clear:cache
- kirby clear:lock
- kirby clear:logins
- kirby clear:media
- kirby clear:sessions
- kirby download
- kirby help
- kirby install
- kirby install:kit
- kirby install:repo
- kirby license:info
- kirby license:renewal
- kirby make:blueprint
- kirby make:collection
- kirby make:command
- kirby make:config
- kirby make:controller
- kirby make:language
- kirby make:model
- kirby make:plugin
- kirby make:snippet
- kirby make:template
- kirby make:user
- kirby migrate:to:public-folder
- kirby migrate:to:root-folder
- kirby plugin:install
- kirby plugin:remove
- kirby plugin:upgrade
- kirby register
- kirby remove:command
- kirby roots
- kirby security
- kirby unzip
- kirby upgrade
- kirby uuid:duplicates
- kirby uuid:generate
- kirby uuid:populate
- kirby uuid:remove
- kirby version

Writing commands

kirby make:command hello

<?php

return [
    'description' => 'Nice command',
    'args' => [],
    'command' => static function ($cli): void {
        $cli->success('Nice command!');
    }
];

Command Classes

use Kirby\CLI\CLI;
use Kirby\CLI\Command;

class HelloWorld extends Command
{
	public static function args(): array
	{
		return [
			// optional args
		];
	}

	public static function command(CLI $cli): void
	{
		$cli->out('Hello world');
	}

	public static function description(): string|null
	{
		return 'The infamous hello world example';
	}
}

Global commands

kirby make:command hello --global

Command environment

env KIRBY_HOST=production.com kirby mycommand

Command plugins

Kirby::plugin('your/plugin', [
	'commands' => [
		'your-plugin:test' => [
			'description' => 'Nice command',
			'args' => [],
			'command' => function ($cli) {
				$cli->success('My first plugin command');
			}
		]
	]
]);

Command plugin with custom class

use Kirby\CLI\CLI;
use Kirby\CLI\Command;

class HelloWorld extends Command
{
	public static function args(): array
	{
		return [
			// optional args
		];
	}

	public static function command(CLI $cli): void
	{
		$cli->out('Hello world');
	}

	public static function description(): string|null
	{
		return 'The infamous hello world example';
	}
}

Kirby::plugin('your/plugin', [
	'commands' => [
		'helloworld' => HelloWorld::class
	]
]);

Check for installed commands

kirby

Removing commands

kirby remove:command hello

Debugging

kirby make:command hello --debug

Formatting Output

$cli->out()

$cli->out('This is some simple text');

$cli->success()

$cli->success('This is text in a nice green box');

$cli->error()

$cli->error('This is red text for errors');

$cli->bold()

$cli->bold('This is some bold text');

$cli->br()

// this will create a line break
$cli->br();

Arguments

<?php

return [
    'description' => 'Hello world',
    'args' => [
        'name' => [
            'description' => 'The name for the greeting',
            'required'    => true
        ]
    ],
    'command' => static function ($cli): void {
        $cli->success('Hello ' . $cli->arg('name') . '!');
    }
];

kirby hello Joe

Argument docs

Prompts

<?php

return [
    'description' => 'Hello world',
    'command' => static function ($cli): void {
        $name = $cli->prompt('Please enter a name:');
        $cli->success('Hello ' . $name . '!');
    }
];

<?php

return [
    'description' => 'Hello world',
    'args' => [
        'name' => [
            'description' => 'The name for the greeting',
        ]
    ],
    'command' => static function ($cli): void {
        $name = $cli->argOrPrompt('name', 'Please enter a name:');
        $cli->success('Hello ' . $name . '!');
    }
];

Checkboxes Radios and more

Combining commands

<?php

return [
    'description' => 'Downloads the starterkit and the plainkit',
    'command' => static function ($cli): void {

        $cli->command('install:kit', 'starterkit');
        $cli->command('install:kit', 'plainkit');

        $cli->success('Starterkit and plainkit have been installed');
    }
];

What's Kirby?