runcodeagent

package

v0.28.0 Latest Latest Go to latest Published: Jul 9, 2026 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/superplanehq/superplane

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ExecutionMetadata ¶

type ExecutionMetadata struct {
	Session       *SessionMetadata `json:"session,omitempty" mapstructure:"session,omitempty"`
	AgentID       string           `json:"agentId,omitempty" mapstructure:"agentId,omitempty"`
	EnvironmentID string           `json:"environmentId,omitempty" mapstructure:"environmentId,omitempty"`
	VaultID       string           `json:"vaultId,omitempty" mapstructure:"vaultId,omitempty"`
	FileIDs       []string         `json:"fileIds,omitempty" mapstructure:"fileIds,omitempty"`
	Repository    string           `json:"repository,omitempty" mapstructure:"repository,omitempty"`
	Branch        string           `json:"branch,omitempty" mapstructure:"branch,omitempty"`
	PrURL         string           `json:"prUrl,omitempty" mapstructure:"prUrl,omitempty"`
}

ExecutionMetadata tracks every resource provisioned for a run so it can be displayed and, crucially, always cleaned up.

type NodeMetadata ¶

type NodeMetadata struct {
	Repository string `json:"repository,omitempty" mapstructure:"repository,omitempty"`
	BaseBranch string `json:"baseBranch,omitempty" mapstructure:"baseBranch,omitempty"`
	PrURL      string `json:"prUrl,omitempty" mapstructure:"prUrl,omitempty"`
	Model      string `json:"model,omitempty" mapstructure:"model,omitempty"`
	SourceMode string `json:"sourceMode,omitempty" mapstructure:"sourceMode,omitempty"`
}

NodeMetadata is resolved at Setup for display on the component card.

type OutputPayload ¶

type OutputPayload struct {
	Status      string `json:"status"`
	SessionID   string `json:"sessionId"`
	PrURL       string `json:"prUrl"`
	Branch      string `json:"branch"`
	LastMessage string `json:"lastMessage"`
}

OutputPayload is emitted on the default channel when the run completes.

type RunCodeAgent ¶

type RunCodeAgent struct{}

func (*RunCodeAgent) Cancel ¶

func (a *RunCodeAgent) Cancel(ctx core.ExecutionContext) error

func (*RunCodeAgent) Cleanup ¶

func (a *RunCodeAgent) Cleanup(ctx core.SetupContext) error

func (*RunCodeAgent) Color ¶

func (a *RunCodeAgent) Color() string

func (*RunCodeAgent) Configuration ¶

func (a *RunCodeAgent) Configuration() []configuration.Field

func (*RunCodeAgent) Description ¶

func (a *RunCodeAgent) Description() string

func (*RunCodeAgent) Documentation ¶

func (a *RunCodeAgent) Documentation() string

func (*RunCodeAgent) ExampleOutput ¶

func (a *RunCodeAgent) ExampleOutput() map[string]any

func (*RunCodeAgent) Execute ¶

func (a *RunCodeAgent) Execute(ctx core.ExecutionContext) error

func (*RunCodeAgent) HandleHook ¶

func (a *RunCodeAgent) HandleHook(ctx core.ActionHookContext) error

func (*RunCodeAgent) HandleWebhook ¶

func (a *RunCodeAgent) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

HandleWebhook — Managed Agents completion is observed via polling, not webhooks.

func (*RunCodeAgent) Hooks ¶

func (a *RunCodeAgent) Hooks() []core.Hook

func (*RunCodeAgent) Icon ¶

func (a *RunCodeAgent) Icon() string

func (*RunCodeAgent) Label ¶

func (a *RunCodeAgent) Label() string

func (*RunCodeAgent) Name ¶

func (a *RunCodeAgent) Name() string

func (*RunCodeAgent) OutputChannels ¶

func (a *RunCodeAgent) OutputChannels(config any) []core.OutputChannel

func (*RunCodeAgent) ProcessQueueItem ¶

func (a *RunCodeAgent) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*RunCodeAgent) Setup ¶

func (a *RunCodeAgent) Setup(ctx core.SetupContext) error

type SecretRef ¶

type SecretRef struct {
	Secret string `json:"secret" mapstructure:"secret"`
	Key    string `json:"key" mapstructure:"key"`
}

SecretRef references a SuperPlane secret by name and key.

type SessionMetadata ¶

type SessionMetadata struct {
	ID     string `json:"id" mapstructure:"id"`
	Status string `json:"status" mapstructure:"status"`
}

SessionMetadata tracks the Managed Agents session.

type Spec ¶

type Spec struct {
	SourceMode   string    `json:"sourceMode" mapstructure:"sourceMode"`
	Repository   string    `json:"repository" mapstructure:"repository"`
	BaseBranch   string    `json:"baseBranch" mapstructure:"baseBranch"`
	BranchName   string    `json:"branchName" mapstructure:"branchName"`
	AutoCreatePr *bool     `json:"autoCreatePr" mapstructure:"autoCreatePr"`
	PrURL        string    `json:"prUrl" mapstructure:"prUrl"`
	Task         string    `json:"task" mapstructure:"task"`
	GithubToken  SecretRef `json:"githubToken" mapstructure:"githubToken"`
	ActAsBot     *bool     `json:"actAsBot" mapstructure:"actAsBot"`
	Model        string    `json:"model" mapstructure:"model"`
	Networking   string    `json:"networking" mapstructure:"networking"`
	AllowedHosts []string  `json:"allowedHosts" mapstructure:"allowedHosts"`
	Files        []string  `json:"files" mapstructure:"files"`
}

Spec is the workflow node configuration for claude.runCodeAgent.

Source Files ¶

View all Source files

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