codexplugin

package
v0.0.10 Latest Latest
Warning

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

Go to latest
Published: Jul 2, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Export

func Export(dir string, tunnelClientBinary string) error

func NormalizeBinaryPath

func NormalizeBinaryPath(path string) (string, error)

func PluginTargetDir

func PluginTargetDir(codexHome string) string

func PluginTargetDirFor

func PluginTargetDirFor(codexHome string, marketplace string, pluginName string, version string) string

func ReadInstalledBinaryHint

func ReadInstalledBinaryHint(codexHome string) string

func ResolveCodexHome

func ResolveCodexHome(lookupEnv func(string) (string, bool)) string

Types

type AdminProfileResult

type AdminProfileResult struct {
	Name                string `json:"name"`
	ControlPlaneBaseURL string `json:"control_plane_base_url"`
	ControlPlaneURLPath string `json:"control_plane_url_path,omitempty"`
	AdminKey            string `json:"admin_key"`
	UpdatedAt           string `json:"updated_at,omitempty"`
	Path                string `json:"path"`
	Active              bool   `json:"active"`
}

type AliasOptions

type AliasOptions struct {
	Alias               string
	AdminProfileName    string
	AdminKeyRef         string
	ControlPlaneBaseURL string
	ControlPlaneURLPath string
}

type CleanupOptions

type CleanupOptions struct {
	Apply bool
}

type ConnectOptions

type ConnectOptions struct {
	CreateOptions
	TunnelID      string
	ProfileName   string
	ProfileDir    string
	MCPServerURL  string
	MCPCommand    string
	RuntimeAPIKey string
	TunnelBin     string
}

type CreateOptions

type CreateOptions struct {
	Alias               string
	Name                string
	Description         string
	AdminProfileName    string
	AdminKeyRef         string
	ControlPlaneBaseURL string
	ControlPlaneURLPath string
	OrganizationIDs     []string
	WorkspaceIDs        []string
}

type Detection

type Detection struct {
	CodexHome             string
	ConfigPath            string
	PluginDir             string
	PluginKey             string
	PluginMarketplace     string
	PluginVersion         string
	Detected              bool
	PluginName            string
	PluginInstalled       bool
	PluginBinaryHint      string
	PluginBinaryHintPath  string
	PluginBinaryHintFound bool
	EnabledConfigKeys     []string
	Installations         []PluginInstallation
	StaleConfigEntries    []StalePluginConfigEntry
	InstallHint           string
}

func Detect

func Detect(lookupEnv func(string) (string, bool)) Detection

func Install

func Install(codexHome string, tunnelClientBinary string) (Detection, error)

func InstallForMarketplace

func InstallForMarketplace(codexHome string, marketplace string, tunnelClientBinary string) (Detection, error)

type ListOptions

type ListOptions struct {
	AdminProfileName    string
	AdminKeyRef         string
	ControlPlaneBaseURL string
	ControlPlaneURLPath string
	OrganizationIDs     []string
	WorkspaceIDs        []string
	TenantID            string
}

type Manager

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

func NewManager

func NewManager(lookupEnv func(string) (string, bool), runtime session.Runtime) *Manager

func (*Manager) ActivateAdminProfile

func (m *Manager) ActivateAdminProfile(name string) (map[string]any, error)

func (*Manager) CleanupInventory

func (m *Manager) CleanupInventory(opts CleanupOptions) (map[string]any, error)

func (*Manager) Connect

func (m *Manager) Connect(opts ConnectOptions) (map[string]any, error)

func (*Manager) Create

func (m *Manager) Create(opts CreateOptions) (map[string]any, error)

func (*Manager) DeleteAdminProfile

func (m *Manager) DeleteAdminProfile(name string) (map[string]any, error)

func (*Manager) ListAdminProfiles

func (m *Manager) ListAdminProfiles() (map[string]any, error)

func (*Manager) ListRuntimes

func (m *Manager) ListRuntimes(opts ListOptions) (map[string]any, error)

func (*Manager) Remove

func (m *Manager) Remove(opts AliasOptions) (map[string]any, error)

func (*Manager) SetAdminProfile

func (m *Manager) SetAdminProfile(name, baseURL, urlPath, adminKey string, activate bool) (map[string]any, error)

func (*Manager) Status

func (m *Manager) Status(opts AliasOptions) (map[string]any, error)

func (*Manager) Stop

func (m *Manager) Stop(opts AliasOptions) (map[string]any, error)

type PayloadError

type PayloadError struct {
	Code    int
	Payload map[string]any
}

func (*PayloadError) Error

func (e *PayloadError) Error() string

type PluginInstallation

type PluginInstallation struct {
	Key            string `json:"key"`
	Marketplace    string `json:"marketplace"`
	Version        string `json:"version"`
	Dir            string `json:"dir"`
	ManifestPath   string `json:"manifest_path"`
	Installed      bool   `json:"installed"`
	BinaryHintPath string `json:"binary_hint_path,omitempty"`
	BinaryHint     string `json:"binary_hint,omitempty"`
}

type RepairAction

type RepairAction struct {
	ID      string `json:"id"`
	Command string `json:"command"`
	Reason  string `json:"reason"`
}

type StalePluginConfigEntry

type StalePluginConfigEntry struct {
	Key         string `json:"key"`
	Marketplace string `json:"marketplace"`
	Reason      string `json:"reason"`
}

type UninstallResult

type UninstallResult struct {
	CodexHome            string
	ConfigPath           string
	PluginDir            string
	PluginName           string
	RemovedPluginDir     bool
	RemovedConfigSection bool
}

func Uninstall

func Uninstall(codexHome string) (UninstallResult, error)

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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