Documentation
¶
Index ¶
- func WithLocalUICodeSpaceRoute(r *http.Request, codeSpaceID string) *http.Request
- func WithLocalUIEnvRoute(r *http.Request) *http.Request
- func WithLocalUIPortForwardRoute(r *http.Request, forwardID string) *http.Request
- type Backend
- type CodeRuntimeStatus
- type CodeRuntimeVersionRequest
- type CodexBackend
- type CreateSpaceRequest
- type Gateway
- type Options
- type PortForwardBackend
- type SpaceStatus
- type UpdateSpaceRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Backend ¶
type Backend interface {
ListSpaces(ctx context.Context) ([]SpaceStatus, error)
CreateSpace(ctx context.Context, req CreateSpaceRequest) (*SpaceStatus, error)
UpdateSpace(ctx context.Context, codeSpaceID string, req UpdateSpaceRequest) (*SpaceStatus, error)
DeleteSpace(ctx context.Context, codeSpaceID string) error
StartSpace(ctx context.Context, codeSpaceID string) (*SpaceStatus, error)
StopSpace(ctx context.Context, codeSpaceID string) error
ResolveCodeServerPort(ctx context.Context, codeSpaceID string) (int, error)
CodeRuntimeStatus(ctx context.Context) (CodeRuntimeStatus, error)
InstallCodeRuntime(ctx context.Context) (CodeRuntimeStatus, error)
SelectCodeRuntimeVersion(ctx context.Context, version string) (CodeRuntimeStatus, error)
RemoveCodeRuntimeVersion(ctx context.Context, version string) (CodeRuntimeStatus, error)
CancelCodeRuntimeOperation(ctx context.Context) (CodeRuntimeStatus, error)
}
type CodeRuntimeStatus ¶
type CodeRuntimeStatus = codeserver.RuntimeStatus
type CodeRuntimeVersionRequest ¶
type CodeRuntimeVersionRequest struct {
Version string `json:"version"`
}
type CodexBackend ¶
type CodexBackend interface {
Status(ctx context.Context) codexbridge.Status
ReadCapabilities(ctx context.Context, cwd string) (*codexbridge.Capabilities, error)
ListThreads(ctx context.Context, req codexbridge.ListThreadsRequest) ([]codexbridge.Thread, error)
ReadThread(ctx context.Context, threadID string) (*codexbridge.ThreadDetail, error)
StartThread(ctx context.Context, req codexbridge.StartThreadRequest) (*codexbridge.ThreadDetail, error)
StartTurn(ctx context.Context, req codexbridge.StartTurnRequest) (*codexbridge.Turn, error)
SteerTurn(ctx context.Context, req codexbridge.SteerTurnRequest) (*codexbridge.Turn, error)
ArchiveThread(ctx context.Context, threadID string) error
UnarchiveThread(ctx context.Context, threadID string) error
ForkThread(ctx context.Context, req codexbridge.ForkThreadRequest) (*codexbridge.ThreadDetail, error)
InterruptTurn(ctx context.Context, req codexbridge.InterruptTurnRequest) error
StartReview(ctx context.Context, req codexbridge.StartReviewRequest) (*codexbridge.ThreadDetail, error)
SubscribeThreadEvents(ctx context.Context, threadID string, afterSeq int64) ([]codexbridge.Event, <-chan codexbridge.Event, error)
RespondToRequest(ctx context.Context, threadID string, requestID string, resp codexbridge.PendingRequestResponse) error
}
type CreateSpaceRequest ¶
type Gateway ¶
type Gateway struct {
// contains filtered or unexported fields
}
func (*Gateway) EnvAppShellReadinessError ¶
EnvAppShellReadinessError validates that the embedded Env App shell can be opened by Desktop before the runtime advertises open-readiness.
func (*Gateway) EnvAppShellReady ¶
EnvAppShellReady reports whether the embedded Env App shell is complete.
type Options ¶
type Options struct {
Logger *slog.Logger
ListenAddr string
DistFS fs.FS
Backend Backend
PortForward PortForwardBackend
AI *ai.Service
Notes *notes.Service
WorkbenchLayout *workbenchlayout.Service
Terminal *terminal.Manager
Codex CodexBackend
Audit *auditlog.Store
Diagnostics *diagnostics.Store
ResolveSessionMeta func(channelID string) (*session.Meta, bool)
ResolveSessionTunnelURL func(channelID string) (string, bool)
// ConfigPath is the absolute path to the runtime config file.
// It is used to read and persist settings updates initiated from the Env App UI.
ConfigPath string
// SecretsStore holds user-managed secrets (such as AI provider API keys).
// If nil, the gateway will derive a default secrets path from ConfigPath.
SecretsStore *settings.SecretsStore
// ThreadReadStateStore persists per-user per-surface thread read watermarks.
ThreadReadStateStore *threadreadstate.Store
// AgentHomeDir is the canonical absolute path to the agent home directory,
// used as the filesystem scope root for the file-serving endpoint.
AgentHomeDir string
}
type PortForwardBackend ¶
type PortForwardBackend interface {
ListForwards(ctx context.Context) ([]pfregistry.Forward, error)
GetForward(ctx context.Context, forwardID string) (*pfregistry.Forward, error)
CreateForward(ctx context.Context, req portforward.CreateForwardRequest) (*pfregistry.Forward, error)
UpdateForward(ctx context.Context, forwardID string, req portforward.UpdateForwardRequest) (*pfregistry.Forward, error)
DeleteForward(ctx context.Context, forwardID string) error
TouchLastOpened(ctx context.Context, forwardID string) (*pfregistry.Forward, error)
}
type SpaceStatus ¶
type SpaceStatus struct {
CodeSpaceID string `json:"code_space_id"`
Name string `json:"name"`
Description string `json:"description"`
WorkspacePath string `json:"workspace_path"`
CodePort int `json:"code_port"`
CreatedAtUnixMs int64 `json:"created_at_unix_ms"`
UpdatedAtUnixMs int64 `json:"updated_at_unix_ms"`
LastOpenedAtUnixMs int64 `json:"last_opened_at_unix_ms"`
Running bool `json:"running"`
PID int `json:"pid"`
}
type UpdateSpaceRequest ¶
Click to show internal directories.
Click to hide internal directories.