clipboard

package

v0.10.3 Latest Latest Go to latest Published: Mar 15, 2026 License: MIT Imports: 2 Imported by: 0

Details

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

Repository

github.com/mark3labs/kit

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package clipboard provides cross-platform clipboard image reading for Kit.

Terminals cannot paste binary image data via bracketed paste — only text is supported. To read images we shell out to platform-specific clipboard tools:

Linux X11: xclip -selection clipboard -t image/png -o
Linux Wayland: wl-paste --type image/png
macOS: osascript + pbpaste (via a helper that reads NSPasteboard)
Windows/WSL: powershell Get-Clipboard -Format Image (not yet supported)

The ReadImage function returns the raw image bytes and detected MIME type, or an error if no image is available on the clipboard.

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNoClipboardTool = fmt.Errorf("no clipboard tool available (install xclip, wl-paste, or use macOS)")

ErrNoClipboardTool is returned when no suitable clipboard tool is found.

View Source

var ErrNoImage = fmt.Errorf("no image data on clipboard")

ErrNoImage is returned when the clipboard does not contain image data.

Functions ¶

func DetectMediaType ¶

func DetectMediaType(data []byte) string

DetectMediaType inspects the magic bytes of data to determine the image MIME type. Returns empty string if the format is not recognized.

Types ¶

type ImageData ¶

type ImageData struct {
	// Data is the raw image bytes (PNG, JPEG, etc.).
	Data []byte
	// MediaType is the MIME type (e.g. "image/png", "image/jpeg").
	MediaType string
}

ImageData holds the result of a clipboard image read.

func ReadImage ¶

func ReadImage() (*ImageData, error)

ReadImage reads image data from the system clipboard on Linux. It tries xclip first (X11), then falls back to wl-paste (Wayland).

Source Files ¶

View all Source files

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