serve

Documentation

Overview

Package serve provides the `serve` command for the CLI. The command starts the server.

Index

• func Command(bindplane *cli.BindPlane) *cobra.Command
• type Server
  • func (s *Server) Start(ctx context.Context, bindplane *cli.BindPlane, ...) error
  • func (s *Server) Stop() error

Functions

func Command

func Command(bindplane *cli.BindPlane) *cobra.Command

Command returns the BindPlane serve cobra command

Types

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server is the BindPlane web server, serving HTTP, Websocket and Graphql.

func (*Server) Start

func (s *Server) Start(ctx context.Context, bindplane *cli.BindPlane, forceConsoleColor, skipSeed bool) error

Start starts the BindPlane using the specified Config.

func (*Server) Stop

func (s *Server) Stop() error

Stop will stop the server with a timeout