Celemas Cli

ci code coverage type coverage psalm level Software License

A command line interface helper.

Features

• Simple command creation with automatic help generation
• Built-in color support for terminal output
• Command-specific help with php run help <command>
• Built-in commands command for shell autocomplete
• Support for --key=value and --key value option syntax
• Output helpers: info(), success(), warn(), error(), echoln()
• Text indentation and wrapping with indent()
• Debug mode for detailed error traces
• 100% test coverage

Installation

composer require celemas/cli

Quick Start

Create a command by extending Celemas\Cli\Command:

use Celemas\Cli\Command;
class MyCommand extends Command {
 protected string $name = 'mycommand';
 protected string $group = 'MyGroup';
 protected string $description = 'This is my command';
 public function run(): int
 {
 $this->info("Running my command");
 $this->success("Command completed!");
 return 0;
 }
}

Create a runner script:

<?php
require __DIR__ . '/vendor/autoload.php';
use Celemas\Cli\{Runner, Commands};
$commands = new Commands([new MyCommand()]);
$runner = new Runner($commands);
$runner->run();

Run your command:

$ php run mycommand
Running my command
Command completed!

License

This project is licensed under the MIT license.