CLI

This package allows you to build scripts in a more structured way.

Installation

composer require innmind/cli:~3.6

Usage

cli.php

<?php
declare(strict_types = 1);

require 'path/to/composer/autoload.php';

use Innmind\CLI\{
    Main,
    Environment,
};
use Innmind\OperatingSystem\OperatingSystem;

new class extends Main {
    protected function main(Environment $env, OperatingSystem $os): Environment
    {
        return $env->output(Str::of("Hello world\n"));
    }
};

If you run php cli.php in your terminal it will print Hello world.

You should already be familiar with the $os variable by now, if not go the dedicated chapter.

The $env variable is the abstraction to deal with everything inputed in your script and every output that comes out. It behaves like an immutable object, meaning you must always use the new instance returned by its methods.

To change the returned exit code you can do return $env->exit(1).

If you only have one action in your script you can do everything in the main method. But if you want to expose multiple commands you can do:

cli.php

use Innmind\CLI\{
    Commands,
    Console,
    Command,
};

new class extends Main {
    protected function main(Environment $env, OperatingSystem $os): Environment
    {
        $commands = Commands::of(
            new class implements Command {
                public function __invoke(Console $console): Console
                {
                    return $console->output(
                        Str::of('Hello ')->append(
                            $console->arguments()->get('name'),
                        ),
                    );
                }

                public function usage(): string
                {
                    return 'greet name';
                }
            },
            new class implements Command {
                public function __invoke(Console $console): Console
                {
                    return $console->output(
                        Str::of($console->arguments()->get('name'))
                            ->toUpper()
                            ->prepend('Hello '),
                    );
                }

                public function usage(): string
                {
                    return 'shout name';
                }
            },
        );

        return $commands($env);
    }
};

If you run php cli.php greet Jane it will output Hello Jane and if you run php cli.php shout John it will output Hello JOHN.

Info

For simplicity this example use anonymous classes but you can use any class as long as it implements Command.