ostark/craft-plugin-commands

Manage Craft plugins from the cli

1.1.0 2018-08-13 12:12 UTC

README

This is intentionally not a plugin, it's a Yii Extension. There is not need to bootstrap or enable it, it auto-registers itself.

Install

Require the package:

composer require ostark/craft-plugin-commands

Usage

Get a list of all plugins

./craft plugin/list

5 plugins found
╔═══════════════════════════╤════════════╤═══════════════╤═══════════════╗
║ Handle                    │ Version    │ Developer     │ Status        ║
╟───────────────────────────┼────────────┼───────────────┼───────────────╢
║ aws-s3                    │ 1.0.8      │ Pixel & Tonic │ Disabled      ║
╟───────────────────────────┼────────────┼───────────────┼───────────────╢
║ async-queue               │ 1.3.0      │ Oliver Stark  │ Enabled       ║
╟───────────────────────────┼────────────┼───────────────┼───────────────╢
║ fortrabbit-object-storage │ 0.1.0      │ Oliver Stark  │ Not installed ║
╟───────────────────────────┼────────────┼───────────────┼───────────────╢
║ happy-brad                │ v1.2       │ Matt Stauffer │ Enabled       ║
╟───────────────────────────┼────────────┼───────────────┼───────────────╢
║ upper                     │ 1.3.1      │ Oliver Stark  │ Not installed ║
╚═══════════════════════════╧════════════╧═══════════════╧═══════════════╝

Install & enable ALL or a single plugin

./craft plugin/install ALL
./craft plugin/install {plugin-handle}

Uninstall ALL or a single plugin

./craft plugin/uninstall ALL
./craft plugin/uninstall {plugin-handle}

Disable ALL or a single plugin

./craft plugin/disable ALL
./craft plugin/disable {plugin-handle}

Enable ALL or a single plugin

./craft plugin/enable ALL
./craft plugin/enable {plugin-handle}

Limit execution to specific environments with the --env-only flag. This option is only useful in automated deployment processes, e.g. post-install-cmds defined in a shared composer.json:

{
    "scripts": {
        "post-install-cmd": [
            "php craft plugin/disable {plugin-handle} --env-only=production",
            "php craft plugin/enable {plugin-handle} --env-only=dev,staging"
        ]
    }
}