Skip to content
Documentation

Plugin-CLI

CLI for creating and publishing plugins

Our Plugin-cli makes it easy to create new plugins and publish them to the plugin-store, or package them for manual upload to an instance of Neleto. When creating a new plugin with the CLI, it will clone our plugin-template.

Installation

You have multiple options for installing the CLI:

Compiling from source

You will need to have the stable rust toolchain installed Install Rust.

Build the plugin-cli from the git repository:

cargo install --git https://github.com/Triple-A-Software/plugin-cli.git

Downloading a prebuilt binary

Coming soon

Via NPM

Coming soon

Commands

publish: Publish a plugin to the plugin-store

package: Package a plugin for manual upload

create <name>: Start a new plugin project with the given name

From project to installed

The CLI covers the whole lifecycle:

  1. create <name> scaffolds a new project from the plugin-template.
  2. Build your plugin (see Setting up your environment and First steps).
  3. Ship it one of two ways:
    • package produces a .tar.gz you install privately on a single instance via Upload Plugin on the Plugins page (see Installing a plugin).
    • publish pushes it to the Plugin Store, where any instance can install and update it.
package always runs the build first in the example plugins, so the archive can never ship without its binary. A typical justfile wires package to depend on build — see the example plugins for the real build scripts.