Skip to main content
Version: v0.27

Using Plugins

Ignite plugins offer a way to extend the functionality of the Ignite CLI. There are two core concepts within plugins : Commands and Hooks. Where Commands extend the cli's functionality, and Hooks extend existing command functionality.

Plugins are registered in an Ignite scaffolded Blockchain project through the plugins.yml, or globally through $HOME/.ignite/plugins/plugins.yml.

To use a plugin within your project, execute the following command inside the project directory:

ignite plugin add

The plugin will be available only when running ignite inside the project directory.

To use a plugin globally on the other hand, execute the following command:

ignite plugin add -g

The command will compile the plugin and make it immediately available to the ignite command lists.

Listing installed plugins

When in an ignite scaffolded blockchain you can use the command ignite plugin list to list all plugins and there statuses.

Updating plugins

When a plugin in a remote repository releases updates, running ignite plugin update <path/to/plugin> will update a specific plugin declared in your project's config.yml.