Documentation Index
Fetch the complete documentation index at: https://docs.microsandbox.dev/llms.txt
Use this file to discover all available pages before exploring further.
The Go SDK exposes local OCI image-cache operations through the package-level Image value. These APIs inspect and prune images that have already been pulled by sandbox creation.
import m "github.com/superradcompany/microsandbox/sdk/go"
Image
Image.Get()
func (imageFactory) Get(ctx context.Context, reference string) (*ImageHandle, error)
ErrImageNotFound when the image is not present in the local cache.
Image.List()
func (imageFactory) List(ctx context.Context) ([]*ImageHandle, error)
images, err := m.Image.List(ctx)
if err != nil {
return err
}
for _, img := range images {
fmt.Println(img.Reference(), img.LayerCount())
}
Image.Inspect()
func (imageFactory) Inspect(ctx context.Context, reference string) (*ImageDetail, error)
Image.Remove()
func (imageFactory) Remove(ctx context.Context, reference string, force bool) error
force is false, sandboxes still referencing the image cause ErrImageInUse.
Image.GCLayers()
func (imageFactory) GCLayers(ctx context.Context) (uint32, error)
Image.GC()
func (imageFactory) GC(ctx context.Context) (uint32, error)
ImageHandle
Returned by Image.Get and Image.List.
| Method | Returns | Description |
|---|
Reference() | string | Image reference |
ManifestDigest() | string | Content-addressable manifest digest, or empty |
Architecture() | string | Resolved architecture, or empty |
OS() | string | Resolved operating system, or empty |
LayerCount() | uint | Number of layers |
SizeBytes() | *int64 | Total size, or nil when unknown |
CreatedAt() | time.Time | First-pulled time, or zero |
LastUsedAt() | time.Time | Last referenced time, or zero |
Remove(ctx, force) | error | Delete this image |
Inspect(ctx) | (*ImageDetail, error) | Fetch full detail for this image |
ImageDetail
type ImageDetail struct {
*ImageHandle
Config *ImageConfig
Layers []ImageLayer
}
ImageConfig
Parsed OCI config block.
| Field | Type |
|---|
| Digest | string |
| Env | []string |
| Cmd | []string |
| Entrypoint | []string |
| WorkingDir | string |
| User | string |
| Labels | map[string]string |
| StopSignal | string |
ImageLayer
One layer in the image manifest.
| Field | Type |
|---|
| DiffID | string |
| BlobDigest | string |
| MediaType | string |
| CompressedSizeBytes | *int64 |
| ErofsSizeBytes | *int64 |
| Position | int32 |
