domain

package

Go to main page

Versions in this module

v0

v0.0.28

May 6, 2026

Changes in this version

+ type CommandHook struct

+ AllowCache *bool

+ Command string

+ func (h *CommandHook) UnmarshalYAML(value *yaml.Node) error

+ func (h CommandHook) CacheAllowed() bool

+ func (h CommandHook) IsConfigured() bool

type StepOpts

+ AllowCache *bool

v0.0.27

May 5, 2026

v0.0.26

May 4, 2026

v0.0.25

Apr 28, 2026

Changes in this version

type RunnerConfig

+ Build string

v0.0.24

Apr 28, 2026

v0.0.23

Apr 27, 2026

Changes in this version

type DomainSSHComputeAccess

+ func (s *DomainSSHComputeAccess) EnsureRootWritable(ctx context.Context) error

v0.0.22

Apr 22, 2026

v0.0.21

Apr 22, 2026

v0.0.20

Apr 22, 2026

Changes in this version

+ type CoreResetOpts struct

+ NoPropagate bool

type Manager

+ func (m *Manager) SyncRemote(ctx context.Context, envName string) error

v0.0.19

Apr 22, 2026

v0.0.18

Mar 31, 2026

v0.0.17

Mar 31, 2026

v0.0.16

Mar 31, 2026

Changes in this version

type ComputeAccess

+ VerboseExec func(ctx context.Context, command string, env []string) (stdout string, err error)

type DomainLocalComputeAccess

+ func (l *DomainLocalComputeAccess) VerboseExec(ctx context.Context, command string, env []string) (string, error)

type DomainSSHComputeAccess

+ func (s *DomainSSHComputeAccess) VerboseExec(ctx context.Context, command string, env []string) (string, error)

v0.0.15

Mar 30, 2026

v0.0.14

Mar 30, 2026

Changes in this version

type SSHComputeAccessOpts

+ IdentityFile string

type SSHConfig

+ IdentityFile string

+ UserCommand string

v0.0.13

Mar 30, 2026

Changes in this version

type EnvironmentEntry

+ func (e *EnvironmentEntry) InvalidateStep(name, reason string) bool

type StepRecordStatus

+ const StepRecordInvalidated

v0.0.12

Mar 30, 2026

v0.0.11

Mar 30, 2026

v0.0.10

Mar 30, 2026

v0.0.9

Mar 30, 2026

v0.0.8

Mar 30, 2026

v0.0.7

Mar 29, 2026

Changes in this version

+ func GenerateComposeFile(cfg *ProjectConfig, manifest *Manifest) ([]byte, error)

+ func GenerateErrorPages(envName string) map[string][]byte

+ func GenerateNginxConfig(cfg *ProjectConfig, manifest *Manifest, domain string) ([]byte, error)

+ type ComposeConfig struct

+ Autostart []string

+ Image string

+ Proxy *ProxyConfig

type ComputeAccess

+ func NewDomainSSHComputeAccessWithOpts(opts SSHComputeAccessOpts) ComputeAccess

type ComputeAccessInfo

+ Metadata map[string]string

type ComputeHooks

+ SSH *SSHConfig

type DomainLocalComputeAccess

+ func (l *DomainLocalComputeAccess) SetStderr(w io.Writer)

type DomainSSHComputeAccess

+ func (s *DomainSSHComputeAccess) ProxyCommand() string

+ func (s *DomainSSHComputeAccess) SSHArgs() []string

+ func (s *DomainSSHComputeAccess) SetStderr(w io.Writer)

type EnvironmentEntry

+ EnabledServices []string

+ Env map[string]string

+ func (e *EnvironmentEntry) DisableService(name string)

+ func (e *EnvironmentEntry) EnableService(name string)

+ func (e *EnvironmentEntry) GetEnv(key string) (string, bool)

+ func (e *EnvironmentEntry) IsServiceEnabled(name string) bool

+ func (e *EnvironmentEntry) SetEnv(key, value string)

type Manager

+ func (m *Manager) BuildSSHComputeAccess(entry *EnvironmentEntry) ComputeAccess

+ func (m *Manager) DryRunStep(ctx context.Context, envName, stepName string) (string, error)

+ func (m *Manager) GetEnvironment(ctx context.Context, envName string) (*EnvironmentEntry, error)

+ func (m *Manager) PrintStep(ctx context.Context, envName, stepName string) (string, error)

