Go quickstart

go get github.com/boxlite-ai/boxlite/sdks/go
go run github.com/boxlite-ai/boxlite/sdks/go/cmd/setup

package main

import (
	"context"
	"fmt"
	"log"

	boxlite "github.com/boxlite-ai/boxlite/sdks/go"
)

func main() {
	ctx := context.Background()

	// 1. Get the runtime (synchronous construction; no .Close() needed until you're done with it)
	rt, err := boxlite.NewRuntime()
	if err != nil {
		log.Fatal(err)
	}
	defer rt.Close()

	// 2. Create a box (default rootfs is set by the image argument)
	box, err := rt.Create(ctx, "alpine:latest")
	if err != nil {
		log.Fatal(err)
	}
	defer box.Close()

	// 3. Execute a command — Exec implicitly starts the box on first call
	res, err := box.Exec(ctx, "echo", "Hello from BoxLite!")
	if err != nil {
		// A nil res accompanies a non-nil err: check err before touching res
		log.Fatal(err)
	}

	// 4. A non-zero exit code does not become an error — check it yourself
	if res.ExitCode != 0 {
		fmt.Printf("command failed (exit=%d): %s", res.ExitCode, res.Stderr)
		return
	}
	fmt.Print(res.Stdout)
}

Hello from BoxLite!

boxlite-setup: download failed: tar: context deadline exceeded (Client.Timeout or context cancellation while reading body)

panic: runtime error: invalid memory address or nil pointer dereference

res, err := box.Exec(ctx, "definitely-not-a-binary")
if err != nil {
	log.Fatal(err) // res is nil here — do not dereference it
}
fmt.Println(res.ExitCode)

res, _ := box.Exec(ctx, "sh", "-c", "exit 7")
fmt.Println(res.ExitCode) // 7, err was nil

_, err := rt.Get(ctx, "no-such-box")
if boxlite.IsNotFound(err) {
	fmt.Println("box does not exist")
}