PHPackages                             taro/chant-cli - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. taro/chant-cli

ActiveLibrary[CLI & Console](/categories/cli)

taro/chant-cli
==============

Php micro console framework

v1.0.4(3y ago)010MITPHP

Since Oct 29Pushed 3y ago1 watchersCompare

[ Source](https://github.com/tekku-taro/chant-cli)[ Packagist](https://packagist.org/packages/taro/chant-cli)[ RSS](/packages/taro-chant-cli/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (4)Versions (6)Used By (0)

Chant Cli
=========

[](#chant-cli)

PHP製コンソールアプリケーション作成用の簡易フレームワークです。簡単にコマンドを作成し、コマンドラインで実行できます。

特徴
--

[](#特徴)

- コンソールアプリケーションを作成するための、基本的な機能を提供するフレームワーク
- 個々のコマンドに対する処理をコマンドクラスに記述し、アプリに登録するだけで、実行可能
- 入力するコマンドに関して、オプション引数やパラメーター、フラグを追加できる
- 出力する文字列に色を付けたり、テーブルで整形できる
- ユーザへ質問や確認するメソッドなどが用意されていて、対話的に処理を実行できる

ディレクトリ構造
--------

[](#ディレクトリ構造)

```
src
├── app
│   ├── bootstrap
│   │   └── config.php	                       # 設定ファイル
│   └── console
│        ├── commands						 # アプリのコマンドクラス
│        │   ├── TestCommand.php
│        │   └── TestCommand2.php
│        └── CommandList.php				  # 登録されたコマンドのリスト
├── libs									# ライブラリ本体
│   ├── Application.php		            	   # アプリケーションクラス
│   ├── Errors								 # 例外クラス
│   ├── IOInterface		            		   # 入出力関連
│   ├── Command		            			  # コマンド継承元と登録
│   │   ├── Command.php
│   │   └── CommandRegistry.php
│   ├── Signature			　　　   		   # 入力するコマンドの情報
│   └── Utility	 				    		 # ユーティリティ
... etc
├── .env				             	      # 環境変数情報
└── chant				                      # appのエントリーポイント

```

基本的な使い方
-------

[](#基本的な使い方)

1. コマンド作成のための以下のコマンドをターミナル（bash）上で実行

    ```
    # ./chant command:make [コマンド名]
    ./chant command:make SampleCommand
    ```

    app/console/commands 配下に **SampleCommand.php** ファイルが作成される
2. SampleCommand.php ファイルを編集

    ```