RSDK-11726 — (STACKED) Deprecate GetImage and Format in Go SDK/RDK

cli/app.go

@@ -87,7 +87,6 @@ const (
 	moduleFlagVisibility      = "visibility"
 	moduleFlagResourceType    = "resource-type"
 	moduleFlagModelName       = "model-name"
-	moduleFlagEnableCloud     = "enable-cloud"
 	moduleFlagRegister        = "register"
 	moduleFlagDryRun          = "dry-run"
 	moduleFlagUpload          = "upload"
@@ -100,7 +99,6 @@ const (
 	moduleBuildFlagGroupLogs   = "group-logs"
 	moduleBuildRestartOnly     = "restart-only"
 	moduleBuildFlagNoBuild     = "no-build"
-	moduleBuildFlagCloudBuild  = "cloud-build"
 	moduleBuildFlagCloudConfig = "cloud-config"
 	moduleBuildFlagID          = "build-id"
 	moduleBuildFlagOAuthLink   = "oauth-link"
@@ -469,6 +467,49 @@ var app = &cli.App{
 		},
 	},
 	Commands: []*cli.Command{
+		{
+			Name:      "defaults",
+			Usage:     "Set or clear default argument values",
+			UsageText: createUsageText("defaults", nil, false, false),
+			Subcommands: []*cli.Command{
+				{
+					Name:  "set-org",
+					Usage: "Set default organization argument",
+					Flags: []cli.Flag{
+						&AliasStringFlag{
+							cli.StringFlag{
+								Name:     generalFlagOrgID, // some functions require an ID, so we should do the same for defaults
+								Required: true,
+							},
+						},
+					},
+					Action: createCommandWithT(defaultsSetOrgAction),
+				},
+				{
+					Name:   "clear-org",
+					Usage:  "Clear default organization argument",
+					Action: createCommandWithT(defaultsClearOrgAction),
+				},
+				{
+					Name:  "set-location",
+					Usage: "Set default location argument",
+					Flags: []cli.Flag{
+						&AliasStringFlag{
+							cli.StringFlag{
+								Name:     generalFlagLocationID, // some functions require an ID, so we should do the same for defaults
+								Required: true,
+							},
+						},
+					},
+					Action: createCommandWithT(defaultsSetLocationAction),
+				},
+				{
+					Name:   "clear-location",
+					Usage:  "Clear default location argument",
+					Action: createCommandWithT(defaultsClearLocationAction),
+				},
+			},
+		},
 		{
 			Name:      "traces",
 			Usage:     "Work with viam-server traces",
@@ -1001,9 +1042,9 @@ Note: There is no progress meter while copying is in progress.
 							UsageText: createUsageText("organizations api-key create", []string{generalFlagOrgID}, true, false),
 							Flags: []cli.Flag{
 								&cli.StringFlag{
-									Name:     generalFlagOrgID,
-									Required: true,
-									Usage:    "the org to create an api key for",
+									Name:        generalFlagOrgID,
+									Usage:       "the org to create an api key for",
+									DefaultText: "the default org set with `viam defaults set-org`",
 								},
 								&cli.StringFlag{
 									Name:        generalFlagName,
@@ -1034,7 +1075,7 @@ Note: There is no progress meter while copying is in progress.
 							cli.StringFlag{
 								Name:        generalFlagOrganization,
 								Aliases:     []string{generalFlagAliasOrg, generalFlagOrgID, generalFlagAliasOrgName},
-								DefaultText: "first organization alphabetically",
+								DefaultText: "the org set by `viam defaults set-org` if it exists, else the first one alphabetically",
 							},
 						},
 					},
@@ -1051,9 +1092,9 @@ Note: There is no progress meter while copying is in progress.
 							UsageText: createUsageText("locations api-key create", []string{generalFlagLocationID}, true, false),
 							Flags: []cli.Flag{
 								&cli.StringFlag{
-									Name:     generalFlagLocationID,
-									Required: true,
-									Usage:    "id of the location to create an api-key for",
+									Name:        generalFlagLocationID,
+									Usage:       "id of the location to create an api-key for",
+									DefaultText: "the default location set with `viam defaults set-location`",
 								},
 								&cli.StringFlag{
 									Name:  generalFlagName,
@@ -2318,14 +2359,14 @@ Note: There is no progress meter while copying is in progress.
 							cli.StringFlag{
 								Name:        generalFlagOrganization,
 								Aliases:     []string{generalFlagAliasOrg, generalFlagOrgID, generalFlagAliasOrgName},
-								DefaultText: "first organization alphabetically",
+								DefaultText: "the default org argument if set, else the first organization alphabetically",
 							},
 						},
 						&AliasStringFlag{
 							cli.StringFlag{
 								Name:        generalFlagLocation,
 								Aliases:     []string{generalFlagLocationID, generalFlagAliasLocationName},
-								DefaultText: "first location alphabetically",
+								DefaultText: "the default location argument if set, else the first location alphabetically",
 							},
 						},
 						&cli.BoolFlag{
@@ -2950,10 +2991,6 @@ After creation, use 'viam module update' to push your new module to app.viam.com
 							Usage: "name for the particular resource subtype implementation." +
 								" for example, a sensor model that detects moisture might be named 'moisture'",
 						},
-						&cli.BoolFlag{
-							Name:  moduleFlagEnableCloud,
-							Usage: "generate Github workflows to build module",
-						},
 						&cli.BoolFlag{
 							Name:  moduleFlagRegister,
 							Usage: "register module with Viam to associate with your organization",
@@ -3010,10 +3047,6 @@ viam module upload --version "0.1.0" --platform "linux/amd64" --upload "./bin/my
 Example uploading a whole directory:
 viam module upload --version "0.1.0" --platform "linux/amd64" --upload "./bin"
 (this example requires the entrypoint in the meta.json to be inside the bin directory like "./bin/[your path here]")
-
-Example uploading a custom tarball of your module:
-tar -czf packaged-module.tar.gz ./src requirements.txt run.sh
-viam module upload --version "0.1.0" --platform "linux/amd64" --upload "packaged-module.tar.gz"
                       `,
 					UsageText: createUsageText("module upload", []string{generalFlagVersion, moduleFlagPlatform, moduleFlagUpload}, true, false),
 					Flags: []cli.Flag{

cli/auth.go

@@ -313,7 +313,13 @@ func OrganizationsAPIKeyCreateAction(cCtx *cli.Context, args organizationsAPIKey
 }
 
 func (c *viamClient) organizationsAPIKeyCreateAction(cCtx *cli.Context, args organizationsAPIKeyCreateArgs) error {
+	var err error
 	orgID := args.OrgID
+	if orgID == "" {
+		if orgID, err = getDefaultOrg(cCtx); err != nil {
+			return errors.New("must specify an org ID to create an API key for")
+		}
+	}
 	keyName := args.Name
 	if keyName == "" {
 		keyName = c.generateDefaultKeyName()
@@ -367,6 +373,10 @@ func LocationAPIKeyCreateAction(cCtx *cli.Context, args locationAPIKeyCreateArgs
 
 func (c *viamClient) locationAPIKeyCreateAction(cCtx *cli.Context, args locationAPIKeyCreateArgs) error {
 	locationID := args.LocationID
+	if locationID == "" {
+		//nolint:errcheck // if there's an error we just fallback to the old logic
+		locationID, _ = getDefaultLocation(cCtx)
+	}
 	orgID := args.OrgID
 	keyName := args.Name
 
@@ -480,6 +490,11 @@ func (c *viamClient) ensureLoggedInInner() error {
 		return nil
 	}
 
+	globalArgs, err := getGlobalArgs(c.c)
+	if err != nil {
+		return err
+	}
+
 	if c.conf.Auth == nil {
 		return errors.New("not logged in: run the following command to login:\n\tviam login")
 	}
@@ -494,10 +509,7 @@ func (c *viamClient) ensureLoggedInInner() error {
 		// expired.
 		newToken, err := c.authFlow.refreshToken(c.c.Context, authToken)
 		if err != nil {
-			debugFlag := false
-			if globalArgs, err := getGlobalArgs(c.c); err == nil {
-				debugFlag = globalArgs.Debug
-			}
+			debugFlag := globalArgs.Debug
 			debugf(c.c.App.Writer, debugFlag, "Token refresh error: %v", err)
 			utils.UncheckedError(c.logout()) // clear cache if failed to refresh
 			return errors.New("error while refreshing token, logging out. Please log in again")
@@ -534,6 +546,23 @@ func (c *viamClient) ensureLoggedInInner() error {
 	c.mlInferenceClient = mlinferencepb.NewMLInferenceServiceClient(conn)
 	c.buildClient = buildpb.NewBuildServiceClient(conn)
 
+	// if there's no default org and we're in a profile, there should only be the one org
+	// so we can automatically set that as the default
+	if c.conf.DefaultOrg == "" {
+		whichProfile, _ := whichProfile(globalArgs)
+		if !globalArgs.DisableProfiles && whichProfile != nil {
+			orgs, err := c.listOrganizations()
+			if err != nil && !globalArgs.Quiet {
+				warningf(c.c.App.ErrWriter, "no default org set for profile and unable to infer one")
+				// this should always be true for now, but might change if/when user level API keys exist
+			} else if len(orgs) == 1 {
+				if err = c.writeDefaultOrg(c.c, c.conf, orgs[0].Id); err != nil && !globalArgs.Quiet {
+					warningf(c.c.App.ErrWriter, "unable to set default org for profile %s", *whichProfile)
+				}
+			}
+		}
+	}
+
 	return nil
 }
 

cli/auth_test.go

@@ -53,7 +53,7 @@ func TestAPIKeyCreateAction(t *testing.T) {
 	asc := &inject.AppServiceClient{
 		CreateKeyFunc: createKeyFunc,
 	}
-	cCtx, ac, out, errOut := setup(asc, nil, nil, nil, "token")
+	cCtx, ac, out, errOut := setup(asc, nil, nil, map[string]any{"org-id": "my-org"}, "token")
 
 	test.That(t, ac.organizationsAPIKeyCreateAction(cCtx, parseStructFromCtx[organizationsAPIKeyCreateArgs](cCtx)), test.ShouldBeNil)
 	test.That(t, len(errOut.messages), test.ShouldEqual, 0)

cli/client.go

@@ -605,7 +605,11 @@ func ListLocationsAction(c *cli.Context, args listLocationsArgs) error {
 	if orgStr == "" {
 		orgStr = c.Args().First()
 	}
-	if orgStr == "" {
+	if orgStr == "" { // first, see if we have a default set
+		//nolint:errcheck // if there's an error then we'll just fall back to the old logic
+		orgStr, _ = getDefaultOrg(c)
+	}
+	if orgStr == "" { // if there's still not an orgStr, then we can fall back to the alphabetically first
 		orgs, err := client.listOrganizations()
 		if err != nil {
 			return errors.Wrap(err, "could not list organizations")
@@ -951,6 +955,14 @@ func ListRobotsAction(c *cli.Context, args listRobotsActionArgs) error {
 	}
 	orgStr := args.Organization
 	locStr := args.Location
+	if orgStr == "" {
+		//nolint:errcheck // if there's an error we fallback to old logic
+		orgStr, _ = getDefaultOrg(c)
+	}
+	if locStr == "" {
+		//nolint:errcheck // if there's an error we fallback to old logic
+		locStr, _ = getDefaultLocation(c)
+	}
 	if args.All {
 		return client.listAllRobotsInOrg(c, orgStr)
 	}

cli/config.go

@@ -134,6 +134,8 @@ type Config struct {
 	LastUpdateCheck string     `json:"last_update_check"`
 	LatestVersion   string     `json:"latest_version"`
 	profile         string
+	DefaultOrg      string `json:"default_org"`
+	DefaultLocation string `json:"default_location"`
 }
 
 func (conf *Config) tryUnmarshallWithToken(configBytes []byte) error {