silverleague/silverstripe-console

Repository: https://github.com/silverleague/silverstripe-console
Specification: https://silverleague.github.io/development/silverstripe-console

Introduction

The SilverLeague Console is a Symfony console application which interfaces directly with a SilverStripe application for a better command line experience.

Use case

The SilverStripe framework ships with a built in CLI management tool - "framework/cli-script.php". It also has a bash wrapper called "sake". This tool essentially lets you run controllers from the command line in much the same way as you would from the browser, while providing added benefits such as not having to worry about web server timeouts, being able to run in a cron task, etc.

This tool is limited. The SilverLeague console aims to replace its use with a more powerful, flexible and featured tool for managing SilverStripe applications.

Aims over other community modules

There are some existing CLI modules for SilverStripe among the community already. This module is going to be built with the following focusses:

• SilverLeague concepts first
• PHP 5.6+ minimum (in turn, PHPUnit 5.7)
• SilverStripe 4 minimum (?)
• Don't use "sake" or variations of the same, since they mean nothing to unaware developers
• Don't ship as a module that should be installed into a SilverStripe application - should run standalone

This module would not support SilverStripe 3.x at this stage. Users would be recommended to use an established console like "supersake" for legacy framework/CMS support.

Functionality

• Most importantly the console will automatically detect all BuildTask instances from the SilverStripe application and expose them as console commands
• Database build, manifest flushing: Enhancement: database build and manifest flush silverstripe-console#9
• Database management (import, dump, dev-stripping): Enhancement: database management - import, export, exclude tables silverstripe-console#5
• Asset management (import, dump): Enhancement: asset management - import, export silverstripe-console#6
• Member management (create, change password, change groups)
• Cache management (clear, inspect, clear individual areas): Enhancement: cache management - flush, inspect, remove individually silverstripe-console#4
• Config inspection - search by class name or property name: Enhancement: configuration - show all, search by class name or property silverstripe-console#3
• Module creation - initialise a new module, choose classes to extend and choose new DataObjects to create: Enhancement: module creator silverstripe-console#8
• Extensibility - ability to add custom commands to a user directory, or specific folder in a SilverStripe application to be run by the console: Enhancement: console should be extensible silverstripe-console#7
• SilverStripe Extensions - list by class name: Enhancement: list extensions of a class silverstripe-console#1
• Concrete extensions - list by class name: Enhancement: list a class's children silverstripe-console#2
• Delete DataObjects - ability to remove DataObjects by class name and ID/URL route: Enhancement: Delete DataObject by class name and URL Route/ID silverstripe-console#28
• DataObject debug output (dump) - ability to dump a DataObject by class name and ID/URL route with output formatted cleanly: Enhancement: Debug output for a DataObject silverstripe-console#29
• Discussion: Support both 3.x and 4.x versions without needing a different console version installed Removed

License

To be released under the MIT license.