https://github.com/minicli/command-help

Minicli default help command
https://github.com/minicli/command-help

Last synced: 6 days ago
JSON representation

Minicli default help command

• Host: GitHub
• URL: https://github.com/minicli/command-help
• Owner: minicli
• License: mit
• Created: 2022-06-02T17:23:20.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-07T14:00:23.000Z (over 1 year ago)
• Last Synced: 2024-11-29T06:39:39.626Z (24 days ago)
• Language: PHP
• Size: 21.5 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Minicli Help Command

Default help command. This will auto-generate a command/sub-command tree based on all commands registered within the CommandRegistry, and print it to users that call './minicli help'.

## Usage

First, import this command with Composer:

```shell

composer require minicli/command-help

```

Then, edit your app's config to include `@minicli/command-help` within your `app_path` definitions. For instance:

```php

$app = new App([

    'app_path' => [

            __DIR__ . '/app/Command',

            '@minicli/command-help'

        ],

    'debug' => true

]);

```

You should now be able to run the `./minicli help` command and obtain output that will vary depending on your own implemented commands. Here is an example:

```

Available Commands

help

└──table

└──test

```