desktop

package

v1.114.0 Latest Latest Go to latest Published: Jul 21, 2026 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/docker/docker-agent

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Variables
func GetToken(ctx context.Context) string
func GetUUID(ctx context.Context) string
func GetVersion(ctx context.Context) string
func IsDockerDesktopRunning(ctx context.Context) bool
func IsWSL() bool
type DockerDesktopPaths
type DockerHubInfo
- func GetUserInfo(ctx context.Context) DockerHubInfo
type RawClient
- func (c *RawClient) Get(ctx context.Context, endpoint string, v any) error
- func (c *RawClient) Post(ctx context.Context, endpoint string) error

Constants ¶

This section is empty.

Variables ¶

View Source

var ClientBackend = newRawClient(dialBackend)

View Source

var Paths = sync.OnceValue(func() DockerDesktopPaths {
	desktopPaths, err := getDockerDesktopPaths()
	if err != nil {
		panic(err)
	}

	return desktopPaths
})

Functions ¶

func GetToken ¶

func GetToken(ctx context.Context) string

GetToken returns Docker Desktop's access token. Desktop's newer auth stack (auth v2) serves whatever its in-memory token source holds and never refreshes on GET, so a stuck background refresher makes it return the same expired JWT forever. When that happens we force a refresh on Desktop's side.

func GetUUID ¶ added in v1.41.0

func GetUUID(ctx context.Context) string

func GetVersion ¶ added in v1.60.0

func GetVersion(ctx context.Context) string

GetVersion returns the running Docker Desktop version (e.g. "4.74.0") or an empty string if Docker Desktop is not running or the call fails.

The lookup is bounded by a short internal timeout so a stale or missing backend socket cannot stall callers on hot paths (it is queried on every outbound built-in tool HTTP request). ctx is used for the underlying HTTP call on a cache miss; on a cache hit the cached value is returned without consulting ctx.

func IsDockerDesktopRunning ¶

func IsDockerDesktopRunning(ctx context.Context) bool

func IsWSL ¶ added in v1.37.0

func IsWSL() bool

Types ¶

type DockerDesktopPaths ¶

type DockerDesktopPaths struct {
	BackendSocket string
	ProxySocket   string
}

type DockerHubInfo ¶

type DockerHubInfo struct {
	Username string `json:"id"`
	Email    string `json:"email,omitempty"`
}

func GetUserInfo ¶

func GetUserInfo(ctx context.Context) DockerHubInfo

type RawClient ¶

type RawClient struct {
	// contains filtered or unexported fields
}

func (*RawClient) Get ¶

func (c *RawClient) Get(ctx context.Context, endpoint string, v any) error

func (*RawClient) Post ¶ added in v1.114.0

func (c *RawClient) Post(ctx context.Context, endpoint string) error

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
socket

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL