arena-plugin-cli

Arena Plugin Dev Command Line Interface

Usage no npm install needed!

<script type="module">
  import arenaPluginCli from 'https://cdn.skypack.dev/arena-plugin-cli';
</script>

README

arena-plugin

Arena Plugin Dev Command Line Interface

oclif Version Downloads/week License

Usage

$ npm install -g arena-plugin-cli
$ arena-plugin COMMAND
running command...
$ arena-plugin (-v|--version|version)
arena-plugin-cli/0.2.1 win32-x64 node-v12.13.0
$ arena-plugin --help [COMMAND]
USAGE
  $ arena-plugin COMMAND
...

Commands

arena-plugin build

Build production plugin

USAGE
  $ arena-plugin build

OPTIONS
  -b, --bump=patch|minor|major  Auto versioning
  -d, --delete                  Delete old version
  -p, --publish                 Publish to Arena Market

DESCRIPTION
  ...
  Build production Arena plugin

See code: src\commands\build.js

arena-plugin build-theme

Building apt files from themes section

USAGE
  $ arena-plugin build-theme

DESCRIPTION
  ...
  Build all available theme from themes section in plugin.json

See code: src\commands\build-theme.js

arena-plugin dev

Develope your Arena plugins with hot reload.

USAGE
  $ arena-plugin dev

DESCRIPTION
  Develope your Arena plugins with hot reload, run this command under your project folder.
  Before you run this command, you need to:
  1. Create plugin.json and plugin entry file,
    you can also run <new> command to create a new plugin project.

  2. Open Arena, and run this command,
    once the plugin is ready, plugin button will appear at the top of the app.

See code: src\commands\dev.js

arena-plugin help [COMMAND]

display help for arena-plugin

USAGE
  $ arena-plugin help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

arena-plugin init [DIRNAME]

Create a empty Arena plugin project

USAGE
  $ arena-plugin init [DIRNAME]

DESCRIPTION
  Create an new empty Arena plugin project in current directory

See code: src\commands\init.js

arena-plugin install APFN

Install a plugin to Arena Editor

USAGE
  $ arena-plugin install APFN

ARGUMENTS
  APFN  The plugin file you want to install

DESCRIPTION
  ...
  Install a .arenap to Arena Editor

See code: src\commands\install.js

arena-plugin publish

Describe the command here

USAGE
  $ arena-plugin publish

OPTIONS
  -n, --name=name  name to print

DESCRIPTION
  ...
  Extra documentation goes here

See code: src\commands\publish.js

arena-plugin selfhost

Self hosting unix socket port for testing only

USAGE
  $ arena-plugin selfhost

See code: src\commands\selfhost.js