Add Global --debug Flag for REST API Calls (#615)

mcncl · web-flow · commit 20615f316e5f · 2026-01-08T11:40:16.000+11:00
* feat: allow a debug flag for verbose output

Signed-off-by: Ben McNicholl &lt;git@benmcnicholl.com&gt;

* bug: redact token values from output of verbose logs

Signed-off-by: Ben McNicholl &lt;git@benmcnicholl.com&gt;

* chore: migrate REST functions to allow debug output

Signed-off-by: Ben McNicholl &lt;git@benmcnicholl.com&gt;

* chore: format code

Signed-off-by: Ben McNicholl &lt;git@benmcnicholl.com&gt;

---------

Signed-off-by: Ben McNicholl &lt;git@benmcnicholl.com&gt;
diff --git a/cmd/agent/list.go b/cmd/agent/list.go
@@ -71,7 +71,7 @@ Examples:
 }
 
 func (c *ListCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/agent/pause.go b/cmd/agent/pause.go
@@ -40,7 +40,7 @@ Examples:
 }
 
 func (c *PauseCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/agent/resume.go b/cmd/agent/resume.go
@@ -25,7 +25,7 @@ Examples:
 }
 
 func (c *ResumeCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/agent/stop.go b/cmd/agent/stop.go
@@ -49,7 +49,7 @@ Examples:
 }
 
 func (c *StopCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/agent/view.go b/cmd/agent/view.go
@@ -42,7 +42,7 @@ Examples:
 }
 
 func (c *ViewCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/api/api.go b/cmd/api/api.go
@@ -82,7 +82,7 @@ func buildFullEndpoint(endpoint, orgSlug string, isAnalytics bool) string {
 }
 
 func (c *ApiCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/artifacts/download.go b/cmd/artifacts/download.go
@@ -31,7 +31,7 @@ Examples:
 }
 
 func (c *DownloadCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/artifacts/list.go b/cmd/artifacts/list.go
@@ -48,7 +48,7 @@ Examples:
 }
 
 func (c *ListCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/build/cancel.go b/cmd/build/cancel.go
@@ -32,7 +32,7 @@ Examples:
 }
 
 func (c *CancelCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/build/create.go b/cmd/build/create.go
@@ -47,7 +47,7 @@ Examples:
 
 func (c *CreateCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
 	// Initialize factory
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return bkErrors.NewInternalError(err, "failed to initialize CLI", "This is likely a bug", "Report to Buildkite")
 	}
diff --git a/cmd/build/download.go b/cmd/build/download.go
@@ -46,7 +46,7 @@ Examples:
 }
 
 func (c *DownloadCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/build/list.go b/cmd/build/list.go
@@ -98,7 +98,7 @@ Examples:
 }
 
 func (c *ListCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/build/rebuild.go b/cmd/build/rebuild.go
@@ -48,7 +48,7 @@ Examples:
 }
 
 func (c *RebuildCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/build/view.go b/cmd/build/view.go
@@ -61,7 +61,7 @@ Examples:
 }
 
 func (c *ViewCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/build/watch.go b/cmd/build/watch.go
@@ -45,7 +45,7 @@ Examples:
 }
 
 func (c *WatchCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/cluster/list.go b/cmd/cluster/list.go
@@ -37,7 +37,7 @@ Examples:
 }
 
 func (c *ListCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/cluster/view.go b/cmd/cluster/view.go
@@ -37,7 +37,7 @@ Examples:
 }
 
 func (c *ViewCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/configure/configure.go b/cmd/configure/configure.go
@@ -49,7 +49,7 @@ Examples:
 }
 
 func (c *ConfigureCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/job/cancel.go b/cmd/job/cancel.go
@@ -33,7 +33,7 @@ Examples:
 }
 
 func (c *CancelCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/job/list.go b/cmd/job/list.go
@@ -104,7 +104,7 @@ func (opts jobListOptions) withoutQueue() jobListOptions {
 }
 
 func (c *ListCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/job/retry.go b/cmd/job/retry.go
@@ -29,7 +29,7 @@ Examples:
 }
 
 func (c *RetryCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/job/unblock.go b/cmd/job/unblock.go
@@ -45,7 +45,7 @@ Examples:
 }
 
 func (c *UnblockCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/organization/list.go b/cmd/organization/list.go
@@ -34,7 +34,7 @@ Examples:
 }
 
 func (c *ListCmd) Run(globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/pipeline/copy.go b/cmd/pipeline/copy.go
@@ -72,7 +72,7 @@ Examples:
 }
 
 func (c *CopyCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/pipeline/create.go b/cmd/pipeline/create.go
@@ -54,7 +54,7 @@ Examples:
 }
 
 func (c *CreateCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/pipeline/list.go b/cmd/pipeline/list.go
@@ -55,7 +55,7 @@ Examples:
 }
 
 func (c *ListCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
@@ -171,5 +171,4 @@ func (c *ListCmd) displayPipelines(pipelines []buildkite.Pipeline, f *factory.Fa
 
 	_, err := fmt.Fprintf(writer, "Pipelines (%d)\n\n%s\n", len(pipelines), table)
 	return err
-
 }
diff --git a/cmd/pipeline/migrate.go b/cmd/pipeline/migrate.go
@@ -83,7 +83,7 @@ Examples:
 }
 
 func (c *MigrateCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/pipeline/validate.go b/cmd/pipeline/validate.go
@@ -69,7 +69,7 @@ Examples:
 }
 
 func (c *ValidateCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/pipeline/view.go b/cmd/pipeline/view.go
@@ -42,7 +42,7 @@ Examples:
 }
 
 func (c *ViewCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/pkg/push.go b/cmd/pkg/push.go
@@ -54,7 +54,7 @@ Examples:
 }
 
 func (c *PushCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
@@ -120,7 +120,6 @@ func isStdinReadable() (bool, error) {
 }
 
 func (c *PushCmd) Validate() error {
-
 	// Validate the args such that either a file path is provided or stdin is being used
 
 	// check if c.FilePath and c.Stdin cannot be both set or both empty
@@ -148,11 +147,11 @@ func (c *PushCmd) Validate() error {
 
 		return nil
 	} else {
-		//Validate if an std-in arg is provided without stdin-file-name
+		// Validate if an std-in arg is provided without stdin-file-name
 		if c.StdInArg == "-" {
 			return fmt.Errorf("%w: when passing a package file via stdin, --stdin-file-name must be provided", ErrInvalidConfig)
 		}
-		//We have a file path, check it exists and is a regular file
+		// We have a file path, check it exists and is a regular file
 		fi, err := os.Stat(c.FilePath)
 		if err != nil {
 			return fmt.Errorf("%w: %w", ErrInvalidConfig, err)
diff --git a/cmd/pkg/push_test.go b/cmd/pkg/push_test.go
@@ -91,7 +91,6 @@ func TestPackagePushCommandArgs(t *testing.T) {
 
 	for _, tc := range cases {
 		t.Run(tc.name, func(t *testing.T) {
-
 			t.Parallel()
 
 			err := tc.cmd.Validate()
diff --git a/cmd/use/use.go b/cmd/use/use.go
@@ -26,7 +26,7 @@ Examples:
 }
 
 func (c *UseCmd) Run(globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/user/invite.go b/cmd/user/invite.go
@@ -28,7 +28,7 @@ Examples:
 }
 
 func (c *InviteCmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
-	f, err := factory.New()
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/cmd/whoami/whoami.go b/cmd/whoami/whoami.go
@@ -9,6 +9,7 @@ import (
 	"syscall"
 
 	"github.com/alecthomas/kong"
+	"github.com/buildkite/cli/v3/internal/cli"
 	"github.com/buildkite/cli/v3/pkg/cmd/factory"
 	"github.com/buildkite/cli/v3/pkg/cmd/validation"
 	"github.com/buildkite/cli/v3/pkg/output"
@@ -52,8 +53,8 @@ Examples:
 `
 }
 
-func (c *WhoAmICmd) Run(kongCtx *kong.Context) error {
-	f, err := factory.New()
+func (c *WhoAmICmd) Run(kongCtx *kong.Context, globals cli.GlobalFlags) error {
+	f, err := factory.New(factory.WithDebug(globals.EnableDebug()))
 	if err != nil {
 		return err
 	}
diff --git a/internal/cli/context.go b/internal/cli/context.go
@@ -5,13 +5,15 @@ type GlobalFlags interface {
 	DisableInput() bool
 	IsQuiet() bool
 	DisablePager() bool
+	EnableDebug() bool
 }
 
 type Globals struct {
 	Yes     bool
 	NoInput bool
 	Quiet   bool
 	NoPager bool
+	Debug   bool
 }
 
 func (g Globals) SkipConfirmation() bool {
@@ -29,3 +31,7 @@ func (g Globals) IsQuiet() bool {
 func (g Globals) DisablePager() bool {
 	return g.NoPager
 }
+
+func (g Globals) EnableDebug() bool {
+	return g.Debug
+}
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -310,7 +310,7 @@ func writeFileConfig(fs afero.Fs, path string, cfg fileConfig) error {
 	}
 
 	dir := filepath.Dir(path)
-	if err := fs.MkdirAll(dir, 0755); err != nil {
+	if err := fs.MkdirAll(dir, 0o755); err != nil {
 		return err
 	}
 
@@ -323,7 +323,7 @@ func writeFileConfig(fs afero.Fs, path string, cfg fileConfig) error {
 		return err
 	}
 
-	return afero.WriteFile(fs, path, data, 0600)
+	return afero.WriteFile(fs, path, data, 0o600)
 }
 
 func (cfg fileConfig) getToken(org string) string {
diff --git a/internal/config/config_test.go b/internal/config/config_test.go
@@ -103,7 +103,7 @@ func TestConfig(t *testing.T) {
 	t.Run("loadFileConfig returns error on invalid yaml", func(t *testing.T) {
 		fs := afero.NewMemMapFs()
 		path := filepath.Join(t.TempDir(), "bk.yaml")
-		if err := afero.WriteFile(fs, path, []byte("selected_org: [oops"), 0600); err != nil {
+		if err := afero.WriteFile(fs, path, []byte("selected_org: [oops"), 0o600); err != nil {
 			t.Fatalf("failed to write invalid yaml: %v", err)
 		}
 
diff --git a/internal/io/pager_test.go b/internal/io/pager_test.go
diff --git a/internal/pipeline/resolver/picker_test.go b/internal/pipeline/resolver/picker_test.go
diff --git a/main.go b/main.go
diff --git a/pkg/cmd/factory/factory.go b/pkg/cmd/factory/factory.go
diff --git a/pkg/cmd/factory/factory_test.go b/pkg/cmd/factory/factory_test.go

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ Examples:`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`func (c ListCmd) Run(kongCtx kong.Context, globals cli.GlobalFlags) error {`
`74`		`- f, err := factory.New()`
	`74`	`+ f, err := factory.New(factory.WithDebug(globals.EnableDebug()))`
`75`	`75`	`if err != nil {`
`76`	`76`	`return err`
`77`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ Examples:`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`func (c PauseCmd) Run(kongCtx kong.Context, globals cli.GlobalFlags) error {`
`43`		`- f, err := factory.New()`
	`43`	`+ f, err := factory.New(factory.WithDebug(globals.EnableDebug()))`
`44`	`44`	`if err != nil {`
`45`	`45`	`return err`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ Examples:`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`func (c ResumeCmd) Run(kongCtx kong.Context, globals cli.GlobalFlags) error {`
`28`		`- f, err := factory.New()`
	`28`	`+ f, err := factory.New(factory.WithDebug(globals.EnableDebug()))`
`29`	`29`	`if err != nil {`
`30`	`30`	`return err`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ Examples:`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`func (c StopCmd) Run(kongCtx kong.Context, globals cli.GlobalFlags) error {`
`52`		`- f, err := factory.New()`
	`52`	`+ f, err := factory.New(factory.WithDebug(globals.EnableDebug()))`
`53`	`53`	`if err != nil {`
`54`	`54`	`return err`
`55`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ Examples:`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`func (c ViewCmd) Run(kongCtx kong.Context, globals cli.GlobalFlags) error {`
`45`		`- f, err := factory.New()`
	`45`	`+ f, err := factory.New(factory.WithDebug(globals.EnableDebug()))`
`46`	`46`	`if err != nil {`
`47`	`47`	`return err`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ func buildFullEndpoint(endpoint, orgSlug string, isAnalytics bool) string {`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`func (c ApiCmd) Run(kongCtx kong.Context, globals cli.GlobalFlags) error {`
`85`		`- f, err := factory.New()`
	`85`	`+ f, err := factory.New(factory.WithDebug(globals.EnableDebug()))`
`86`	`86`	`if err != nil {`
`87`	`87`	`return err`
`88`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ Examples:`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`func (c DownloadCmd) Run(kongCtx kong.Context, globals cli.GlobalFlags) error {`
`34`		`- f, err := factory.New()`
	`34`	`+ f, err := factory.New(factory.WithDebug(globals.EnableDebug()))`
`35`	`35`	`if err != nil {`
`36`	`36`	`return err`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ Examples:`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`func (c ListCmd) Run(kongCtx kong.Context, globals cli.GlobalFlags) error {`
`51`		`- f, err := factory.New()`
	`51`	`+ f, err := factory.New(factory.WithDebug(globals.EnableDebug()))`
`52`	`52`	`if err != nil {`
`53`	`53`	`return err`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ Examples:`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`func (c CancelCmd) Run(kongCtx kong.Context, globals cli.GlobalFlags) error {`
`35`		`- f, err := factory.New()`
	`35`	`+ f, err := factory.New(factory.WithDebug(globals.EnableDebug()))`
`36`	`36`	`if err != nil {`
`37`	`37`	`return err`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ Examples:`
`47`	`47`
`48`	`48`	`func (c CreateCmd) Run(kongCtx kong.Context, globals cli.GlobalFlags) error {`
`49`	`49`	`// Initialize factory`
`50`		`- f, err := factory.New()`
	`50`	`+ f, err := factory.New(factory.WithDebug(globals.EnableDebug()))`
`51`	`51`	`if err != nil {`
`52`	`52`	`return bkErrors.NewInternalError(err, "failed to initialize CLI", "This is likely a bug", "Report to Buildkite")`
`53`	`53`	`}`