inkplugin
=========

INK cli tools for plugin developers.


* Installation
* Usage
* Commands

Installation

To install the latest stable version:
``sh-session
$ npm install -g inkplugin
`
OR
`sh-session
$ yarn global add inkplugin
`

Usage



`sh-session
$ npm install -g inkplugin
$ inkplugin COMMAND
running command...
$ inkplugin (-v|--version|version)
inkplugin/0.3.3 darwin-x64 node-v14.17.6
$ inkplugin --help [COMMAND]
USAGE
$ inkplugin COMMAND
...
`

Commands

* inkplugin create PATH
* inkplugin hash PATH
* [inkplugin help [COMMAND]](#inkplugin-help-command)
* [inkplugin package [PATH]](#inkplugin-package-path)

inkplugin create PATH

creates starter INK plugin project.

`
USAGE
$ inkplugin create PATH

ARGUMENTS
PATH Path for project creation.

OPTIONS
-m, --module-worker Enables ES6 Modules support for your plugin.

DESCRIPTION
With just single command you can generate starter plugin project that will have all the basic things ready to start
writing your own INK plugin.
`

_See code: src/commands/create.js_

inkplugin hash PATH

Create Hash for your plugin

`
USAGE
$ inkplugin hash PATH

ARGUMENTS
PATH Path for plugin project root.

DESCRIPTION
Hash can be used to maintain your plugin's integrity across devices.
`

_See code: src/commands/hash.js_

inkplugin help [COMMAND]

display help for inkplugin

`
USAGE
$ inkplugin help [COMMAND]

ARGUMENTS
COMMAND command to show help for

OPTIONS
--all see all commands in CLI
`

_See code: @oclif/plugin-help_

inkplugin package [PATH]

package INK plugin project into a DYE file.

`
USAGE
$ inkplugin package [PATH]

ARGUMENTS
PATH [default: ./] Path to plugin project.

OPTIONS
-o, --output=output destination path for DYE file

DESCRIPTION
It will package your INK plugin project into a DYE file, which can be used to install your plugin in INK editor.
``

_See code: src/commands/package.js_