awesome-packages / awesome-cli

一款出色的PHP命令行工具包

v1.2.0 2021-06-12 18:46 UTC

This package is auto-updated.

Last update: 2024-09-13 21:11:31 UTC


README

awesome-cli

Packagist Downloads GitHub code size in bytes Codecov CodeFactor Build Status GitHub issues GitHub pull requests Gitmoji

如何安装

使用以下命令安装包:

composer require awesome-packages/awesome-cli

如何使用

在composer.json中添加脚本

"scripts": {
    "awesome-cli": "./vendor/bin/awesome-cli"
}

创建你的命令类

<?php

namespace AwesomePackages\AwesomeCliTests\Mock;

use AwesomePackages\AwesomeCli\AwesomeCommand;

final class SayHelloWorldCommand extends AwesomeCommand
{
    protected string $group = 'say';
    protected string $action = 'hello-world';
    protected string $description = 'This is a simple description';

    public static function handle(): string
    {
        return 'Hello World';
    }
}

在src/config文件夹中创建commands.php文件

<?php

\AwesomePackages\AwesomeCli\CommandRunner::registerCommand([
    \AwesomePackages\AwesomeCliTests\Mock\SayHelloWorldCommand::class,
    ... // More commands
]);

文件夹结构如下所示

src
|_ commands
   |_ SayHelloWorldCommand.php
|_ config
   |_ commands.php

最后,运行以下命令:

composer awesome-cli say:hello-world

许可证

MIT © AwesomeCli