https://github.com/proophsoftware/prooph-cli
Command line tool for rapid development. Generate aggregates, commands, command handlers, command handler factories and event classes.
https://github.com/proophsoftware/prooph-cli
Last synced: 10 months ago
JSON representation
Command line tool for rapid development. Generate aggregates, commands, command handlers, command handler factories and event classes.
- Host: GitHub
- URL: https://github.com/proophsoftware/prooph-cli
- Owner: proophsoftware
- License: bsd-3-clause
- Created: 2016-01-08T12:05:15.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-04-28T18:33:26.000Z (about 10 years ago)
- Last Synced: 2025-07-21T11:14:07.684Z (11 months ago)
- Language: PHP
- Homepage: http://getprooph.org/
- Size: 61.5 KB
- Stars: 13
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# prooph Command Line Interface
## Overview
The prooph command line interface generates classes to increase development speed. For available commands run
```bash
$ php bin/prooph-cli list
```
Here is an example output:
```shell
Available commands:
help Displays help for a command
list Lists commands
prooph
prooph:generate:aggregate Generates an aggregate class
prooph:generate:all Generates an aggregate, command, command handler, command handler factory and event class.
prooph:generate:command Generates a command, command handler and command handler factory class
prooph:generate:event Generates an event class
```
There are available environment variables (see `bin/prooph-cli`) for bash scripts to configure
`\Prooph\Cli\Console\Helper\Psr4Info` for your class meta data.
## Installation
You can install prooph/prooph-cli via composer by adding `"proophsoftware/prooph-cli": "^0.1"` as requirement to your composer.json.
## Configuration
This tool checks if a [container-interop](https://github.com/container-interop/container-interop) instance is returned
from file `config/container.php`. You can configure the class info metadata by registering an instance with name
`\Prooph\Cli\Console\Helper\ClassInfo` like `\Prooph\Cli\Console\Helper\Psr4Info` to the container.
Another option is to use environment variables to configure your class metadata:
**env variables:**
* `PROOPHCLI_SOURCE_FOLDER`: path to src folder, default current working dir + 'src'
* `PROOPHCLI_PACKAGE_PREFIX`: namespace of package, default ''
* `PROOPHCLI_FILE_DOC_BLOCk`: file doc block, default ''
## Support
- Ask questions on [prooph-users](https://groups.google.com/forum/?hl=de#!forum/prooph) mailing list.
- File issues at [https://github.com/proophsoftware/prooph-cli/issues](https://github.com/proophsoftware/prooph-cli/issues).
- Say hello in the [prooph gitter](https://gitter.im/prooph/improoph) chat.
## Contribute
Please feel free to fork and extend existing or add new plugins and send a pull request with your changes!
To establish a consistent code quality, please provide unit tests for all your changes and may adapt the documentation.
## License
Released under the [New BSD License](LICENSE).