Skip to content

Repository files navigation

StreamBoard Logo

Stream Board CLI

GitHub Workflow Status (branch)Codacy BadgenpmCode Style: GoogleCode: TypeScriptMade By: StudiMax

This project is the official plugin builder for the Stream Board project.

Installation

# with npm
$ npm install streamboard-cli -g
# with yarn
$ yarn global add streamboard-cli

How to use

Create a new plugin

 $ streamboard-cli create <name> $ cd<name>

Build your new plugin

 $ streamboard-cli build

Test your new plugin

 $ streamboard-cli serve

You need a valid package.json with this configuration :

 {
"name": "plugin-name",
"version": "1.0.0",
"main": "index.js",
"icon": "assets/img/icon.png",
"identifier": "ch.studimax.simple-plugin",
"actions": {
"test": {
"name": "Test",
"icon": "assets/img/actions/test.png"
}
},
"engines": {
"node": ">=14.16.0"
}
}

Don't forget to put all your assets files in the assets folder.

Done

Et voilà - we created a simple plugin. Don't forget that this project is in development.

About

StreamBoard CLI is a command-line interface to create and pack plugins for the Stream Board

Topics

Resources

Code of conduct

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages