Surface: Go SdkStability: Public StableMaturity: StableSource

codex

Generated from the public Go package via gomarkdoc.

Import path: github.com/777genius/plugin-kit-ai/sdk/codex

import "github.com/777genius/plugin-kit-ai/sdk/codex"

Package codex exposes typed public event inputs, responses, and registrars for Codex runtime integrations.

Index

• func RegisterCustomJSON[T any](r *Registrar, eventName string, fn func(*T) *Response) error
• type NotifyEvent
  • func (e *NotifyEvent) RawJSON() json.RawMessage
• type PermissionRequestEvent
• type PreToolUseEvent
• type Registrar
  • func NewRegistrar(backend runtime.RegistrarBackend) *Registrar
  • func (r *Registrar) OnNotify(fn func(*NotifyEvent) *Response)
  • func (r *Registrar) OnPermissionRequest(fn func(*PermissionRequestEvent) *Response)
  • func (r *Registrar) OnPreToolUse(fn func(*PreToolUseEvent) *Response)
  • func (r *Registrar) OnStop(fn func(*StopEvent) *Response)
  • func (r *Registrar) OnSubagentStop(fn func(*SubagentStopEvent) *Response)
• type Response
  • func Continue() *Response
• type StopEvent
• type SubagentStopEvent

func RegisterCustomJSON

func RegisterCustomJSONT any *Response) error

RegisterCustomJSON registers an experimental future Codex hook whose payload is delivered as a JSON argv argument. The handler remains fully typed.

type NotifyEvent

NotifyEvent is the decoded Codex notify payload and its raw JSON form.

type NotifyEvent struct {
    // Raw keeps the original notify payload as it was received from argv JSON.
    Raw json.RawMessage
    // Client identifies the Codex client variant that emitted the event.
    Client string
}

func (*NotifyEvent) RawJSON

func (e *NotifyEvent) RawJSON() json.RawMessage

RawJSON returns the original JSON payload for pass-through or custom decoding.

type PermissionRequestEvent

PermissionRequestEvent is the Codex PermissionRequest hook input (decoded from stdin JSON). ToolInput stays raw JSON for typed consumers.

type PermissionRequestEvent = internalcodex.PermissionRequestInput

type PreToolUseEvent

PreToolUseEvent is the Codex PreToolUse hook input (decoded from stdin JSON). ToolInput stays raw JSON for typed consumers.

type PreToolUseEvent = internalcodex.PreToolUseInput

type Registrar

Registrar registers public Codex event handlers on a root SDK app.

type Registrar struct {
    // contains filtered or unexported fields
}

func NewRegistrar

func NewRegistrar(backend runtime.RegistrarBackend) *Registrar

NewRegistrar builds a Codex registrar on top of the shared runtime backend.

func (*Registrar) OnNotify

func (r *Registrar) OnNotify(fn func(*NotifyEvent) *Response)

OnNotify registers a handler for the Codex Notify.

func (*Registrar) OnPermissionRequest

func (r *Registrar) OnPermissionRequest(fn func(*PermissionRequestEvent) *Response)

OnPermissionRequest registers a handler for the Codex PermissionRequest.

func (*Registrar) OnPreToolUse

func (r *Registrar) OnPreToolUse(fn func(*PreToolUseEvent) *Response)

OnPreToolUse registers a handler for the Codex PreToolUse.

func (*Registrar) OnStop

func (r *Registrar) OnStop(fn func(*StopEvent) *Response)

OnStop registers a handler for the Codex Stop.

func (*Registrar) OnSubagentStop

func (r *Registrar) OnSubagentStop(fn func(*SubagentStopEvent) *Response)

OnSubagentStop registers a handler for the Codex SubagentStop.

type Response

Response represents a successful acknowledgement of a Codex event (Notify and the observation-style lifecycle hooks Stop, SubagentStop, PreToolUse, and PermissionRequest).

type Response struct{}

func Continue

func Continue() *Response

Continue acknowledges the event and exits successfully with empty output.

type StopEvent

StopEvent is the Codex Stop lifecycle hook input (decoded from stdin JSON). Field names follow the Codex hooks schema; wire uses snake_case via the platform adapter.

type StopEvent = internalcodex.StopInput

type SubagentStopEvent

SubagentStopEvent is the Codex SubagentStop hook input (decoded from stdin JSON). It carries the Stop fields plus subagent identity.

type SubagentStopEvent = internalcodex.SubagentStopInput