client

Documentation

Index

• func IsDebug(cmd *cobra.Command) bool
• func IsDryRun(cmd *cobra.Command) bool
• func NewClient(cmd *cobra.Command) (*sdk.CompassCLI, error)
• type DebugClient
  • func (c *DebugClient) Do(req *http.Request) (*http.Response, error)
• type DryRunClient
  • func (c *DryRunClient) Do(req *http.Request) (*http.Response, error)
• type HTTPClient
  • func WrapClientForDiagnostics(cmd *cobra.Command, inner HTTPClient) HTTPClient

Functions

func IsDebug

func IsDebug(cmd *cobra.Command) bool

IsDebug returns true when --debug is set and --dry-run is not. When both flags are set, dry-run takes precedence.

func IsDryRun

func IsDryRun(cmd *cobra.Command) bool

IsDryRun returns true when --dry-run is set on the command.

func NewClient

func NewClient(cmd *cobra.Command) (*sdk.CompassCLI, error)

NewClient creates a new SDK client configured from command flags and environment. It handles global security, server URL/selection override, global parameters, retry configuration, timeout, and test client injection.

Types

type DebugClient

type DebugClient struct {
	Inner  HTTPClient
	Stderr io.Writer
}

DebugClient wraps an HTTP client and logs request/response diagnostics to stderr.

func (*DebugClient) Do

func (c *DebugClient) Do(req *http.Request) (*http.Response, error)

Do executes the request, logging diagnostics before and after.

type DryRunClient

type DryRunClient struct {
	Stderr io.Writer
}

DryRunClient intercepts HTTP requests and returns a synthetic response without making any network calls.

func (*DryRunClient) Do

func (c *DryRunClient) Do(req *http.Request) (*http.Response, error)

Do logs the request preview and returns a synthetic 200 response.

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient is the interface that SDK clients implement.

func WrapClientForDiagnostics

func WrapClientForDiagnostics(cmd *cobra.Command, inner HTTPClient) HTTPClient

WrapClientForDiagnostics wraps an HTTP client based on diagnostics mode. Returns the original client if no diagnostics flags are set.