CLI
CLI is a console utility packaged as an NPM package that supports the entire plugin lifecycle: creating, debugging, testing, and publishing.
Available commands
| Command | Description |
|---|---|
| create | Create a plugin from a template |
| build | Build a plugin |
| login | Log in to account (set a token in the CLI) |
| logout | Log out of account |
| whoami | View the current username |
| submit | Publish a plugin |
| list | View the list of your registered plugins |
| debug | Debug a plugin |
| lint | Check a plugin |
| up | Migrate a plugin to a new version of tools |
| feedback | Contact support |
| help | Display a list of all plugin commands |
Installation
npm install -g @weavix/cli
Local development
-
First, enable the plugin debugging mode in the Tracker interface.
Settings - Experiments - Plugin debuggingWhen you enable debugging, the browser may request permission for the site to access the local network. Grant access: without it, debugging will not work, because the config and plugins are loaded from
localhost. -
Then run the debug mode in the plugin folder:
weavix debug -
Open the integration point used in the plugin in the Tracker interface.
-
Make changes to the plugin interface code — they are applied to the interface immediately.
Publishing a plugin
Publishing is performed in the following order:
-
Get a token for the CLI:
weavix login -
Before publishing, make sure that the project contains the required files for the catalog:
public/logo.svgmarketplace/header-image.jpgmarketplace/index.md
-
Run the full publishing process:
weavix submitThis command will register the plugin if necessary, upload the distribution, and submit the version for moderation.
-
After submitting for moderation, check the publication status:
weavix list