+ func (m *Manager) Reconcile(ctx context.Context, envName string, dryRun ...bool) (*ReconcileReport, error)

+ func (m *Manager) RunStep(ctx context.Context, envName, stepName string) error

+ func (m *Manager) RunSteps(ctx context.Context, envName string, stepNames []string) error

+ func (m *Manager) SaveEnvironment(ctx context.Context, envName string, entry *EnvironmentEntry) error

type Manifest

+ EnabledServices []string

type NoopReporter

+ func (NoopReporter) StderrWriter() io.Writer

type ProgressReporter

+ StderrWriter func() io.Writer

+ type ProxyConfig struct

+ Domain string

+ Enabled *bool

+ Type string

+ func (p *ProxyConfig) IsEnabled() bool

+ func (p *ProxyConfig) ResolvedType() string

+ type ReconcileReport struct

+ Failed int

+ Healed int

+ NotRun int

+ OK int

+ Results []ReconcileResult

+ Skipped int

+ type ReconcileResult struct

+ Action string

+ DurationMs int64

+ Message string

+ Step string

type RunnerConfig

+ Compose *ComposeConfig

+ type SSHComputeAccessOpts struct

+ Host string

+ ProxyCommand string

+ Root string

+ User string

+ type SSHConfig struct

+ ProxyCommand string

+ Root string

+ User string

type ServiceConfig

+ Build string

+ Proxy []ServiceProxy

+ Start string

+ type ServiceProxy struct

+ Path string

+ TargetPath string

+ To ServiceProxyTarget

+ func (p *ServiceProxy) ResolvedTargetPath() string

+ type ServiceProxyTarget struct

+ Service string

type TemplateContext

+ ProxyDomain string

+ Store map[string]string

v0.0.6

Mar 25, 2026

Changes in this version

+ func BuildComposeEnv(projectName, envName string, ports PortMap) []string

type TemplateContext

+ EnvName string

v0.0.5

Mar 25, 2026

Changes in this version

+ func SanitizeName(name string) string

v0.0.4

Mar 23, 2026

Changes in this version

+ func ComposeProjectName(projectName, envName string) string

+ func Hostname() string

+ func RenderEnvFileContent(env map[string]string) []byte

+ func WriteManifest(m *Manifest, w io.Writer) error

+ type AuditEntry struct

+ Action string

+ DurationMs int64

+ Error string

+ Machine string

+ Message string

+ Step string

+ Timestamp time.Time

+ type ComputeAccess interface

+ Exec func(ctx context.Context, command string, env []string) (stdout string, err error)

+ ReadFile func(ctx context.Context, relPath string) ([]byte, error)

+ Root func() string

+ WriteFile func(ctx context.Context, relPath string, data []byte, mode os.FileMode) error

+ func NewDomainLocalComputeAccess(root string) ComputeAccess

+ func NewDomainSSHComputeAccess(host, user, root string) ComputeAccess

+ type ComputeAccessInfo struct

+ Host string

+ ManagedWorktree bool

+ Path string

+ Type string

+ User string

+ type ComputeHooks struct

+ Create string

+ Destroy string

+ Outputs []string

type ComputePort

+ DetectBranch func(ctx context.Context, worktreePath string) (string, error)

+ type DomainLocalComputeAccess struct

+ func (l *DomainLocalComputeAccess) Exec(ctx context.Context, command string, env []string) (string, error)

+ func (l *DomainLocalComputeAccess) ReadFile(_ context.Context, relPath string) ([]byte, error)

+ func (l *DomainLocalComputeAccess) Root() string

+ func (l *DomainLocalComputeAccess) WriteFile(_ context.Context, relPath string, data []byte, mode os.FileMode) error

+ type DomainSSHComputeAccess struct

+ func (s *DomainSSHComputeAccess) Exec(ctx context.Context, command string, env []string) (string, error)

+ func (s *DomainSSHComputeAccess) Host() string

+ func (s *DomainSSHComputeAccess) ReadFile(ctx context.Context, relPath string) ([]byte, error)

+ func (s *DomainSSHComputeAccess) Root() string

+ func (s *DomainSSHComputeAccess) User() string

+ func (s *DomainSSHComputeAccess) WriteFile(ctx context.Context, relPath string, data []byte, _ os.FileMode) error

type EnvironmentEntry

+ AuditLog []AuditEntry

+ Compute *ComputeAccessInfo

+ ProvisionerOutputs map[string]map[string]string

+ Steps map[string]*StepRecord

