codex

Documentation

Overview

Package codex implements the Codex platform adapter.

Index

• type Adapter
  • func New() *Adapter
  • func NewWithRoot(root string) *Adapter
  • func (a *Adapter) CLIBinary() string
  • func (a *Adapter) Clean(_ context.Context) error
  • func (a *Adapter) Detect(_ context.Context) (bool, error)
  • func (a *Adapter) Generate(_ context.Context, cfg *config.HarnessConfig) (*adapter.PlatformFiles, error)
  • func (a *Adapter) InstallHooks(_ context.Context, _ []adapter.HookConfig, _ *adapter.PermissionSet) error
  • func (a *Adapter) Name() string
  • func (a *Adapter) SupportsHooks() bool
  • func (a *Adapter) Update(ctx context.Context, cfg *config.HarnessConfig) (*adapter.PlatformFiles, error)
  • func (a *Adapter) Validate(_ context.Context) ([]adapter.ValidationError, error)
  • func (a *Adapter) Version() string

Types

type Adapter

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

Adapter is the Codex platform adapter.

func New

func New() *Adapter

New creates an adapter rooted at the current directory.

func NewWithRoot

func NewWithRoot(root string) *Adapter

NewWithRoot creates an adapter rooted at the specified path.

func (*Adapter) CLIBinary

func (a *Adapter) CLIBinary() string

func (*Adapter) Clean

func (a *Adapter) Clean(_ context.Context) error

Clean removes files created by this adapter.

func (*Adapter) Detect

func (a *Adapter) Detect(_ context.Context) (bool, error)

Detect checks whether the codex binary is installed in PATH.

func (*Adapter) Generate

func (a *Adapter) Generate(_ context.Context, cfg *config.HarnessConfig) (*adapter.PlatformFiles, error)

Generate creates Codex platform files based on harness config.

func (*Adapter) InstallHooks

func (a *Adapter) InstallHooks(_ context.Context, _ []adapter.HookConfig, _ *adapter.PermissionSet) error

InstallHooks is a no-op — hooks are managed via .codex/hooks.json template.

func (*Adapter) Name

func (a *Adapter) Name() string

func (*Adapter) SupportsHooks

func (a *Adapter) SupportsHooks() bool

SupportsHooks returns true. Codex supports hooks via .codex/hooks.json.

func (*Adapter) Update

func (a *Adapter) Update(ctx context.Context, cfg *config.HarnessConfig) (*adapter.PlatformFiles, error)

Update updates files based on manifest diff.

func (*Adapter) Validate

func (a *Adapter) Validate(_ context.Context) ([]adapter.ValidationError, error)

Validate checks the validity of installed files.

func (*Adapter) Version

func (a *Adapter) Version() string