cli

Documentation

Index

• Constants
• func ClientCli(args []string)
• func NewRequest(requestType, requestData string) (r quantum.Request, err error)
• func Run(conn quantum.ClientConn, request quantum.Request, w io.Writer) error
• func SoloCli(args []string)
• func VersionCli(args []string)
• type CLI
  • func New() *CLI
  • func (c *CLI) Run(args []string)
  • func (c *CLI) Usage() string
• type Func

Constants

const Version = "0.0.2"

Version is the current version of the quantum cli

Functions

func ClientCli

func ClientCli(args []string)

ClientCli defines a command to run quantum in client mode, making use of Quantum Resolver. By specifing the type of the request, and optionally the hostname, Quantum Resolver will return the addresses and ports of available agents to communicate with to run jobs.

func NewRequest

func NewRequest(requestType, requestData string) (r quantum.Request, err error)

NewRequest creates a request by treating requestData as file and falling back to treating it as a string.

func Run

func Run(conn quantum.ClientConn, request quantum.Request, w io.Writer) error

Run runs a client

func SoloCli

func SoloCli(args []string)

SoloCli defines a command to run quantum in stand alone, or solo, mode. Solo mode allows the user to send a request directly to a Quantum Agent when they know the agent address and port.

func VersionCli

func VersionCli(args []string)

VersionCli prints out the current version

Types

type CLI

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

CLI wraps the CLIs defined in quantum

func New

func New() *CLI

New returns a new CLI

func (*CLI) Run

func (c *CLI) Run(args []string)

Run runs a CLI with specified arguments

func (*CLI) Usage

func (c *CLI) Usage() string

Usage is the usage for the CLI

type Func

type Func func(args []string)

Func wraps a cli run func