+ func (e *EnvironmentEntry) AppendAudit(entry AuditEntry)

+ func (e *EnvironmentEntry) InvalidateStepsFrom(stepName string, orderedSteps []string)

+ func (e *EnvironmentEntry) IsManagedWorktree() bool

+ func (e *EnvironmentEntry) SetStepRecord(rec *StepRecord)

+ func (e *EnvironmentEntry) StepCompleted(name string) bool

+ func (e *EnvironmentEntry) StepOutputs(name string) map[string]any

+ func (e *EnvironmentEntry) WorktreePath() string

type EnvironmentStatus

+ const StatusProvisioned

type Manager

+ func (m *Manager) Attach(ctx context.Context, envName string, worktreePath string) (*EnvironmentEntry, error)

+ func (m *Manager) BuildProvisionerStepOrder() []string

+ func (m *Manager) BuildRunnerStepOrder() []string

+ func (m *Manager) Provision(ctx context.Context, envName, branch, fromStep string) (*EnvironmentEntry, error)

+ func (m *Manager) ProvisionAttach(ctx context.Context, envName, worktreePath, fromStep string) (*EnvironmentEntry, error)

+ func (m *Manager) Run(ctx context.Context, manifestPath, fromStep string) error

+ func (m *Manager) SetNoCache(v bool)

+ func (m *Manager) SetStatus(ctx context.Context, envName string, status EnvironmentStatus) error

type ManagerDeps

+ NoCache bool

+ type Manifest struct

+ Branch string

+ EnvName string

+ Infrastructure *ManifestInfrastructure

+ Mode string

+ Ports PortMap

+ ProjectName string

+ ProvisionerOutputs map[string]map[string]string

+ Services map[string]ManifestService

+ Version int

+ func BuildManifest(cfg *ProjectConfig, envName, branch, mode string, ports PortMap, ...) (*Manifest, error)

+ func ReadManifest(r io.Reader) (*Manifest, error)

+ func (m *Manifest) EnvFilePaths() map[string]map[string]string

+ type ManifestInfrastructure struct

+ ComposeFile string

+ type ManifestService struct

+ Env map[string]string

+ EnvFile string

+ Path string

type ProjectConfig

+ Provisioner ProvisionerConfig

+ Runner *RunnerConfig

+ type ProvisionerConfig struct

+ After string

+ Before string

+ Compute *ComputeHooks

+ Services map[string]ProvisionerServiceConfig

+ type ProvisionerServiceConfig struct

+ Destroy string

+ Init string

+ Outputs []string

+ Reset string

+ Seed string

+ type RunnerConfig struct

+ After string

+ Before string

+ Deploy string

+ Destroy string

+ type StepOpts struct

+ CompleteMsg *string

+ Fn func() error

+ Name string

+ Outputs func() map[string]any

+ StartMsg string

+ Verify VerifyFunc

+ type StepRecord struct

+ DurationMs int64

+ Error string

+ FinishedAt time.Time

+ Machine string

+ Name string

+ Outputs map[string]any

+ StartedAt time.Time

+ Status StepRecordStatus

+ type StepRecordStatus string

+ const StepRecordCompleted

+ const StepRecordFailed

type TemplateContext

+ ProvisionerOutputs map[string]map[string]string

+ type VerifyFunc func(ctx context.Context) error

v0.0.3

Mar 19, 2026

Changes in this version

type StepStatus

+ const StepStreaming

v0.0.2

Mar 19, 2026

Changes in this version

+ func ExecuteCoreHook(ctx context.Context, hookScript string, declaredOutputs []string, env []string, ...) (map[string]string, error)

+ func ParseComposeFile(path string) (map[string]InfraService, error)

+ func WorktreeBasePath() string

type CoreConfig

+ Services map[string]CoreServiceConfig

+ type CoreServiceConfig struct

+ Hooks *CoreServiceHooks

+ Outputs []string

+ type CoreServiceHooks struct

+ Destroy string

+ Init string

+ Reset string

+ Seed string

type EnvironmentEntry

+ CoreOutputs map[string]map[string]string

type HookContext

+ CoreOutputs map[string]map[string]string

+ type InfraService struct

+ EnvVar string

+ Image string

+ Name string

+ Port int

+ type InfrastructureConfig struct

+ ComposeFile string

type Manager

+ func (m *Manager) CoreInit(ctx context.Context, svcName string) error

+ func (m *Manager) CoreReset(ctx context.Context, svcName, envName string) error

