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

runtime

package

Go to main page

Versions in this module

v0

v0.15.0

May 11, 2026

Changes in this version

+ func CollectPorts(params CreateParams) []int

+ func IsPortFree(port int) bool

type CreateParams

+ DefaultPorts []int

v0.14.0

May 9, 2026

v0.13.0

May 8, 2026

v0.12.0

May 7, 2026

Changes in this version

type CreateParams

+ Model string

+ type Experimental interface

+ IsExperimental func()

type Runtime

+ DisplayName func() string

v0.11.0

May 6, 2026

Changes in this version

+ type CredentialRegistryAware interface

+ SetCredentialRegistry func(credential.Registry)

type Runtime

+ Description func() string

+ Local func() bool

v0.10.0

May 5, 2026

v0.9.0

May 5, 2026

Changes in this version

+ type ConfigTransformer interface

+ TransformConfig func(config *workspace.WorkspaceConfiguration) error

v0.8.0

May 4, 2026

Changes in this version

type CreateParams

+ RuntimeOptions map[string]string

+ type FlagDef struct

+ Completions []string

+ Name string

+ Usage string

+ type FlagProvider interface

+ Flags func() []FlagDef

v0.7.0

Apr 30, 2026

v0.6.0

Apr 28, 2026

Changes in this version

type CreateParams

+ OnecliSecrets []onecli.CreateSecretInput

+ ProjectID string

+ SecretEnvVars map[string]string

+ WorkspaceConfigDir string

+ type Dashboard interface

+ GetURL func(ctx context.Context, instanceID string) (string, error)

+ type SecretServiceRegistryAware interface

+ SetSecretServiceRegistry func(secretservice.Registry)

v0.5.0

Apr 10, 2026

Changes in this version

+ var ErrInstanceNotFound = errors.New("runtime instance not found")

+ var ErrInvalidParams = errors.New("invalid runtime parameters")

+ var ErrRuntimeNotFound = errors.New("runtime not found")

+ var ErrRuntimeUnavailable = errors.New("runtime unavailable")

+ func ValidateState(state api.WorkspaceState) error

+ type AgentLister interface

+ ListAgents func() ([]string, error)

+ type CreateParams struct

+ Agent string

+ AgentSettings map[string][]byte

+ Name string

+ SourcePath string

+ WorkspaceConfig *workspace.WorkspaceConfiguration

+ type Registry interface

+ Get func(runtimeType string) (Runtime, error)

+ List func() []string

+ Register func(runtime Runtime) error

+ func NewRegistry(storageDir string) (Registry, error)

+ type Runtime interface

+ Create func(ctx context.Context, params CreateParams) (RuntimeInfo, error)

+ Info func(ctx context.Context, id string) (RuntimeInfo, error)

+ Remove func(ctx context.Context, id string) error

+ Start func(ctx context.Context, id string) (RuntimeInfo, error)

+ Stop func(ctx context.Context, id string) error

+ Type func() string

+ WorkspaceSourcesPath func() string

+ type RuntimeInfo struct

+ ID string

+ Info map[string]string

+ State api.WorkspaceState

+ type StorageAware interface

+ Initialize func(storageDir string) error

+ type Terminal interface

+ Terminal func(ctx context.Context, instanceID string, agent string, command []string) error