https://github.com/mcstreetguy/smartconsole

The smarter php console toolkit.
https://github.com/mcstreetguy/smartconsole

cli cli-toolkit command-line-tool console php php-library php7 toolkit

Last synced: 8 months ago
JSON representation

The smarter php console toolkit.

• Host: GitHub
• URL: https://github.com/mcstreetguy/smartconsole
• Owner: MCStreetguy
• License: mit
• Archived: true
• Created: 2018-10-03T11:13:20.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-11-27T10:40:36.000Z (over 7 years ago)
• Last Synced: 2024-09-30T13:01:21.295Z (over 1 year ago)
• Topics: cli, cli-toolkit, command-line-tool, console, php, php-library, php7, toolkit
• Language: PHP
• Homepage: https://smartconsole.readthedocs.io/
• Size: 142 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# SmartConsole

**The smarter php console toolkit.**

[![GitHub issues](https://img.shields.io/github/issues/MCStreetguy/SmartConsole.svg)](https://github.com/MCStreetguy/SmartConsole/issues)

[![GitHub forks](https://img.shields.io/github/forks/MCStreetguy/SmartConsole.svg)](https://github.com/MCStreetguy/SmartConsole/network)

[![GitHub stars](https://img.shields.io/github/stars/MCStreetguy/SmartConsole.svg)](https://github.com/MCStreetguy/SmartConsole/stargazers)

[![GitHub license](https://img.shields.io/github/license/MCStreetguy/SmartConsole.svg)](https://github.com/MCStreetguy/SmartConsole/blob/master/LICENSE)

[![GitHub (pre-)release](https://img.shields.io/github/release/MCStreetguy/SmartConsole/all.svg)](https://github.com/MCStreetguy/SmartConsole/releases)

[![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/MCStreetguy/SmartConsole.svg)](https://github.com/MCStreetguy/SmartConsole/releases)

[![GitHub last commit](https://img.shields.io/github/last-commit/MCStreetguy/SmartConsole.svg)](https://github.com/MCStreetguy/SmartConsole/commits/master)

[![GitHub top language](https://img.shields.io/github/languages/top/MCStreetguy/SmartConsole.svg)](https://github.com/MCStreetguy/SmartConsole/search?l=php&type=Code)

[![GitHub contributors](https://img.shields.io/github/contributors/MCStreetguy/SmartConsole.svg)](https://github.com/MCStreetguy/SmartConsole/graphs/contributors)

[![Documentation Status](https://readthedocs.org/projects/smartconsole/badge/?version=latest)](https://smartconsole.readthedocs.io/en/latest/?badge=latest)

Have you ever wondered why it is so complicated to write a console application in PHP?

Whichever library you use, you'll end up with hundreds of lines of configuration before you can even read the first 'Hello World' in the terminal.

_That's over now!_ SmartConsole is the first console toolkit for PHP that you hardly have to configure at all.

All you do is write classes as you are used to and document them properly.

Smart Console analyzes your command handlers and makes all settings automatically so you can sit back and concentrate on your real goal.

SmartConsole is wrapped around the great [webmozart/console](https://github.com/webmozart/console) package and its approach is based on the CLI of the ingenious [Neos CMS](https://www.neos.io/).

Besides it merges together some of the basic functionalities from the underlying console-package and advanced features like progress-bars from [CLImate](https://climate.thephpleague.com/).

Read on to learn more about how to use it.

## Installation

Require the library through Composer:

``` bash

$ composer require mcstreetguy/smart-console

```

## Usage

Check out the [official documentation](https://smartconsole.readthedocs.io/) for more information on how to use this library.

## Contributing

If you find any bug or have a suggestion for an improvement or new feature, visit the [Issues-page](https://github.com/MCStreetguy/SmartConsole/issues) and leave a notice.

Please check if something similar has already been reported in any case to prevent duplicates.

Feel free to modify the source code on your own and create a [pull-request](https://github.com/MCStreetguy/SmartConsole/pulls) in conjunction with your improvement or bug.

## License

SmartConsole is licensed under the MIT license. A copy of that license is distributed together with the source code.

You may find that file under `/LICENSE` in the projects root directory or online at: https://github.com/MCStreetguy/SmartConsole/blob/master/LICENSE

### Disclaimer

_(taken from the LICENSE file, slightly adapted in favour of readability)_

> The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, wheter in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.