https://github.com/asika32764/php-simple-console
Single file CLI framework to help you write build scripts.
https://github.com/asika32764/php-simple-console
argument-parser argv cli cli-app cli-framework console console-application console-framework stdin
Last synced: 2 months ago
JSON representation
Single file CLI framework to help you write build scripts.
- Host: GitHub
- URL: https://github.com/asika32764/php-simple-console
- Owner: asika32764
- Created: 2017-03-04T05:29:29.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-27T09:18:24.000Z (4 months ago)
- Last Synced: 2025-03-02T13:09:20.586Z (3 months ago)
- Topics: argument-parser, argv, cli, cli-app, cli-framework, console, console-application, console-framework, stdin
- Language: PHP
- Homepage: https://packagist.org/packages/asika/simple-console
- Size: 10.7 KB
- Stars: 21
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PHP Simple Console
Single file console framework to help you write build scripts.
## Installation
Use composer:
``` bash
composer require asika/simple-console
```
Download single file: [Download Here](https://raw.githubusercontent.com/asika32764/php-simple-console/master/src/Console.php)
CLI quick download:
```shell
# WGET
wget https://raw.githubusercontent.com/asika32764/php-simple-console/master/src/Console.php
chmod +x Console.php
# CURL
curl https://raw.githubusercontent.com/asika32764/php-simple-console/master/src/Console.php -o Console.php
chmod +x Console.php
```
## Getting Started
Use closure
``` php
#!/bin/sh php
execute(function (\Asika\SimpleConsole\Console $app)
{
// PHP 5.3
$app->out('Hello');
// PHP 5.4 or higher use $this
$this->out('Hello');
// Return TRUE will auto convert to 0 exitcode.
return true;
});
```
Or Create your own class.
``` php
class Build extends \Asika\SimpleConsole\Console
{
protected $help = <<
[Options]
h | help Show help information
v Show more debug information.
HELP;
protected function doExecute ()
{
$this->out('Hello');
// Return TRUE will auto convert to 0 exitcode.
return true;
}
}
$app = new Build;
$app->execute();
```
## Show HELP
Add `-h` or `--help` to show usage, you can add custom usage to `$this->help`, or override `$this->getHelp()`.
If you want to change `h` and `help` option, override `$this->helpOptions = array('...')`.
## Handle Error
Just throw Exception in `doExecute()`, Console will auto catch error.
``` php
throw new \RuntimeException('...');
```
Add `-v` to show backtrace if error.
## Handle Wrong Arguments
Wrong Argument use `\Asika\SimpleConsole\CommandArgsException`
``` php
$arg = $this->getArgument(0);
if (!$arg)
{
throw new \Asika\SimpleConsole\CommandArgsException('Please enter a name.');
}
```
Console will auto show help information.
``` bash
[Warning] Please enter a name.
[Usage] console.php
[Options]
h | help Show help info.
v Show more debug information.
```
## Multiple Commands
Use `delegate()` to delegate to different methods.
``` php
//...
protected function doExecute()
{
return $this->delegate($this->getArgument(0));
}
protected function foo()
{
$this->getArgument(1); // bar
}
protected function baz()
{
// ...
}
```
Now you can add sub commands
``` bash
php console.php foo bar
php console.php baz
```
If you want to strip first argument after delgated, you can follow this code:
``` php
$this->delegate(array_shift($this->args));
```
Now can use `getArgument(0)` in sub method and ignore the first command name.
The is another way:
``` php
$command = array_shift($this->args);
$this->delegate($command, ...$this->args);
```
``` php
protected function foo($first, $second = null)
{
}
```
## API
### `getArgument($order[, $default = null])`
``` php
$first = $this->getArgument(0, 'default value');
```
### `setArgument($order, $$value)`
``` php
$this->setArgument(1, 'value');
```
### `getOption($name: array|string[, $default = null])`
Get option `--foo`
``` php
$this->getOption('foo');
```
Get option `-f` or `--foo`, first match will return.
``` php
$this->getOption(array('f', 'foo'));
```
> NOTE:
> `-abc` will convert to `a => 1, b => 1, c => 1`
> And `-vvv` will convert to `v => 3`
### `setOption($name, $value)`
Set otpion to toption list. `$name` also support array.
### `out($string[, $newline: bool = false])`
Write to STDOUT,
``` bash
$this->out('Hello')->out('World');
```
### `err($string[, $newline: bool = false])`
Write to STDERR
``` bash
$this->err('Hello')->err('World');
```
### `in($string[$default = null, $bool = false)`
Ask a question, read from STDIN
``` bash
$un = $this->in('Please enter username: ', 'default_name');
```
Read as boolean, add true to third argument:
``` bash
$bool = $this->in('Are you sure? [Y/n]', [default true/false], true);
```
- `yes, y, 1, true` will convert to `TRUE`
- `no, n, 0, false` will convert to `FALSE`
### `exec($cmd)`
A proxy to execute a cmd by `exec()` and return value.
It will add a title `>> {your command}` before exec so you will know what has been executed.