+ func (m *Manager) RunCoreHook(ctx context.Context, svcName, action, envName string) (map[string]string, error)

type PortMap

+ func AllocatePortBlock(envName string, serviceNames []string) (PortMap, error)

type ProjectConfig

+ InfraServices map[string]InfraService

+ Mode string

+ func LoadConfigWithOverlay(basePath, mode string) (*ProjectConfig, error)

+ func (c *ProjectConfig) ServiceNames() []string

type ServiceConfig

+ EnvFile string

+ func (s ServiceConfig) ResolvedEnvFile() string

type TemplateContext

+ CoreOutputs map[string]map[string]string

+ CurrentService string

+ InfraPorts PortMap

+ ServicePorts PortMap

v0.0.1

Mar 18, 2026

Changes in this version

+ func AllocatePortOffset(envName string) int

+ func RenderEnvMap(envMap map[string]string, ctx *TemplateContext) (map[string]string, error)

+ func RenderTemplate(tmpl string, ctx *TemplateContext) (string, error)

+ func ResolveEnvironmentFromCwd(cwd string, environments map[string]*EnvironmentEntry) (string, error)

+ func TopologicalSort(services map[string]ServiceConfig) ([]string, error)

+ func ValidateConfig(cfg *ProjectConfig) error

+ func ValidateConfigWithFS(cfg *ProjectConfig, projectRoot string, fileExists func(string) bool) error

+ type ComputePort interface

+ Create func(ctx context.Context, envName string, branch string) (*ComputeResources, error)

+ Destroy func(ctx context.Context, envName string) error

+ IsRunning func(ctx context.Context, envName string) (bool, error)

+ Start func(ctx context.Context, envName string, ports PortMap) error

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

+ type ComputeResources struct

+ ExternalIP string

+ VMId string

+ WorktreePath string

+ type CoreConfig struct

+ Databases map[string]DatabaseConfig

+ type DatabaseConfig struct

+ Engine string

+ Image string

+ Password string

+ Port int

+ Seed *SeedConfig

+ TemplateDb string

+ User string

+ type DatabaseInfo struct

+ ConnectionString string

+ Database string

+ Host string

+ Password string

+ Port int

+ User string

+ type DatabasePort interface

+ CreateDatabase func(ctx context.Context, envName string) (*DatabaseInfo, error)

+ DatabaseExists func(ctx context.Context, envName string) (bool, error)

+ DestroyDatabase func(ctx context.Context, envName string) error

+ EnsureInfrastructure func(ctx context.Context) error

+ ResetDatabase func(ctx context.Context, envName string) (*DatabaseInfo, error)

+ SeedTemplate func(ctx context.Context, snapshotPath string) error

+ type DatabaseRef struct

+ Name string

+ Provider string

+ type EnvPort interface

+ Cleanup func(ctx context.Context, workdir string) error

+ Generate func(ctx context.Context, envName string, workdir string, ports PortMap, ...) error

+ SymlinkSharedEnvFiles func(ctx context.Context, workdir string) error

+ type EnvironmentDetail struct

+ DatabaseExists map[string]bool

+ Entry *EnvironmentEntry

+ InfraRunning bool

+ SnapshotInfo map[string]*SnapshotState

+ type EnvironmentEntry struct

+ Branch string

+ CreatedAt time.Time

+ Databases map[string]DatabaseRef

+ Local *LocalMeta

+ Mode EnvironmentMode

+ Name string

+ Ports PortMap

+ Remote *RemoteMeta

+ Status EnvironmentStatus

+ UpdatedAt time.Time

+ type EnvironmentMode string

+ const ModeLocal

+ const ModePreview

+ const ModeSandbox

+ type EnvironmentStatus string

+ const StatusCreating

+ const StatusError

+ const StatusRunning

+ const StatusStopped

+ type HookContext struct

+ Branch string

+ Databases map[string]*DatabaseInfo

+ EnvName string

+ Phase string

+ Ports PortMap

+ ProjectName string

+ ProjectRoot string

+ Step string

+ WorktreePath string

+ type HookDef struct

+ ContinueOnError bool

+ Run string

+ type HookRunner struct

+ func NewHookRunner(hooks HooksConfig, progress ProgressReporter) *HookRunner

+ func (r *HookRunner) RunAfter(ctx context.Context, step string, hctx *HookContext) error

+ func (r *HookRunner) RunBefore(ctx context.Context, step string, hctx *HookContext) error

