hercules/PLUGINS.md

Hercules plugins

Prerequisites

It is required to have GoGo Protobuf installed:

go get github.com/gogo/protobuf/protoc-gen-gogo

There must be the protoc tool available in $PATH, version 3. Grab it from the official Protocol Buffers releases page (protoc-*.zip).

Creating a new plugin

Generation of a new plugin skeleton:

hercules-generate-plugin -n MyPluginName -o my_plugin

This command creates:

• my_plugin/my_plugin_name.go with the plugin source code. Refer to the docs about [LeafPipelineItem]().
• my_plugin/my_plugin_name.proto which defines the Protocol Buffers scheme of the result
• my_plugin/my_plugin_name.pb.go is generated from my_plugin/my_plugin_name.proto

Compilation:

cd my_plugin
make

Using a plugin

hercules -plugin my_plugin_name.so -my-plugin-name https://github.com/user/repo