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 LogoutAction(cCtx *cli.Context) error
- func NewApp(out, errOut io.Writer) *cli.App
- func OrganizationAPIKeyCreateAction(cCtx *cli.Context) error
- 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 UploadBoardDefsAction(ctx *cli.Context) error
- func UploadModuleAction(c *cli.Context) error
- func VersionAction(c *cli.Context) error
- func WhoAmIAction(cCtx *cli.Context) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateModuleAction ¶ added in v0.7.3
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 ¶ added in v0.8.0
func DataDeleteBinaryAction(c *cli.Context) error
DataDeleteBinaryAction is the corresponding action for 'data delete'.
func DataDeleteTabularAction ¶ added in v0.8.0
func DataDeleteTabularAction(c *cli.Context) error
DataDeleteTabularAction is the corresponding action for 'data delete-tabular'.
func DataExportAction ¶ added in v0.7.3
func DataExportAction(c *cli.Context) error
DataExportAction is the corresponding action for 'data export'.
func DownloadBoardDefsAction ¶ added in v0.8.0
func DownloadBoardDefsAction(c *cli.Context) error
DownloadBoardDefsAction is the corresponding action for "board download".
func Errorf ¶ added in v0.7.3
Errorf prints a message prefixed with a bold red "Error: " prefix and exits with 1.
func ListLocationsAction ¶ added in v0.7.3
func ListLocationsAction(c *cli.Context) error
ListLocationsAction is the corresponding Action for 'locations list'.
func ListOrganizationsAction ¶ added in v0.7.3
func ListOrganizationsAction(cCtx *cli.Context) error
ListOrganizationsAction is the corresponding Action for 'organizations list'.
func ListRobotsAction ¶ added in v0.7.3
func ListRobotsAction(c *cli.Context) error
ListRobotsAction is the corresponding Action for 'robots list'.
func LoginAction ¶ added in v0.7.3
func LoginAction(cCtx *cli.Context) error
LoginAction is the corresponding Action for 'login'.
func LogoutAction ¶ added in v0.7.3
func LogoutAction(cCtx *cli.Context) error
LogoutAction is the corresponding Action for 'logout'.
func NewApp ¶ added in v0.7.3
NewApp returns a new app with the CLI API, Writer set to out, and ErrWriter set to errOut.
func OrganizationAPIKeyCreateAction ¶ added in v0.8.0
func OrganizationAPIKeyCreateAction(cCtx *cli.Context) error
OrganizationAPIKeyCreateAction corresponds to `organization api-key create`.
func PrintAccessTokenAction ¶ added in v0.7.3
func PrintAccessTokenAction(cCtx *cli.Context) error
PrintAccessTokenAction is the corresponding Action for 'print-access-token'.
func RobotLogsAction ¶ added in v0.7.3
func RobotLogsAction(c *cli.Context) error
RobotLogsAction is the corresponding Action for 'robot logs'.
func RobotPartLogsAction ¶ added in v0.7.3
func RobotPartLogsAction(c *cli.Context) error
RobotPartLogsAction is the corresponding Action for 'robot part logs'.
func RobotPartRunAction ¶ added in v0.7.3
func RobotPartRunAction(c *cli.Context) error
RobotPartRunAction is the corresponding Action for 'robot part run'.
func RobotPartShellAction ¶ added in v0.7.3
func RobotPartShellAction(c *cli.Context) error
RobotPartShellAction is the corresponding Action for 'robot part shell'.
func RobotPartStatusAction ¶ added in v0.7.3
func RobotPartStatusAction(c *cli.Context) error
RobotPartStatusAction is the corresponding Action for 'robot part status'.
func RobotStatusAction ¶ added in v0.7.3
func RobotStatusAction(c *cli.Context) error
RobotStatusAction is the corresponding Action for 'robot status'.
func UpdateModuleAction ¶ added in v0.7.3
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 ¶ added in v0.8.0
func UploadBoardDefsAction(ctx *cli.Context) error
UploadBoardDefsAction is the corresponding action for "board upload".
func UploadModuleAction ¶ added in v0.7.3
func UploadModuleAction(c *cli.Context) error
UploadModuleAction is the corresponding action for 'module upload'.
func VersionAction ¶ added in v0.7.3
func VersionAction(c *cli.Context) error
VersionAction is the corresponding Action for 'version'.
func WhoAmIAction ¶ added in v0.7.3
func WhoAmIAction(cCtx *cli.Context) error
WhoAmIAction is the corresponding Action for 'whoami'.
Types ¶
This section is empty.
Source Files
Directories