Merge pull request #227 from depot/docs/clarify-depot-token

docs: update CLI flags to clarify depot token
depot · Dec 6, 2023 · dcd5ce3 · dcd5ce3
2 parents 4268e21 + a06b023
commit dcd5ce3
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 8 deletions.
diff --git a/pkg/buildx/commands/build.go b/pkg/buildx/commands/build.go
@@ -835,7 +835,7 @@ func depotFlags(cmd *cobra.Command, options *DepotOptions, flags *pflag.FlagSet)
 
 func depotBuildFlags(options *DepotOptions, flags *pflag.FlagSet) {
 	flags.StringVar(&options.project, "project", "", "Depot project ID")
-	flags.StringVar(&options.token, "token", "", "Depot API token")
+	flags.StringVar(&options.token, "token", "", "Depot token")
 	flags.StringVar(&options.buildPlatform, "build-platform", "dynamic", `Run builds on this platform ("dynamic", "linux/amd64", "linux/arm64")`)
 
 	allowNoOutput := false

diff --git a/pkg/cmd/cache/reset.go b/pkg/cmd/cache/reset.go
@@ -56,7 +56,7 @@ func NewCmdResetCache() *cobra.Command {
 	}
 
 	cmd.Flags().StringVar(&projectID, "project", "", "Depot project ID for the cache to reset")
-	cmd.Flags().StringVar(&token, "token", "", "Depot API token")
+	cmd.Flags().StringVar(&token, "token", "", "Depot token")
 
 	return cmd
 }
diff --git a/pkg/cmd/docker/docker.go b/pkg/cmd/docker/docker.go
@@ -89,7 +89,7 @@ func NewCmdConfigureDocker(dockerCli command.Cli) *cobra.Command {
 	flags := cmd.Flags()
 	flags.BoolVar(&uninstall, "uninstall", false, "Remove Docker plugin")
 	flags.StringVar(&project, "project", "", "Depot project ID")
-	flags.StringVar(&token, "token", "", "Depot API token")
+	flags.StringVar(&token, "token", "", "Depot token")
 
 	return cmd
 }

diff --git a/pkg/cmd/init/init.go b/pkg/cmd/init/init.go
@@ -68,7 +68,7 @@ func NewCmdInit() *cobra.Command {
 
 	cmd.Flags().Bool("force", false, "Overwrite any existing project configuration")
 	cmd.Flags().StringVar(&projectID, "project", "", "The ID of the project to initialize")
-	cmd.Flags().StringVar(&token, "token", "", "Depot API token")
+	cmd.Flags().StringVar(&token, "token", "", "Depot token")
 
 	return cmd
 }
diff --git a/pkg/cmd/list/builds.go b/pkg/cmd/list/builds.go
@@ -68,7 +68,7 @@ func NewCmdBuilds() *cobra.Command {
 	flags := cmd.Flags()
 
 	flags.StringVar(&projectID, "project", "", "Depot project ID")
-	flags.StringVar(&token, "token", "", "Depot API token")
+	flags.StringVar(&token, "token", "", "Depot token")
 	flags.StringVar(&outputFormat, "output", "", "Non-interactive output format (json, csv)")
 
 	return cmd

diff --git a/pkg/cmd/list/projects.go b/pkg/cmd/list/projects.go
@@ -99,7 +99,7 @@ func NewCmdProjects() *cobra.Command {
 	}
 
 	flags := cmd.Flags()
-	flags.StringVar(&token, "token", "", "Depot API token")
+	flags.StringVar(&token, "token", "", "Depot token")
 	flags.StringVar(&outputFormat, "output", "", "Non-interactive output format (json, csv)")
 
 	return cmd

diff --git a/pkg/cmd/pull/pull.go b/pkg/cmd/pull/pull.go
@@ -140,7 +140,7 @@ func NewCmdPull(dockerCli command.Cli) *cobra.Command {
 	}
 
 	cmd.Flags().StringVar(&projectID, "project", "", "Depot project ID")
-	cmd.Flags().StringVar(&token, "token", "", "Depot API token")
+	cmd.Flags().StringVar(&token, "token", "", "Depot token")
 	cmd.Flags().StringVar(&platform, "platform", "", `Pulls image for specific platform ("linux/amd64", "linux/arm64")`)
 	cmd.Flags().StringSliceVarP(&userTags, "tag", "t", nil, "Optional tags to apply to the image")
 	cmd.Flags().StringVar(&progress, "progress", "auto", `Set type of progress output ("auto", "plain", "tty", "quiet")`)

diff --git a/pkg/cmd/push/push.go b/pkg/cmd/push/push.go
@@ -76,7 +76,7 @@ func NewCmdPush(dockerCli command.Cli) *cobra.Command {
 	}
 
 	cmd.Flags().StringVar(&projectID, "project", "", "Depot project ID")
-	cmd.Flags().StringVar(&token, "token", "", "Depot API token")
+	cmd.Flags().StringVar(&token, "token", "", "Depot token")
 	cmd.Flags().StringVar(&progressFmt, "progress", "auto", `Set type of progress output ("auto", "plain", "tty", "quiet")`)
 	cmd.Flags().StringVarP(&tag, "tag", "t", "", "Tag for the pushed image")