sensuctl-plugin-template is a template repository which wraps the Sensu Plugin SDK. To use this project as a template, click the "Use this template" button from the main project page. Once the repository is created from this template, you can use the Sensu Plugin Tool to populate the templated fields with the proper values.
After successfully creating a project from this template, update main.go to customize the behavior of this sensuctl plugin.
When writing or updating a plugin's README from this template, review the Sensu Community
plugin README style guide for content suggestions and guidance. Remove everything
prior to # {{ .Name }} from the generated README file, and add additional context about the
plugin per the style guide.
To release a version of your project, simply tag the target sha with a semver release without a v
prefix (ex. 1.0.0). This will trigger the GitHub action workflow to build and release
the plugin with goreleaser. Register the asset with Bonsai to share it with the community!
The {{ .Name }} is a Sensu CLI tool (sensuctl) that ...
Sensu Assets are the best way to make use of this plugin. If you're not using an asset, please consider doing so! If you're using sensuctl 5.13 with Sensu Backend 5.13 or later, you can use the following command to add the asset:
sensuctl asset add {{ .GithubUser }}/{{ .GithubProject }}
If you're using an earlier version of sensuctl, you can find the asset on the [Bonsai Asset Index][https://bonsai.sensu.io/assets/{{ .GithubUser }}/{{ .GithubProject }}].
The preferred way of installing and deploying this plugin is to use it as an Asset. If you would like to compile and install the plugin from source or contribute to it, download the latest version or create an executable script from this source.
From the local path of the {{ .GithubProject }} repository:
go build
For more information about contributing to this plugin, see Contributing.