cli

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 4, 2023 License: AGPL-3.0 Imports: 40 Imported by: 0

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

This section is empty.

Variables

View Source 
var ModuleUploadChunkSize = 32 * 1024

ModuleUploadChunkSize sets the number of bytes included in each chunk of the upload stream.

Functions

func CreateModuleCommand added in v0.5.0 

func CreateModuleCommand(c *cli.Context) error

CreateModuleCommand 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 UpdateModuleCommand added in v0.5.0 

func UpdateModuleCommand(c *cli.Context) error

UpdateModuleCommand runs the command to update a module. This includes updating the meta.json to include the public namespace (if set on the org).

func UploadModuleCommand added in v0.6.0 

func UploadModuleCommand(c *cli.Context) error

UploadModuleCommand runs the command to upload a new version of a module.

Types

type AppClient 

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

The AppClient provides all the CLI command functionality needed to talk to the app service but not directly to robot parts.

func NewAppClient 

func NewAppClient(c *cli.Context) (*AppClient, error)

NewAppClient returns a new app client that may already be authenticated.

func (*AppClient) BinaryData added in v0.1.6 

func (c *AppClient) BinaryData(dst string, filter *datapb.Filter, parallelDownloads uint) error

BinaryData downloads binary data matching filter to dst.

func (*AppClient) Config 

func (c *AppClient) Config() *Config

Config returns the current config.

func (*AppClient) CreateModule added in v0.5.0 

func (c *AppClient) CreateModule(moduleName, organizationID string) (*apppb.CreateModuleResponse, error)

CreateModule wraps the grpc CreateModule request.

func (*AppClient) DeleteBinaryData added in v0.2.8 

func (c *AppClient) DeleteBinaryData(filter *datapb.Filter) error

DeleteBinaryData deletes binary data matching filter.

func (*AppClient) DeleteTabularData added in v0.2.8 

func (c *AppClient) DeleteTabularData(filter *datapb.Filter) error

DeleteTabularData delete tabular data matching filter.

func (*AppClient) GetOrg added in v0.5.0 

func (c *AppClient) GetOrg(orgStr string) (*apppb.Organization, error)

GetOrg gets an org by an indentifying string. If the orgStr is an org UUID, then this matchs on organization ID, otherwise this will match on organization name.

func (*AppClient) GetUserOrgByPublicNamespace added in v0.5.0 

func (c *AppClient) GetUserOrgByPublicNamespace(publicNamespace string) (*apppb.Organization, error)

GetUserOrgByPublicNamespace searches the logged in users orgs to see if any have a matching public namespace.

func (*AppClient) ListLocations 

func (c *AppClient) ListLocations(orgID string) ([]*apppb.Location, error)

ListLocations returns all locations in the given organizationbelonging to the currently authenticated user.

func (*AppClient) ListOrganizations 

func (c *AppClient) ListOrganizations() ([]*apppb.Organization, error)

ListOrganizations returns all organizations belonging to the currently authenticated user.

func (*AppClient) ListRobots 

func (c *AppClient) ListRobots(orgStr, locStr string) ([]*apppb.Robot, error)

ListRobots returns all robots in the given location.

func (*AppClient) Login added in v0.2.14 

func (c *AppClient) Login() error

Login goes through the CLI login flow using a device code and browser. Once logged in the access token and user details are cached on disk.

func (*AppClient) Logout 

func (c *AppClient) Logout() error

Logout logs out the client and clears the config.

func (*AppClient) PrepareAuthorization 

func (c *AppClient) PrepareAuthorization() (string, string, error)

PrepareAuthorization prepares authorization for this device and returns the device token to late authenticate with and the URL to authorize the device at.

func (*AppClient) PrintRobotPartLogs 

func (c *AppClient) PrintRobotPartLogs(orgStr, locStr, robotStr, partStr string, errorsOnly bool, indent, header string) error

PrintRobotPartLogs prints logs for the given robot part.

func (*AppClient) RPCOpts 

func (c *AppClient) RPCOpts() []rpc.DialOption

RPCOpts returns RPC dial options dervied from the base URL being used in the current invocation of the CLI.

func (*AppClient) Robot 

func (c *AppClient) Robot(orgStr, locStr, robotStr string) (*apppb.Robot, error)

Robot returns the given robot.

func (*AppClient) RobotPart 

func (c *AppClient) RobotPart(orgStr, locStr, robotStr, partStr string) (*apppb.RobotPart, error)

RobotPart returns the given robot part belonging to a robot.

func (*AppClient) RobotPartLogs 

func (c *AppClient) RobotPartLogs(orgStr, locStr, robotStr, partStr string) ([]*apppb.LogEntry, error)

