diff --git a/src/Admin_Tools_Command.php b/src/Admin_Tools_Command.php index f1d1dad..270f7f9 100644 --- a/src/Admin_Tools_Command.php +++ b/src/Admin_Tools_Command.php @@ -11,9 +11,7 @@ * @package ee-cli */ -use Composer\Console\Application; use EE\Model\Site; -use Symfony\Component\Console\Input\ArrayInput; use Symfony\Component\Filesystem\Filesystem; use function EE\Site\Utils\auto_site_name; @@ -41,7 +39,13 @@ public function __construct() { } /** - * Installs admin-tools for EasyEngine. + * Installs admin tools for EasyEngine. + * + * ## EXAMPLES + * + * # Install admin tools + * $ ee admin-tools install + * */ public function install() { @@ -88,7 +92,7 @@ public function install() { } /** - * Enables admin-tools on given site. + * Enables admin tools on site. * * ## OPTIONS * @@ -97,6 +101,15 @@ public function install() { * * [--force] * : Force enabling of admin-tools for a site. + * + * ## EXAMPLES + * + * # Enable admin tools on site + * $ ee admin-tools up example.com + * + * # Force enable admin tools on site + * $ ee admin-tools up example.com --force + * */ public function up( $args, $assoc_args ) { @@ -153,6 +166,15 @@ public function up( $args, $assoc_args ) { * * [--force] * : Force disabling of admin-tools for a site. + * + * ## EXAMPLES + * + * # Disable admin tools on site + * $ ee admin-tools down example.com + * + * # Force disable admin tools on site + * $ ee admin-tools down example.com --force + * */ public function down( $args, $assoc_args ) {