Creating New CLI Tools

Guide to adding new commands to mokoplatform.

Steps

Create script in cli/:

touch cli/my_new_tool.php
chmod +x cli/my_new_tool.php

Extend CliBase (simple) or CliFramework (complex):

<?php
declare(strict_types=1);
require_once __DIR__ . '/../lib/CliBase.php';

class MyNewTool extends CliBase
{
    protected string $description = 'What this tool does';

    protected function run(): int
    {
        $path = $this->getOption('path', '.');
        if ($this->dryRun) {
            $this->info('[DRY RUN] Would process: ' . $path);
            return 0;
        }
        // ... do work
        $this->success('Done');
        return 0;
    }
}

(new MyNewTool())->execute();

Register in bin/moko command registry
Add wrapper (optional) in wrappers/ for CI usage
Add test in tests/

Conventions

Script filename: snake_case.php
Command name: group:action (e.g., build:joomla)
Always support --dry-run for destructive operations
Always support --verbose for debug output
Always support --path for target directory
Use $this->info(), $this->success(), $this->error() for output

Pages