Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/slaff/ZendCliSkeleton
This Zend Framework 2 application is intended to be used as a bolierplate for your own command line applications.
https://github.com/slaff/ZendCliSkeleton
Last synced: 5 days ago
JSON representation
This Zend Framework 2 application is intended to be used as a bolierplate for your own command line applications.
- Host: GitHub
- URL: https://github.com/slaff/ZendCliSkeleton
- Owner: slaff
- License: other
- Created: 2014-07-22T14:48:28.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-10-11T13:21:39.000Z (about 7 years ago)
- Last Synced: 2024-08-03T11:08:41.893Z (4 months ago)
- Language: PHP
- Size: 10.7 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-zendframework - Zend Skeleton Cli
README
# Zend Cli Skeleton
This Zend Framework application is intended to be used as a boilerplate for your
own command line applications.
## Requirements
* PHP >= 5.6
* zfcampus/zf-console ^1.0
## Installation
Run composer install to get all dependant packages.
* Download the latest composer.phar file from https://getcomposer.org/composer.phar
and save it to the root directory of this project
* Run the following command from the root directory of this project:
```
php composer.phar install
```
## Usage
This application is console-aware. It has predefined the following console commands:
- `help`, which will list all available commands
- `version`, which will show you the current version information
- `autocomplete`, which provides auto-completion support for bash, zsh, and any
shell that understands auto-completion rules in a similar fashion.
Typical usage will look like this for your application:
```bash
$ php bin/cli.php help
```
## Development
Make sure to read the official documentation of
[zfcampus/zf-console](https://github.com/zfcampus/zf-console/blob/master/README.md)
and check the following files for an example of creating a new command in your
application.
- `config/routes.php` --> to find an example of defining a new command
- `src/ExampleHandler.php` --> to find an example of a command handler
## Build and Package
If you want to distribute your command line application and make it easier for
your users then you can give them one stand-alone file to run with
everything that is needed packed into it. In PHP this can be achieved by creating
a phar file (http://php.net/manual/en/intro.phar.php).
The ZendCliSkeleton comes with a built-in support for creating phar phar files.
In the build/ directory you will find phar.php file that creates for you such
file. Typical usage is:
```bash
$ php build/phar zf-tool
```
The command above will create a new file `build/zf-tool.phar` that you can
distribute. If you want the name of your app to be something else, then replace
`zf-tool` in the command above with the name of your choice.
There is also second command, targeting bash shell, that can help you automate clean
build of your phar file. If you run it like this:
```bash
$ bash build/build-phar.sh
```
The bash script will try to create you phar file by fetching the source code if
the application from its git repository, then download dependant libraries
described in the composer.json file and finally pack everything into one
`build/cli.phar` file.