kaluma-project / kaluma-cli

Apache License 2.0
26 stars 9 forks source link

Node JS Interace For Kaluma CLI #16

Open defensadev opened 2 years ago

defensadev commented 2 years ago

I would like to start an effort to build a node interface for Kaluma CLI. I am thinking about working on a pull request, feel free to add any ideas to how to achieve this.

What is a node JS interface?

A node interface allows you to bypass the usual cli tool and automate it with a script. Examples include:

Why?

Basically, rather than using the typical cli tool, one could write a script that would do everything. For example, My current workflow involves bundling with esbuild and then using kaluma to do things like load the main file, making sure everything is working / connected, etc. Automating this would be quite interesting and useful.

What does this mean for the CLI?

Nothing much! Just a way to interact with it from a node script. Having both the cli and the interface would allow for a great workflow & productivity.

niklauslee commented 2 years ago

Currently I'm using with scripts in package.json but I think it's a necessary feature. It would be good to discuss the rough interface definition.

easingthemes commented 1 year ago

Kaluma is already a nodejs module. CLI is just exposed via commander. You can use kaluma directly without cli, check https://github.com/kaluma-project/kaluma-cli/blob/master/bin/kaluma.js