codex

package

v1.0.0-rc1 Latest Latest Go to latest Published: Oct 16, 2026 License: Apache-2.0 Imports: 7 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 ¶

View Source

const (
	ComponentName     = "runnerCodex"
	FinishedEventType = "runnerCodex.finished"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type CodexBrokerTask ¶

type CodexBrokerTask struct {
	Commands []runner.BrokerCommand
	Files    []runner.BrokerTaskFile
}

CodexBrokerTask is the ordered broker commands and task files for a run.

func ApplyPlanningFollowUp ¶

func ApplyPlanningFollowUp(task CodexBrokerTask, environment []runner.BrokerEnvironmentVariable, spec RunCodexSpec) CodexBrokerTask

func BuildBrokerTask ¶

func BuildBrokerTask(spec RunCodexSpec, usage string, setups []runner.IntegrationSetup) CodexBrokerTask

func BuildDispatchedBrokerTask ¶

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

type RunCodex ¶

type RunCodex struct{}

func (*RunCodex) Cancel ¶

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

func (*RunCodex) Cleanup ¶

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

func (*RunCodex) Color ¶

func (c *RunCodex) Color() string

func (*RunCodex) Configuration ¶

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

func (*RunCodex) Description ¶

func (c *RunCodex) Description() string

func (*RunCodex) Documentation ¶

func (c *RunCodex) Documentation() string

func (*RunCodex) ExampleOutput ¶

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

func (*RunCodex) Execute ¶

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

func (*RunCodex) HandleHook ¶

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

func (*RunCodex) HandleWebhook ¶

func (c *RunCodex) HandleWebhook(ctx core.WebhookRequestContext) (int, *core.WebhookResponseBody, error)

func (*RunCodex) Hooks ¶

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

func (*RunCodex) Icon ¶

func (c *RunCodex) Icon() string

func (*RunCodex) Label ¶

func (c *RunCodex) Label() string

func (*RunCodex) Name ¶

func (c *RunCodex) Name() string

func (*RunCodex) OutputChannels ¶

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

func (*RunCodex) Setup ¶

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

type RunCodexSpec ¶

type RunCodexSpec struct {
	MachineType             string                        `mapstructure:"machineType"`
	Steps                   []runner.AgentStep            `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"`
	IncludeVisualEvidence   bool                          `mapstructure:"includeVisualEvidence"`
}

Source Files ¶

View all Source files

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