RobotPartLogs returns recent logs for the given robot part.

func (*AppClient) RobotPartLogsErrors 

func (c *AppClient) RobotPartLogsErrors(orgStr, locStr, robotStr, partStr string) ([]*apppb.LogEntry, error)

RobotPartLogsErrors returns recent error logs for the given robot part.

func (*AppClient) RobotParts 

func (c *AppClient) RobotParts(orgStr, locStr, robotStr string) ([]*apppb.RobotPart, error)

RobotParts returns all parts of the given robot.

func (*AppClient) RunRobotPartCommand 

func (c *AppClient) RunRobotPartCommand(
	orgStr, locStr, robotStr, partStr string,
	svcMethod, data string,
	streamDur time.Duration,
	debug bool,
	logger golog.Logger,
) error

RunRobotPartCommand runs the given command on a robot part.

func (*AppClient) SelectedLoc 

func (c *AppClient) SelectedLoc() *apppb.Location

SelectedLoc returns the currently selected location, possibly zero initialized.

func (*AppClient) SelectedOrg 

func (c *AppClient) SelectedOrg() *apppb.Organization

SelectedOrg returns the currently selected organization, possibly zero initialized.

func (*AppClient) StartRobotPartShell 

func (c *AppClient) StartRobotPartShell(
	orgStr, locStr, robotStr, partStr string,
	debug bool,
	logger golog.Logger,
) error

StartRobotPartShell starts a shell on a robot part.

func (*AppClient) TabularData added in v0.1.6 

func (c *AppClient) TabularData(dst string, filter *datapb.Filter) error

TabularData downloads binary data matching filter to dst.

func (*AppClient) TailRobotPartLogs 

func (c *AppClient) TailRobotPartLogs(orgStr, locStr, robotStr, partStr string, errorsOnly bool, indent, header string) error

TailRobotPartLogs tails and prints logs for the given robot part.

func (*AppClient) UpdateModule added in v0.5.0 

func (c *AppClient) UpdateModule(moduleID ModuleID, manifest ModuleManifest) (*apppb.UpdateModuleResponse, error)

UpdateModule wraps the grpc UpdateModule request.

func (*AppClient) UploadModuleFile added in v0.6.0 

func (c *AppClient) UploadModuleFile(
	moduleID ModuleID,
	version,
	platform string,
	file *os.File,
) (*apppb.UploadModuleFileResponse, error)

UploadModuleFile wraps the grpc UploadModuleFile request.

type Config 

type Config struct {
	Auth *Token `json:"auth"`
}

Config contains stored config information for the CLI.

type ModuleComponent added in v0.5.0 

type ModuleComponent struct {
	API   string `json:"api"`
	Model string `json:"model"`
}

ModuleComponent represents an api - model pair.

type ModuleID added in v0.5.0 

type ModuleID struct {
	Prefix string
	Name   string
}

ModuleID represents a prefix:name pair where prefix can be either an org id or a namespace.

type ModuleManifest added in v0.5.0 

type ModuleManifest struct {
	Name        string            `json:"name"`
	Visibility  ModuleVisibility  `json:"visibility"`
	URL         string            `json:"url"`
	Description string            `json:"description"`
	Models      []ModuleComponent `json:"models"`
	Entrypoint  string            `json:"entrypoint"`
}

ModuleManifest is used to create & parse manifest.json.

type ModuleVisibility added in v0.5.0 

type ModuleVisibility string

ModuleVisibility determines whether modules are public or private. 

const (
	ModuleVisibilityPrivate ModuleVisibility = "private"
	ModuleVisibilityPublic  ModuleVisibility = "public"
)

Permissions enumeration.

type Token added in v0.2.14 

type Token struct {
	AccessToken  string    `json:"access_token"`
	RefreshToken string    `json:"refresh_token"`
	IDToken      string    `json:"id_token"`
	ExpiresAt    time.Time `json:"expires_at"`
	TokenType    string    `json:"token_type"`
	TokenURL     string    `json:"token_url"`
	ClientID     string    `json:"client_id"`

	User UserData `json:"user_data"`
}

Token contains an authorization token and details once logged in.

func (*Token) CanRefresh added in v0.2.14 

func (t *Token) CanRefresh() bool

CanRefresh returns true if the token can be refreshed.

func (*Token) IsExpired added in v0.2.14 

func (t *Token) IsExpired() bool

IsExpired returns true if the token is expired.

type UserData added in v0.2.14 

type UserData struct {
	jwt.Claims

	Email   string `json:"email"`
	Subject string `json:"sub"` // userID
}

UserData user details from login.

Source Files

View all Source files

Directories

Path Synopsis
Package main is the CLI command itself.
 Package main is the CLI command itself.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.