包简介

A lightweight framework for parsing command-line arguments and query parameters in PHP and executing commands.

README 文档

README

Clessicは、コマンドライン引数やクエリパラメータをパースし、PHPで書かれたコマンドを実行するための軽量フレームワークです。

特徴

コマンドライン引数、クエリパラメータをパースして、コマンドの実行
ANSIエスケープシーケンスに対応したカラー出力
依存ライブラリなしで動作

インストール

composer require clessic-php/clessic

使用方法

パースとコマンドの実行

次の例では、コマンドライン引数とクエリパラメータを共通のコードでパースし、コマンドを実行します。

<?php

$classLoader = require 'vendor/autoload.php';

use Clessic\Clessic;
use Clessic\Command;
use Clessic\Command\VirtualView;
use Clessic\Enum\ReturnCode;

// パスの設定
Clessic::addCommandPaths('Commands');
Clessic::addViewPaths('Views');
Clessic::addRequestBodyParserPaths('BodyParsers');
$classLoader->addPsr4('Modeles\\', 'Modeles');

// コマンドラインまたはクエリパラメータを入力として受け取る
$cmd = new Command(Clessic::$arguments);
$returnCode = $cmd->execute();
if(($returnCode instanceof ReturnCode) && $returnCode->isNotFound())
{
    $returnCode = $cmd->execute(VirtualView::class);
}

カラー出力の実行

ANSIエスケープに対応したコンソールではカラー出力が行えます。

<?php

require 'vendor/autoload.php';

use Clessic\Clessic;
use Clessic\Enum\AnsiEscCode;

echo Clessic::AnsiEscape(AnsiEscCode::ResetAll) . Clessic::AnsiEscape(AnsiEscCode::TextRed, "Hello, World!");

コマンドの追加

Clessic::addCommandPaths()で設定したディレクトリ下に sample.php という名前で、次のファイルを保存します。

<?php

namespace Clessic\Sample;

use Clessic\Base\CommandBase;
use Clessic\Enum\ReturnCode;
use Clessic\Enum\ArgumentType;
use Clessic\Enum\ArgumentMode;

if(!class_exists(SampleCommand::class)):
/**
 * サンプルコマンドクラス
 *
 * @package Clessic
 */
class SampleCommand extends CommandBase {
    /** @inheritdoc CommandBase */
    public static $package = 'sample';
    
    /** @inheritdoc CommandBase */
    public static $description = 'サンプルコマンドの説明文';
    
    /** @inheritdoc CommandBase */
    public static $version = 'v1.0.0-stable';
    
    /** @inheritdoc CommandBase */
    public static $options = [
        'name' => [
            ArgumentType::String,
            ArgumentMode::Single,
            '-n',
            '--name',
            '@名前を指定するオプション',
        ],
        'help' => [
            ArgumentType::Help,
            '-h',
            '--help',
            '@ヘルプを表示するためのフラグ',
        ]
    ];

    /** @inheritdoc CommandBase */
    public static function run(array $args, mixed $body, array $headers): int|ReturnCode {
        $name = $args['name'] ?? 'default';
        echo "Hello, " . $name . "!" . PHP_EOL;
        return ReturnCode::Success;
    }
}
endif;
return SampleCommand::class;

次のコマンドで実行すると、"Hello, World!" と出力されます。

php （パースとコマンドの実行を保存したファイル名） sample -n World

ビューの追加

Clessic::addViewPaths()で設定したディレクトリ下に index.php という名前で、次のファイルを保存します。

<?php return function(...$_){ ?>
<!DOCTYPE html>
<html lang="ja">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Sample View</title>
    <style>
        body {
            font-family: Arial, sans-serif;
            background-color: #f4f4f4;
            margin: 0;
            padding: 0;
        }
        .container {
            width: 80%;
            margin: 50px auto;
            padding: 20px;
            background-color: #fff;
            box-shadow: 0 0 10px rgba(0, 0, 0, 0.1);
        }
        h1 {
            color: #333;
        }
        p {
            color: #666;
        }
    </style>
</head>
<body>
    <div class="container">
        <h1>Sample View</h1>
        <p>This is a sample view created for the Clessic framework.</p>
    </div>
    <script src="https://cdn.jsdelivr.net/gh/clessic-php/clessic@1.0/Clessic.min.js"></script>
    <script>
        var command = new Clessic();
        command.run(["sample", "-n", "World"]).then(function(result){
            console.log(result); // Hello, World!
        })
    </script>
</body>
</html>
<?php
};

カスタムリクエストボディパーサの追加

Clessic::addRequestBodyParserPaths()で設定したディレクトリ下に application-json.php という名前で、次のファイルを保存します。

<?php
return function($body, $params)
{
    return json_decode($body, true);
};

リクエストヘッダーContent-Type: application/jsonでJSONリクエストボディを送信したコマンドは、run()の第2引数をJSONをパースした値が渡されます。

ライセンス

このプロジェクトは MIT ライセンスの下でライセンスされています。詳細は LICENSE ファイルを参照してください。

clessic-php/clessic 适用场景与选型建议

clessic-php/clessic 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 10 次下载、GitHub Stars 达 0，最近一次更新时间为 2025 年 02 月 25 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「framework」「cli」「command」「ANSI-escape」「query-parameters」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 clessic-php/clessic 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 clessic-php/clessic 我们能提供哪些服务？

定制开发 / 二次开发

基于 clessic-php/clessic 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 clessic-php/clessic 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

phphleb/hleb 292

PHP Framework HLEB2 is the foundation of the web application. Provides ease of development and application performance.

demvsystems/exec 2

A Wrapper for exec and it's results

neogen/command-scheduler 0

Symfony bundle to monitor and execute commands

sp4ceb4r/shell-command 3

Shell command module for PHP.

fsc/batch 18

Library with classes to help you do batch.

jildertmiedema/commander 0

Command bus implementation: Commands and domain events

clessic-php/clessic

包简介

关键字：