Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v1

v1.2.0

Jan 15, 2026

Changes in this version

+ type DiffOption func(*DiffOptions)

+ func WithTUFEnabled(enabled bool) DiffOption

+ type DiffOptions struct

+ EnableTUF bool

+ type DiffReport struct

+ Blobs map[string][]compose.BlobInfo

+ DiskSize int64

+ FromTarget *target.Target

+ ToTarget *target.Target

+ WireSize int64

+ func Diff(ctx context.Context, cfg *config.Config, fromVersion, toVersion int, ...) (*DiffReport, error)

v1.1.1

Dec 11, 2025

v1.1.0

Dec 4, 2025

v1.0.0

Nov 6, 2025

Changes in this version

+ type FetchProgressFunc = compose.FetchProgressFunc

+ type InstallProgressFunc = compose.InstallProgressFunc

+ type PostStateHandler func(StateName, *UpdateInfo)

+ type PreStateHandler func(StateName, *UpdateInfo)

+ type StartProgressFunc = compose.AppStartProgress

+ type StateName = state.ActionName

+ type UpdateInfo = state.UpdateInfo

+ type UpdateMode = state.UpdateMode

+ type UpdateOpt func(*UpdateOpts)

+ func WithEventSender(sender *events.EventSender) UpdateOpt

+ func WithFetchProgressHandler(handler FetchProgressFunc) UpdateOpt

+ func WithForceUpdate(enabled bool) UpdateOpt

+ func WithGatewayClient(client *client.GatewayClient) UpdateOpt

+ func WithInstallProgressHandler(handler InstallProgressFunc) UpdateOpt

+ func WithMaxAttempts(count int) UpdateOpt

+ func WithPostStateHandler(handler PostStateHandler) UpdateOpt

+ func WithPreStateHandler(handler PreStateHandler) UpdateOpt

+ func WithRequireLatest(enabled bool) UpdateOpt

+ func WithStartProgressHandler(handler StartProgressFunc) UpdateOpt

+ func WithSyncCurrent(enabled bool) UpdateOpt

+ type UpdateOpts struct

+ EnableTUF bool

+ FetchProgressHandler FetchProgressFunc

+ Force bool

+ InstallProgressHandler InstallProgressFunc

+ MaxAttempts int

+ RequireLatest bool

+ StartProgressHandler StartProgressFunc

+ SyncCurrent bool

+ type UpdateRunner struct

+ func (sm *UpdateRunner) GetFromTarget() target.Target

+ func (sm *UpdateRunner) Run(ctx context.Context, cfg *config.Config) error

+ type UpdateRunnerOpt func(*UpdateRunnerOpts)

+ type UpdateRunnerOpts struct

+ EventSender *events.EventSender

+ GatewayClient *client.GatewayClient

+ PostStateHandler PostStateHandler

+ PreStateHandler PreStateHandler

v0

v0.9.0

Oct 13, 2025

Changes in this version

+ func Check(cfg *config.Config, options ...CheckOpt) (target.Targets, error)

+ type CheckOpt func(*CheckOpts)

+ func WithTUF(enabled bool) CheckOpt

+ type CheckOpts struct

+ TUF bool

v0.2.0

Oct 2, 2025

Changes in this version

+ func Cancel(ctx context.Context, cfg *config.Config) (string, error)

v0.1.0

Oct 1, 2025

Changes in this version

+ func Fetch(ctx context.Context, cfg *config.Config, toVersion int) error

+ func Install(ctx context.Context, cfg *config.Config) error

+ func Start(ctx context.Context, cfg *config.Config) error

+ func Update(ctx context.Context, cfg *config.Config, toVersion int) error

+ type AppStatus struct

+ Fetched bool

+ Installed bool

+ Name string

+ Running bool

+ URI string

+ type BlobStats struct

+ Bytes int64

+ NumBlobs int

+ type CurrentStatus struct

+ AppStatuses []AppStatus

+ CompletedAt time.Time

+ TargetID string

+ UpdateID string

+ func GetCurrentStatus(ctx context.Context, cfg *compose.Config) (*CurrentStatus, error)

+ type UpdateStatus struct

+ Apps []string

+ FetchedSize BlobStats

+ ID string

+ Progress int

+ Size BlobStats

+ StartTime time.Time

+ State update.State

+ TargetID string

+ UpdatedAt time.Time

+ func GetUpdateStatus(cfg *compose.Config) (*UpdateStatus, error)