CLI Parser and Handler

Type safe CLI parser and command handler for PHP inspired by Kong.

Features

• Casts arguments and options into objects.
• Command bus and middleware architecture.
• Parsing
  • Command nesting
  • Type support for string, int, float, boolean and lists.
  • Repeated arguments
  • Optional arguments
  • Long and short options
  • Boolean options (flags)
  • List options

Usage Example

<?php

use PhpTui\CliParser\ApplicationBuilder;
use PhpTui\CliParser\Application\Context;
use PhpTui\CliParser\Application\Middleware\ExceptionHandlingMiddleware;
use PhpTui\CliParser\Application\Middleware\HelpMiddleware;
use PhpTui\CliParser\Attribute\App;
use PhpTui\CliParser\Attribute\Cmd;
use PhpTui\CliParser\Attribute\Opt;
use PhpTui\CliParser\Attribute\Arg;
use PhpTui\CliParser\Printer\AsciiPrinter;

#[App(name: 'Git', version: '1.0', author: 'Daniel Leech')]
final class GitCmd
{
    public CloneCmd $clone;

    public InitCmd $init;

    #[Opt(short: 'v', long: 'version', help: 'Create an empty git repository')]
    public bool $version = false;

    #[Opt(help: 'Show help')]
    public bool $help = false;

    #[Opt(short: 'C', help: 'Run git as ig it were executed in this path')]
    public string $cwd;
}

#[Cmd(help: 'Clone a repository into a new directory')]
final class CloneCmd
{
    #[Arg(help: 'Repository to clone', required: true)]
    public string $repo;

    #[Opt(name: 'recurse-submodules', short: 'R', help: 'Initialize submodules in the clone')]
    public bool $recurseSubModules = false;
}

#[Cmd(help: 'Create an empty git repository')]
final class InitCmd
{
    #[Arg(help: 'Repository to clone')]
    public string $repo;

    #[Opt(name: 'recurse-submodules', help: 'Initialize submodules in the clone')]
    public bool $recurseSubModules;
}

$cli = new GitCmd();
$cli->init = new InitCmd();
$cli->clone = new CloneCmd();

$application = ApplicationBuilder::fromSpecification($cli)
    ->prependMiddleware(new HelpMiddleware(new AsciiPrinter()))
    ->addHandler(InitCmd::class, function (Context $ctx) {
        echo 'Initializing' . "\n";
        return 0;
    })
    ->addHandler(CloneCmd::class, function (Context $ctx) {
        echo sprintf('Git cloning %s...', $ctx->command()->repo) . "\n";
        if ($ctx->command()->recurseSubModules) {
            echo '... and recursing submodules' . "\n";
        }
        return 0;
    })
    ->build();

exit($application->run($argv));

Contribution

Contribute!