https://github.com/studimax/streamboard-cli

StreamBoard CLI is a command-line interface to create and pack plugins for the Stream Board
https://github.com/studimax/streamboard-cli

cli plugin plugin-builder stream-board streamboard streamboard-cli studimax

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/studimax/streamboard-cli
• Owner: studimax
• License: mit
• Created: 2021-01-28T00:32:00.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T05:44:32.000Z (over 2 years ago)
• Last Synced: 2024-05-03T11:45:59.214Z (about 1 year ago)
• Topics: cli, plugin, plugin-builder, stream-board, streamboard, streamboard-cli, studimax
• Language: TypeScript
• Homepage: https://stream-board.app
• Size: 1.43 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  



Stream Board CLI


![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/studimax/streamboard-cli/CodeQL)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ba0fe6b62c2748babe7b6347f6f02c53)](https://app.codacy.com/gh/studimax/streamboard-cli?utm_source=github.com&utm_medium=referral&utm_content=studimax/streamboard-cli&utm_campaign=Badge_Grade_Settings)

[![npm](https://img.shields.io/npm/v/streamboard-cli)](https://www.npmjs.com/package/streamboard-cli)

[![Code Style: Google](https://img.shields.io/badge/code%20style-google-blueviolet.svg?logo=google&logoColor=white)](https://github.com/google/gts)

[![Code: TypeScript](https://img.shields.io/badge/made%20with-typescript-blue.svg?logo=typescript&logoColor=white)](https://github.com/microsoft/TypeScript)

[![Made By: StudiMax](https://img.shields.io/badge/made%20by-studimax-red.svg)](https://github.com/studimax)

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

# Installation

```bash

    # with npm

    $ npm install streamboard-cli -g

    # with yarn

    $ yarn global add streamboard-cli

```

# How to use

### Create a new plugin

```bash

    $ streamboard-cli create  

    $ cd 

```

### Build your new plugin

```bash

    $ streamboard-cli build

```

### Test your new plugin

```bash

    $ streamboard-cli serve

```

### You need a valid package.json with this configuration :

```json

    {

        "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.