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

• func CreateModuleAction(c *cli.Context) error
• func DataDeleteBinaryAction(c *cli.Context) error
• func DataDeleteTabularAction(c *cli.Context) error
• func DataExportAction(c *cli.Context) error
• func DownloadBoardDefsAction(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 LoginWithAPIKeyAction(cCtx *cli.Context) error
• func LogoutAction(cCtx *cli.Context) error
• func NewApp(out, errOut io.Writer) *cli.App
• func OrganizationsAPIKeyCreateAction(cCtx *cli.Context) error
• func PrintAccessTokenAction(cCtx *cli.Context) error
• func RobotsLogsAction(c *cli.Context) error
• func RobotsPartLogsAction(c *cli.Context) error
• func RobotsPartRunAction(c *cli.Context) error
• func RobotsPartShellAction(c *cli.Context) error
• func RobotsPartStatusAction(c *cli.Context) error
• func RobotsStatusAction(c *cli.Context) error
• func UpdateModuleAction(c *cli.Context) error
• func UploadBoardDefsAction(ctx *cli.Context) error
• func UploadModuleAction(c *cli.Context) error
• func VersionAction(c *cli.Context) error
• func WhoAmIAction(cCtx *cli.Context) error

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 DataDeleteBinaryAction

func DataDeleteBinaryAction(c *cli.Context) error

DataDeleteBinaryAction is the corresponding action for 'data delete'.

func DataDeleteTabularAction

func DataDeleteTabularAction(c *cli.Context) error

DataDeleteTabularAction is the corresponding action for 'data delete-tabular'.

func DataExportAction

func DataExportAction(c *cli.Context) error

DataExportAction is the corresponding action for 'data export'.

func DownloadBoardDefsAction

func DownloadBoardDefsAction(c *cli.Context) error

DownloadBoardDefsAction is the corresponding action for "board download".

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. It also capitalizes the first letter of the message.

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 LoginWithAPIKeyAction

func LoginWithAPIKeyAction(cCtx *cli.Context) error

LoginWithAPIKeyAction is the corresponding Action for `login api-key`.

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 OrganizationsAPIKeyCreateAction

func OrganizationsAPIKeyCreateAction(cCtx *cli.Context) error

OrganizationsAPIKeyCreateAction corresponds to `organizations api-key create`.

func PrintAccessTokenAction

func PrintAccessTokenAction(cCtx *cli.Context) error

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

func RobotsLogsAction

func RobotsLogsAction(c *cli.Context) error

RobotsLogsAction is the corresponding Action for 'robots logs'.

func RobotsPartLogsAction

func RobotsPartLogsAction(c *cli.Context) error

RobotsPartLogsAction is the corresponding Action for 'robots part logs'.

func RobotsPartRunAction

func RobotsPartRunAction(c *cli.Context) error

RobotsPartRunAction is the corresponding Action for 'robots part run'.

func RobotsPartShellAction

func RobotsPartShellAction(c *cli.Context) error

RobotsPartShellAction is the corresponding Action for 'robots part shell'.

func RobotsPartStatusAction

func RobotsPartStatusAction(c *cli.Context) error

RobotsPartStatusAction is the corresponding Action for 'robots part status'.

func RobotsStatusAction

func RobotsStatusAction(c *cli.Context) error

RobotsStatusAction is the corresponding Action for 'robots 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 UploadBoardDefsAction

func UploadBoardDefsAction(ctx *cli.Context) error

UploadBoardDefsAction is the corresponding action for "board upload".

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'.