README.md

Sensu Plugin Tool

• Overview
• Usage examples
• Installing from source and contributing

Overview

The Sensu Plugin Tool is a command-line tool to generates scaffolding for a new Sensu Plugin project.

The following plugin types are currently supported:

• Check - default check template
• Handler - default handler template
• Mutator - default mutator template
• Sensuctl - default sensuctl template

Usage examples

Creating a handler plugin using interactive mode:

$ sensu-plugin-tool new handler
? Template URL https://github.com/sensu/handler-plugin-template
? Project name My Handler
? Description Description for My Handler
? Github User githubuser
? Github Project my-handler
? Copyright Year 2020
? Copyright Holder Me
Success!

Creating a handler plugin using flags:

sensu-plugin-tool --name "My Handler" \
    --description "Description for My Handler" \
    --github-user mygithubuser \
    --github-project my-handler \
    --copyright-year 2020 \
    --copyright-holder Me

Installing from source and contributing

Download the latest version of the sensu-plugin-tool from releases, or create an executable script from this source.

Compiling

From the local path of the sensu-plugin-tool repository:

go build