api

Documentation

Index

• Constants
• Variables
• func DefaultHost() string
• func New(parent charm.Command, f *flag.FlagSet) (charm.Command, error)
• type Command
  • func (c *Command) Open(ctx context.Context) (api.Interface, error)
  • func (c *Command) Root() *root.Command

Constants

const HostEnv = "ZED_LAKE_HOST"

Variables

var Cmd = &charm.Spec{
	Name:  "api",
	Usage: "api [options] sub-command",
	Short: "perform lake actions on Zed service",
	Long: `
The "api" command provides client access to a Zed lake service running
on the IP and port provided in the "-host" option.  This option defaults
to localhost:9867 so you can conveniently connect to a lake service
running locally on the default port, as is automatically launched
by the Brim application for the "local Zed lake".

All of the relevant "lake" commands are available through the "api" command.
Refer to the help of the individual sub-commands for more details.`,
	New: New,
}

Functions

func DefaultHost

func DefaultHost() string

func New

func New(parent charm.Command, f *flag.FlagSet) (charm.Command, error)

Types

type Command

type Command struct {
	*root.Command
	Host string
}

func (*Command) Open

func (c *Command) Open(ctx context.Context) (api.Interface, error)

func (*Command) Root

func (c *Command) Root() *root.Command