+ type HooksConfig map[string]StepHooks

+ type InfraServiceConfig struct

+ Image string

+ Port int

+ type LocalConfig struct

+ ComposeFile string

+ Worktree WorktreeConfig

+ type LocalMeta struct

+ ComposeProjectName string

+ WorktreePath string

+ type Manager struct

+ func NewManager(deps ManagerDeps) *Manager

+ func (m *Manager) Destroy(ctx context.Context, envName string) error

+ func (m *Manager) Init(ctx context.Context, envName string, branch string) (*EnvironmentEntry, error)

+ func (m *Manager) List(ctx context.Context) ([]*EnvironmentEntry, error)

+ func (m *Manager) ResetDatabase(ctx context.Context, envName string, dbName string) error

+ func (m *Manager) SeedTemplate(ctx context.Context, dbName string, snapshotPath string) error

+ func (m *Manager) Status(ctx context.Context, envName string) (*EnvironmentDetail, error)

+ type ManagerDeps struct

+ Compute ComputePort

+ Config *ProjectConfig

+ Databases map[string]DatabasePort

+ EnvGen EnvPort

+ Networking NetworkingPort

+ Progress ProgressReporter

+ ProjectRoot string

+ State StatePort

+ type NetworkingPort interface

+ AllocatePorts func(envName string) PortMap

+ GetServiceURL func(envName string, service string) (string, error)

+ type NoopReporter struct

+ func (NoopReporter) OnStep(StepEvent)

+ type PortMap map[string]int

+ func AllocatePorts(envName string, basePorts map[string]int) PortMap

+ type ProgressReporter interface

+ OnStep func(event StepEvent)

+ type ProjectConfig struct

+ Core CoreConfig

+ Hooks HooksConfig

+ Infrastructure map[string]InfraServiceConfig

+ Local *LocalConfig

+ Name string

+ PackageManager string

+ Services map[string]ServiceConfig

+ Version int

+ func LoadConfig(path string) (*ProjectConfig, error)

+ func ParseConfig(data []byte) (*ProjectConfig, error)

+ func (c *ProjectConfig) AllBasePorts() map[string]int

+ type ProvisionerPort interface

+ Deprovision func(ctx context.Context, vmID string) error

+ Provision func(ctx context.Context, envName string, spec VMSpec) (*VMInfo, error)

+ Status func(ctx context.Context, vmID string) (*VMInfo, error)

+ type RemoteMeta struct

+ ExternalIP string

+ VMId string

+ type SeedConfig struct

+ Script string

+ Snapshot *SnapshotConfig

+ Strategy string

+ type ServiceConfig struct

+ Command string

+ DependsOn []string

+ Env map[string]string

+ Path string

+ Port int

+ type SnapshotConfig struct

+ Bucket string

+ Prefix string

+ Region string

+ Source string

+ type SnapshotState struct

+ LastSeeded *time.Time

+ TemplateReady bool

+ type SnapshotUpdate struct

+ LastSeeded *time.Time

+ TemplateReady *bool

+ type State struct

+ Environments map[string]*EnvironmentEntry

+ Snapshots map[string]*SnapshotState

+ Version int

+ func NewState() *State

+ type StatePort interface

+ GetEnvironment func(ctx context.Context, name string) (*EnvironmentEntry, error)

+ Load func(ctx context.Context) (*State, error)

+ RemoveEnvironment func(ctx context.Context, name string) error

+ Save func(ctx context.Context, state *State) error

+ SetEnvironment func(ctx context.Context, name string, entry *EnvironmentEntry) error

+ UpdateSnapshot func(ctx context.Context, dbName string, info *SnapshotUpdate) error

+ type StepEvent struct

+ Error error

+ Message string

+ Status StepStatus

+ Step string

+ type StepHooks struct

+ After []HookDef

+ Before []HookDef

+ type StepStatus string

+ const StepCompleted

+ const StepFailed

+ const StepSkipped

+ const StepStarted

+ type TemplateContext struct

+ Databases map[string]*DatabaseInfo

+ Ports PortMap

+ type VMInfo struct

+ ExternalIP string

+ ID string

+ Status string

+ type VMSpec struct

+ DiskSizeGB int

+ Image string

+ MachineType string

+ Region string

+ type ValidationError struct

+ Errors []string

+ func (e *ValidationError) Error() string

+ type WorktreeConfig struct

+ BasePath string

+ SymlinkPatterns []string

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