@mochabug/svampinizer NPM

Svampinizer 🍄: The Magical CLI for Plugin Development!

Welcome to Svampinizer! 🍄 Prepare to embark on a whimsical adventure filled with creativity and efficiency! Svampinizer is a powerful CLI tool designed to help you effortlessly develop and manage plugins for the Mochabug platform. With Svampinizer, you can:

🌈 Create enchanting template projects for plugin development
🧙‍♂️ Emulate your plugins in a cloud environment with just a flick of your wand
🧚 Add and modify vertices to your plugin project with ease
🌟 Automagically handle tedious tasks that often bog down software development

Magical Vertices: Your Plugin Building Blocks 🔮

Vertices, also known as tasks, are the building blocks of your plugins. Svampinizer supports several types of vertices, each with its own unique charm:

Action: Performs tasks without interacting with external systems
Cron Trigger: Triggers actions at specified intervals, like clockwork
External Trigger: Activates tasks from an external endpoint, bringing the magic to the outside world
Browser: Runs tasks within a browser, where requests end up on the external endpoint

A vertex may have an associated configuration to customize its behavior. Configurations interact with users on the Mochabug platform, making them "external" by nature.

Getting Started 🚀

To start your magical journey with Svampinizer, install the package using the following incantation:

npm install -g @mochabug/svampinizer

Usage 🪄

With Svampinizer installed, you can now wield your newfound powers to develop and manage your plugin projects! Here's a guide to help you harness the magic:

Create a template project for plugin development

svampinizer --init

This command generates a manifest.json file with information about your plugin and creates runtime and (if applicable) config templates.

Emulate your plugins in the cloud environment

svampinizer --emulate

Test your plugin's sorcery in a controlled environment by emulating its behavior in the cloud.

Add and modify vertices

svampinizer --add-vertex [vertexType] [vertexName]

Easily add or modify vertices to your plugin project by specifying the vertex type and name.

Publish your plugin to the Mochabug platform

svampinizer --publish

Share your magical creation with the world by publishing your plugin to the Mochabug platform.

Documentation 📚

For a more comprehensive spellbook on how to use Svampinizer and unlock the full potential of our captivating plugin system, visit our documentation.

Contribute 🤝

Svampinizer is a collaborative, open-source project, and we welcome your contributions! If you have an idea for a feature, a bug report, or would like to help with documentation, please open an issue or submit a pull request.