cli

README

[EXPERIMENTAL] Viam Command Line Interface

This is an experimental feature, so things may change without notice.

Install with go build -o ~/go/bin/viam cli/viam/main.go

Getting Started

Enter viam auth and follow instructions to authenticate.

Documentation

Overview

Package cli contains all business logic needed by the CLI command.

Index

• Constants
• func CreateModuleAction(c *cli.Context) error
• func DataDeleteAction(c *cli.Context) error
• func DataExportAction(c *cli.Context) error
• func Errorf(w io.Writer, format string, a ...interface{})
• func ListLocationsAction(c *cli.Context) error
• func ListOrganizationsAction(cCtx *cli.Context) error
• func ListRobotsAction(c *cli.Context) error
• func LoginAction(cCtx *cli.Context) error
• func LogoutAction(cCtx *cli.Context) error
• func NewApp(out, errOut io.Writer) *cli.App
• func PrintAccessTokenAction(cCtx *cli.Context) error
• func RobotLogsAction(c *cli.Context) error
• func RobotPartLogsAction(c *cli.Context) error
• func RobotPartRunAction(c *cli.Context) error
• func RobotPartShellAction(c *cli.Context) error
• func RobotPartStatusAction(c *cli.Context) error
• func RobotStatusAction(c *cli.Context) error
• func UpdateModuleAction(c *cli.Context) error
• func UploadModuleAction(c *cli.Context) error
• func VersionAction(c *cli.Context) error
• func WhoAmIAction(cCtx *cli.Context) error

Constants

const (

	// DataFlagDestination is the output directory for downloaded data.
	DataFlagDestination = "destination"
	// DataFlagDataType is the data type to be downloaded: either binary or tabular.
	DataFlagDataType = "data-type"
	// DataFlagOrgIDs is the orgs filter.
	DataFlagOrgIDs = "org-ids"
	// DataFlagLocationIDs is the location filter.
	DataFlagLocationIDs = "location-ids"
	// DataFlagRobotID is the robot-id filter.
	DataFlagRobotID = "robot-id"
	// DataFlagPartID is the robot-id filter.
	DataFlagPartID = "part-id"
	// DataFlagRobotName is the robot name filter.
	DataFlagRobotName = "robot-name"
	// DataFlagPartName is the part name filter.
	DataFlagPartName = "part-name"
	// DataFlagComponentType is the component type filter.
	DataFlagComponentType = "component-type"
	// DataFlagComponentName is the component name filter.
	DataFlagComponentName = "component-name"
	// DataFlagMethod is the method filter.
	DataFlagMethod = "method"
	// DataFlagMimeTypes is the mime types filter.
	DataFlagMimeTypes = "mime-types"
	// DataFlagStart is an ISO-8601 timestamp indicating the start of the interval filter.
	DataFlagStart = "start"
	// DataFlagEnd is an ISO-8601 timestamp indicating the end of the interval filter.
	DataFlagEnd = "end"
	// DataFlagParallelDownloads is the number of download requests to make in parallel.
	DataFlagParallelDownloads = "parallel"
	// DataFlagTags is the tags filter.
	DataFlagTags = "tags"
	// DataFlagBboxLabels is the bbox labels filter.
	DataFlagBboxLabels = "bbox-labels"
)

Functions

func CreateModuleAction

func CreateModuleAction(c *cli.Context) error

CreateModuleAction is the corresponding Action for 'module create'. It runs the command to create a module. This includes both a gRPC call to register the module on app.viam.com and creating the manifest file.

func DataDeleteAction

func DataDeleteAction(c *cli.Context) error

DataDeleteAction is the corresponding action for 'data delete'.

func DataExportAction

func DataExportAction(c *cli.Context) error

DataExportAction is the corresponding action for 'data export'.

func Errorf

func Errorf(w io.Writer, format string, a ...interface{})

Errorf prints a message prefixed with a bold red "Error: " prefix and exits with 1.

func ListLocationsAction

func ListLocationsAction(c *cli.Context) error

ListLocationsAction is the corresponding Action for 'locations list'.

func ListOrganizationsAction

func ListOrganizationsAction(cCtx *cli.Context) error

ListOrganizationsAction is the corresponding Action for 'organizations list'.

func ListRobotsAction

func ListRobotsAction(c *cli.Context) error

ListRobotsAction is the corresponding Action for 'robots list'.

func LoginAction

func LoginAction(cCtx *cli.Context) error

LoginAction is the corresponding Action for 'login'.

func LogoutAction

func LogoutAction(cCtx *cli.Context) error

LogoutAction is the corresponding Action for 'logout'.

func NewApp

func NewApp(out, errOut io.Writer) *cli.App

NewApp returns a new app with the CLI API, Writer set to out, and ErrWriter set to errOut.

func PrintAccessTokenAction

func PrintAccessTokenAction(cCtx *cli.Context) error

PrintAccessTokenAction is the corresponding Action for 'print-access-token'.

func RobotLogsAction

func RobotLogsAction(c *cli.Context) error

RobotLogsAction is the corresponding Action for 'robot logs'.

func RobotPartLogsAction

func RobotPartLogsAction(c *cli.Context) error

RobotPartLogsAction is the corresponding Action for 'robot part logs'.

func RobotPartRunAction

func RobotPartRunAction(c *cli.Context) error

RobotPartRunAction is the corresponding Action for 'robot part run'.

func RobotPartShellAction

func RobotPartShellAction(c *cli.Context) error

RobotPartShellAction is the corresponding Action for 'robot part shell'.

func RobotPartStatusAction

func RobotPartStatusAction(c *cli.Context) error

RobotPartStatusAction is the corresponding Action for 'robot part status'.

func RobotStatusAction

func RobotStatusAction(c *cli.Context) error

RobotStatusAction is the corresponding Action for 'robot status'.

func UpdateModuleAction

func UpdateModuleAction(c *cli.Context) error

UpdateModuleAction is the corresponding Action for 'module update'. It runs the command to update a module. This includes updating the meta.json to include the public namespace (if set on the org).

func UploadModuleAction

func UploadModuleAction(c *cli.Context) error

UploadModuleAction is the corresponding action for 'module upload'.

func VersionAction

func VersionAction(c *cli.Context) error

VersionAction is the corresponding Action for 'version'.

func WhoAmIAction

func WhoAmIAction(cCtx *cli.Context) error

WhoAmIAction is the corresponding Action for 'whoami'.