library porter

silverstripe/porter

Adds useful cli commands for the SilverStripe framework.

SilverStripe Porter

, _(*1)

SilverStripe Porter (think kitchen porter) seeks to automate several menial tasks for the SilverStripe framework via cli., _(*2)

Tasks currently supported: * Creating a new module, _(*3)

Installation

It is recommended to install globally using composer, _(*4)

composer require global silverstripe/porter dev-master

After installation, create a symlink as follow (Note, adapt this command to your OS):, _(*5)

ln -s ~/.composer/vendor/silverstripe/porter/silverstripe ~/.composer/bin/silverstripe

Reloading your profile (source ~/.bash_profile) means you can now run silverstripe to view the help menu., _(*6)

Usage

Creating a new module

The full command with all options is:, _(*7)

silverstripe create-module [--nonVendor] [--ss3] [--withTravisCI] [--withCircleCI] [--] <module-name> <module-namespace> [<module-path>]

• --nonVendor option adds type: silverstripe-module to your composer.json. This defaults to type: silverstripe-vendormodule
• --ss3 option sets your module up with a base skeleton for an SilverStripe 3 module
• --withTravisCI adds minimal a travis.yml setup file
• ---withCircleCI adds a minimal CircleCI config file to a .circleci folder

Example usage:, _(*8)

silverstripe create-module --withTravisCI foo/bar Foo\\\\Bar\\\\

Bugtracker

Bugs are tracked on github.com., _(*9)

Development and Contribution

If you would like to make changes to this module, go on then, raise a PR via GitHub., _(*10)

Links

• Bugtracker
• License

Credits

• Ingo Schommer - https://github.com/chillu
• Robbie Averill - https://github.com/robbieaverill