minicli下載 - minicli原始碼下載

minicli

其他類別

Version 4.2.0

下載

迷你型

用於建立以 CLI 為中心的 PHP 應用程式的極簡、無依賴框架

Minicli 是一個極簡、無依賴的框架，用於建立以 CLI 為中心的 PHP 應用程式。它提供了一種結構化的方式來組織命令，以及各種幫助程序，以方便使用命令參數、獲取用戶的輸入以及列印彩色輸出。

快速連結：

文件
示範
貢獻
貢獻者

無依賴：這意味著什麼

無依賴性意味著什麼？這意味著您可以建立一個工作的 CLI PHP 應用程序，而無需數十個嵌套的用戶級依賴項。基本的minicli/minicli套件僅具有測試相依性和單一系統需求：

PHP >= 8.1

注意：如果您想取得使用者輸入，也需要readline PHP 擴充功能。

它為您提供了很大的空間來選擇自己的依賴項。

入門

有兩種方法可以開始。如果您想要最低限度（我們稱之為「極簡應用程式」），您可以使用整個應用程式建立單一 PHP 腳本。如果您想要一個包含命令和子命令的更結構化的應用程序，那麼您應該使用命令命名空間將命令組織到控制器中。

極簡應用程式

如果您只想設定一些簡單的命令來透過minicli運行，您所需要做的就是建立一個App並將您的命令註冊為匿名函數。

建立一個空項目
執行composer require minicli/minicli - 這將產生一個新的composer.json檔案。
建立一個包含以下內容的minicli腳本：

 #!/usr/bin/env php
<?php

if ( php_sapi_name () !== ' cli ' ) {
    exit ;
}

require __DIR__ . ' /vendor/autoload.php ' ;

use Minicli  App ;
use Minicli  Command  CommandCall ;

$ app = new App ();
$ app -> setSignature ( ' ./minicli mycommand ' );

$ app -> registerCommand ( ' mycommand ' , function ( CommandCall $ input ) {
    echo " My Command! " ;

    var_dump ( $ input );
});

$ app -> runCommand ( $ argv );

然後，使其可執行並使用命令執行minicli ：

chmod +x minicli
./minicli mycommand

結構化應用程式（建議）

對於使用控制器和服務的更結構化的應用程序，最好使用命令命名空間。我們的應用程式模板儲存庫是以這種方式設定 Minicli 的一個很好的起點/模板。

若要使用minicli/application模板建立新項目，請執行：

 composer create-project --prefer-dist minicli/application myapp

這將產生如下目錄結構：

 .
app
└── Command
    └── Help
        ├── DefaultController.php
        ├── TableController.php
        └── TestController.php
├── composer.json
├── docs
├── LICENSE
├── minicli
├── mkdocs.yml
└── README.md

app/Command中的每個目錄都代表一個指令命名空間。 app/Command/Help中的類別代表您可以透過主help命令存取的子命令。

現在您可以使用以下命令運行引導應用程式：

./minicli help

該文件包含有關建立命令和使用輸出的更多詳細資訊。

顏色主題

Minicli 支援使用顏色主題來變更命令列輸出的樣式。除預設主題外，目前還有 3 個內建主題：

獨角獸：更豐富多彩的主題。
Dalton ：色盲友善主題。
德古拉：流行的黑暗主題。

若要設定主題，請在腳本中初始化 App 時傳入一個帶有theme值的配置陣列。內建主題需要一個前導字元：

 $ app = new App ([
    ' theme ' => ' Unicorn '
]);

若要使用預設的內建主題，請不要包含主題配置設置，或將其設置為空字串。

也可以在您的專案中建立和定義使用者定義的主題。在這種情況下，設定主題名稱，包括其名稱空間，不含前導：

 $ app = new App ([
    ' theme ' => ' AppThemeBlueTheme '
]);

上述設定將使用以下範例主題：

 <?php
// File : app / Theme / BlueTheme . php

namespace App  Theme ;

use Minicli  Output  Theme  DefaultTheme ;
use Minicli  Output  CLIColors ;

class BlueTheme extends DefaultTheme
{
    public function getThemeColors (): array
    {
        return [
            ' default '     => [ CLIColors:: $ FG_BLUE ],
            ' alt '         => [ CLIColors:: $ FG_BLACK , CLIColors:: $ BG_BLUE ],
            ' info '        => [ CLIColors:: $ FG_WHITE ],
            ' info_alt '    => [ CLIColors:: $ FG_WHITE , CLIColors:: $ BG_BLUE ]
        ];
    }
}