node package manager

solfegejs-cli

Command Line Interface of SolfegeJS

solfegejs-cli

Command Line Interface of SolfegeJS

The bundle is included by default in SolfegeJS. You don't need to install it.

See SolfegeJS

In order to expore commands, you need to create a console.js file:

const solfege = require("solfegejs");
 
// Initialize the application 
let application = solfege.factory();
 
// Start the application 
// The first 2 parameters are removed (node and the script) 
application.start(process.argv.slice(2));

To expose a command, you have to create a service with a specific tag:

services:
    my_command:
        class: "Command/MyCommand"
        tags:
            { name: "solfege.console.command" }

And your class must implement 2 methods (getName and execute):

export default class MyCommand
{
    getName()
    {
        return "my-command";
    }
 
    *execute(parameters, options)
    {
        console.log("My command executed");
    }
}

Now you can call your command like that:

node console.js my-command