shinka-cli

Command line tool for developing MyBB plugins.

Features

• Quickly create (and delete) symlinks from your working directory to your MyBB root
• Bundle plugin for release

Documentation

See Documentation for detailed installation, configuration, and usage information.

Installation

Yarn

yarn global add shinka-cli

NPM

npm install --global shinka-cli

Configure

Create the utility's config file in the root of your app. See Configure for detailed instructions and example.

shinka.json

{
    "link": {
        "files": ["inc/plugins/shinka.php"],
        "directories": ["inc/plugins/Shinka"]
    },
    "mybb_root": "C:/path/to/mybb/root",
    "vendor": "shinka",
    "code": "cli",
    "version": "0.0.1-alpha.1"
}

Usage

See Usage or try shinka <command> --help for detailed options and examples.

Contributing

See Contributing for more information.