claude

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 27, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ComponentName     = "runnerClaudeCode"
	FinishedEventType = "runnerClaudeCode.finished"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ClaudeCodeStep

type ClaudeCodeStep = runner.AgentStep

ClaudeCodeStep is one ordered bash or prompt action in a Run Claude Code node.

type ClaudeCodeTask

type ClaudeCodeTask struct {
	Commands []runner.TaskCommand
	Files    []runner.TaskFile
}

ClaudeCodeTask is the ordered runner commands and task files for a run. Helpers (formatter, step scripts) ship via files under SUPERPLANE_TASK_DIR; the first command only checks prerequisites and initializes mutable state.

func ApplyPlanningFollowUp

func ApplyPlanningFollowUp(task ClaudeCodeTask, environment []runner.TaskEnvironmentVariable, spec RunClaudeCodeSpec) ClaudeCodeTask

func BuildBrokerTask

func BuildBrokerTask(spec RunClaudeCodeSpec, usage string, setups []runner.IntegrationSetup) ClaudeCodeTask

func BuildDispatchedBrokerTask

func BuildDispatchedBrokerTask(spec RunClaudeCodeSpec, usage string, setups []runner.IntegrationSetup, dispatched []runner.AgentStep, attachments []runner.TaskAttachment, inspectImages bool) ClaudeCodeTask

type RunClaudeCode

type RunClaudeCode struct{}

func (*RunClaudeCode) Cancel

func (c *RunClaudeCode) Cancel(ctx core.ExecutionContext) error

func (*RunClaudeCode) Cleanup

func (c *RunClaudeCode) Cleanup(ctx core.SetupContext) error

func (*RunClaudeCode) Color

func (c *RunClaudeCode) Color() string

func (*RunClaudeCode) Configuration

func (c *RunClaudeCode) Configuration() []configuration.Field

func (*RunClaudeCode) Description

func (c *RunClaudeCode) Description() string

func (*RunClaudeCode) Documentation

func (c *RunClaudeCode) Documentation() string

func (*RunClaudeCode) ExampleOutput

func (c *RunClaudeCode) ExampleOutput() map[string]any

func (*RunClaudeCode) Execute

func (c *RunClaudeCode) Execute(ctx core.ExecutionContext) error

func (*RunClaudeCode) HandleHook

func (c *RunClaudeCode) HandleHook(ctx core.ActionHookContext) error

func (*RunClaudeCode) HandleWebhook

func (*RunClaudeCode) Hooks

func (c *RunClaudeCode) Hooks() []core.Hook

func (*RunClaudeCode) Icon

func (c *RunClaudeCode) Icon() string

func (*RunClaudeCode) Label

func (c *RunClaudeCode) Label() string

func (*RunClaudeCode) Name

func (c *RunClaudeCode) Name() string

func (*RunClaudeCode) OutputChannels

func (c *RunClaudeCode) OutputChannels(configuration any) []core.OutputChannel

func (*RunClaudeCode) Setup

func (c *RunClaudeCode) Setup(ctx core.SetupContext) error

func (*RunClaudeCode) ValidateNodeConfiguration

func (c *RunClaudeCode) ValidateNodeConfiguration(config map[string]any) error

type RunClaudeCodeSpec

type RunClaudeCodeSpec struct {
	MachineType             string                        `mapstructure:"machineType"`
	Steps                   []ClaudeCodeStep              `mapstructure:"steps"`
	Credentials             runner.AgentCredentials       `mapstructure:"credentials"`
	Model                   string                        `mapstructure:"model"`
	ThinkingLevel           string                        `mapstructure:"thinkingLevel"`
	WorkingDirectory        string                        `mapstructure:"workingDirectory"`
	EnvironmentFrom         []runner.EnvironmentFromEntry `mapstructure:"environmentFrom"`
	Environment             []runner.EnvironmentVariable  `mapstructure:"environment"`
	ExecutionTimeoutSeconds int                           `mapstructure:"executionTimeoutSeconds"` // 0 = runner.DefaultExecutionTimeoutSeconds
	IncludeVisualEvidence   bool                          `mapstructure:"includeVisualEvidence"`

	// Legacy fields — migrated into Steps when Steps is empty.
	Prompt              string `mapstructure:"prompt"`
	EnableSetupCommands bool   `mapstructure:"enable_setup_commands"`
	SetupCommands       string `mapstructure:"setup_commands"`
	EnableAfterCommands bool   `mapstructure:"enable_after_commands"`
	AfterCommands       string `mapstructure:"after_commands"`
}

RunClaudeCodeSpec is persisted runnerClaudeCode node configuration.

Jump to

Keyboard shortcuts

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