Waypoint Plugin Sdk

Waypoint Plugin SDK enables building plugins for Waypoint: builders, deployment platforms, release managers, and more.
Alternatives To Waypoint Plugin Sdk
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
Feflow1,2842a month ago117July 15, 202217otherTypeScript
🚀 A command line tool aims to improve front-end engineer workflow and standard, powered by TypeScript.
28 months ago28May 13, 20217mitTypeScript
Figma plugin builder
Phulp29616102 years ago29August 01, 20191mitPHP
The task manager for php
9 years ago4apache-2.0Java
An experimental Gradle plugin which generates compile-safe format string builders.
5 months ago21apache-2.0Java
IntelliJ IDEA plugin which generates an inner builder class
Awesome Elementor248
8 months ago
A collection of third party add-ons for the Elementor page builder plugin.
Laravel Datatables Html2412375925 days ago141October 06, 20224mitPHP
Laravel DataTables HTML Builder Plugin
Live Composer Page Builder155
a month ago57gpl-3.0PHP
Free page builder plugin for WordPress https://livecomposerplugin.com
8 years ago2mitRuby
This Rails plugin is the easiest way to export to Excel. It gives you the ability to call to_xls to a collection of activerecords. The builder options are the same as to_json / to_xml, except for the :include.
Commodore134718 months ago13June 12, 20227mitJava
Utility for using Minecraft's 1.13 'brigadier' library in Bukkit plugins.
Alternatives To Waypoint Plugin Sdk
Select To Compare

Alternative Project Comparisons

Waypoint Plugin SDK

This repository is a Go library that enables users to write custom Waypoint plugins. Waypoint supports plugins for builders, deployment platforms, release managers, and more. Waypoint plugins enable Waypoint to utilize any popular service providers as well as custom in-house solutions.

Plugins in Waypoint are separate binaries which communicate with the Waypoint application; the plugin communicates using gRPC, and while it is theoretically possible to build a plugin in any language supported by the gRPC framework. We recommend that the developers leverage the Waypoint SDK.

Simple Plugin Overview

To initialize the plugin SDK you use the Main function in the sdk package and register Components which provide callbacks for Waypoint during the various parts of the lifecycle.

package main

import (
  sdk "github.com/hashicorp/waypoint-plugin-sdk"

func main() {

    // Comment out any components which are not
    // required for your plugin


Components are Go structs which implement the various lifecycle interfaces in the Waypoint SDK. The following example shows a plugin which Waypoint can use for the build lifecycle. Creating a build plugin is as simple as implementing the interface component.Builder on a struct as shown in the following example.

package builder

import (


type Builder struct {}

func (b *Builder) BuildFunc() interface{} {
  // return a function which will be called by Waypoint
  return func(ctx context.Context, ui terminal.UI) (*Binary, error) {
  u := ui.Status()
  defer u.Close()
  u.Update("Building application")

  return &Binary{}, nil

To pass values from one Waypoint component to another Waypoint component you return structs which implement proto.Message, generally these structs are not manually created but generated by defining a Protocol Buffer message template and then using the protoc and associated Go plugin to generate the Go structs.

The following example shows the Protocol Buffer message template which is used to define the Binary struct which is returned from the previous example.

syntax = "proto3";

package platform;

option go_package = "github.com/hashicorp/waypoint-plugin-examples/template/builder";

message Binary {
  string location = 1;

For more information on Protocol Buffers and Go, please see the documentation on the Google Developers website.


For full walkthrough for creating a Waypoint Plugin and reference documentation, please see the Extending Waypoint section of the Waypoint website.

Example Plugins

Please see the following Plugins for examples of real world implementations of the Waypoint SDK.


Docker Build Packs


Amazon ECR Docker Files


Nomad Nomad Jobspec Kubernetes kubectl Apply Helm Docker Azure Container Interface Google Cloud Run Amazon EC2 Amazon ECS


Kubernetes Google Cloud Run Amazon ALB

Config Sourcers

Terraform Cloud Vault


Thank you for your interest in contributing! Please refer to CONTRIBUTING.md for guidance.

Installing Dependencies

To automate installing the required Golang packages needed to build Waypoint locally, run make tools.

Regenerating protobufs

Install dockern and run make docker/gen

Popular Plugin Projects
Popular Builder Projects
Popular Libraries Categories

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.