inkplugin/README.md

INK cli tools for plugin developers.

inkplugin
=========

INK cli tools for plugin developers.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/inkplugin.svg)](https://npmjs.org/package/inkplugin)
[![Downloads/week](https://img.shields.io/npm/dw/inkplugin.svg)](https://npmjs.org/package/inkplugin)
[![License](https://img.shields.io/npm/l/inkplugin.svg)](https://github.com/https://github.com/inkcontent/inkplugin/blob/master/package.json)

<!-- toc -->
* [Installation](#installation)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Installation

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

# Usage
<!-- 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
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`inkplugin create PATH`](#inkplugin-create-path)
* [`inkplugin hash 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](https://github.com/inkcontent/cli/blob/v0.3.3/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](https://github.com/inkcontent/cli/blob/v0.3.3/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](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_

## `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](https://github.com/inkcontent/cli/blob/v0.3.3/src/commands/package.js)_
<!-- commandsstop -->