sdk

package module

Go to main page

Versions in this module

v1

v1.0.2

Sep 26, 2025

Changes in this version

+ const EnvVarPrefix

+ const SharedStorageErrorMarker

+ const SharedStorageGetMarker

+ const SharedStorageListMarker

+ const SharedStorageResultMarker

+ const SharedStorageSetMarker

+ var WithInteractiveFunction = (*PluginBuilder).WithInteractiveFunction

+ func GetParentMonitoringStatus() map[string]interface

+ func GetSharedVar(key string) (string, error)

+ func ListSharedVars() ([]string, error)

+ func LogDebug(component, msg string)

+ func LogDebugf(component, format string, args ...interface{})

+ func LogError(component, msg string)

+ func LogErrorf(component, format string, args ...interface{})

+ func LogInfo(component, msg string)

+ func LogInfof(component, format string, args ...interface{})

+ func LogWarn(component, msg string)

+ func LogWarnf(component, format string, args ...interface{})

+ func LogWithFields(level LogLevel, component string, msg string, fields map[string]interface{})

+ func NewError(format string, args ...interface{}) error

+ func ParseAndValidateArgs(args []string, definitions []ParameterDefinition) (map[string]string, error)

+ func SetHostSharedStorageClient(setVar func(string, string) error, getVar func(string) (string, error), ...)

+ func SetSharedVar(key, value string) error

+ type ActionMappingBuilder struct

+ func (amb *ActionMappingBuilder) AddInteractive(mapping InteractiveMapping) *ActionMappingBuilder

+ func (amb *ActionMappingBuilder) Build() *PluginBuilder

+ type ArgumentBasedActionConfig struct

+ CLITitle string

+ CommandName string

+ Description string

+ DirectFunction InteractiveGoFunction

+ ExampleCommand string

+ ExecuteFunction InteractiveGoFunction

+ Items []SelectionItem

+ MenuID string

+ MenuTitle string

+ Parameters []ParameterDefinition

+ type CLICommandConfig struct

+ Command string

+ Description string

+ Handler func(args []string) error

+ UIAction string

+ UICommand string

+ UITarget string

+ func SmartCLICommand(command, description string, directExecutor func(args []string) error, ...) CLICommandConfig

type CLICommandInfo

+ Hidden bool

+ UIAction string

+ UICommand string

+ UITarget string

+ UITitle string

+ type CLIShortcut struct

+ Command string

+ Description string

+ MenuID string

+ type CheckboxItem struct

+ Description string

+ IsChecked bool

+ Key string

+ Label string

+ Params map[string]interface{}

+ type ConfigPreset struct

+ Config map[string]interface{}

+ Description string

+ Name string

+ type CrossPluginInvocationResult struct

+ Error error

+ Output []string

+ Success bool

+ type CrossPluginInvoker struct

+ func NewCrossPluginInvoker(ctx context.Context, outputChan chan<- string, inputChan <-chan string) *CrossPluginInvoker

+ func (c *CrossPluginInvoker) InvokeFunction(functionName string, params map[string]interface{}) (*CrossPluginInvocationResult, error)

+ func (c *CrossPluginInvoker) InvokeFunctionWithInput(functionName string, params map[string]interface{}, inputResponses []string) (*CrossPluginInvocationResult, error)

+ func (c *CrossPluginInvoker) ListAvailableFunctions() ([]string, error)

+ type DynamicMenuConfig struct

+ EmptyKey string

+ EmptyMessage string

+ EnableExitButton bool

+ ExitKey string

+ ExitLabel string

+ MaxEntries int

+ func CLIDynamicMenuConfig() DynamicMenuConfig

+ func DefaultDynamicMenuConfig() DynamicMenuConfig

type DynamicProvider

+ GenerateEntries func(param string) ([]MenuEntry, error)

+ GetDescription func() string

+ SupportsRefresh func() bool

type DynamicProviderRPC

+ Description string

type DynamicProviderRPCClient

+ func (d *DynamicProviderRPCClient) GenerateEntries(param string) ([]MenuEntry, error)

+ func (d *DynamicProviderRPCClient) GetDescription() string

+ func (d *DynamicProviderRPCClient) SupportsRefresh() bool

+ type FavoriteItem struct

+ Key string

+ Label string

+ Params map[string]interface{}

+ type FavoritesConfig struct

+ Items []FavoriteItem

+ MenuID string

+ PluginName string

+ SummaryKey string

+ Title string

+ type FavoritesHelper struct

+ func NewFavoritesHelper(pluginName string, items map[string]string) *FavoritesHelper

+ func (f *FavoritesHelper) CreateFavoritesSummaryFunction(getPluginConfig func() map[string]interface{}) InteractiveGoFunction

+ func (f *FavoritesHelper) DisplayFavoritesSummary(pluginConfig map[string]interface{}, outputChan chan<- string)

+ func (f *FavoritesHelper) GetCurrentFavorites(pluginConfig map[string]interface{}) []string

+ func (f *FavoritesHelper) GetFavorites(pluginConfig map[string]interface{}) map[string]string

+ func (f *FavoritesHelper) GetNonFavorites(pluginConfig map[string]interface{}) map[string]string

+ type FormField struct

+ Key string

+ Label string

+ Type string

+ type GitHubRelease struct

+ Assets []GitHubReleaseAsset

+ Body string

+ Draft bool

+ HTMLURL string

+ Name string

+ Prerelease bool

+ PublishedAt time.Time

+ TagName string

+ type GitHubReleaseAsset struct

+ BrowserDownloadURL string

+ ContentType string

+ ID int64

+ Label string

+ Name string

+ Size int64

+ URL string

+ type GitHubReleaseHelper struct

+ func NewAuthenticatedGitHubReleaseHelper() (*GitHubReleaseHelper, error)

+ func NewGitHubReleaseHelper() *GitHubReleaseHelper

+ func NewGitHubReleaseHelperWithAuth(token string) *GitHubReleaseHelper

+ func (g *GitHubReleaseHelper) CheckVersions(owner, repo, currentVersion string) *VersionCheckResult

+ func (g *GitHubReleaseHelper) CompareVersions(v1, v2 string) int

+ func (g *GitHubReleaseHelper) DownloadAsset(asset *GitHubReleaseAsset, outputPath string) error

+ func (g *GitHubReleaseHelper) FindAssetByName(release *GitHubRelease, namePattern string) *GitHubReleaseAsset

+ func (g *GitHubReleaseHelper) GetLatestRelease(owner, repo string) (*GitHubRelease, error)

+ func (g *GitHubReleaseHelper) GetLatestVersion(owner, repo string) (string, error)

+ func (g *GitHubReleaseHelper) GetReleases(owner, repo string, limit int) ([]GitHubRelease, error)

+ func (g *GitHubReleaseHelper) GetToken() string

+ func (g *GitHubReleaseHelper) IsUpdateAvailable(owner, repo, currentVersion string) (bool, string, error)

+ type InputRequester interface

+ RequestInput func(prompt string) (string, error)

+ RequestInputWithDefault func(prompt string, defaultValue string) (string, error)

+ RequestPassword func(prompt string) (string, error)

+ func NewInputRequester(ctx context.Context, outputChan chan<- string, inputChan <-chan string) InputRequester

+ func NewInputRequesterWithSession(ctx context.Context, outputChan chan<- string, inputChan <-chan string, ...) InputRequester

type InteractiveGoFunction

+ func CreateSmartSelector(config SmartSelectorConfig) InteractiveGoFunction

+ type InteractiveMapping struct

+ CLIDescription string

+ CLIName string

+ Function InteractiveGoFunction

+ Hidden bool

+ MenuTarget string

+ Params map[string]interface{}

+ UICommand string

+ func CLIHiddenStreamingAction(name, description, functionName string, function InteractiveGoFunction) InteractiveMapping

+ func SelectionAction(name, description, menuTarget string, directFunction InteractiveGoFunction) InteractiveMapping

+ func ShellAction(name, description, command string) InteractiveMapping

+ func StreamingAction(name, description, functionName string, function InteractiveGoFunction) InteractiveMapping

+ type InteractiveSharedStorage struct

+ func NewInteractiveSharedStorage(ctx context.Context, outputChan chan<- string, inputChan <-chan string) *InteractiveSharedStorage

+ func (s *InteractiveSharedStorage) GetEnvVar(key string) (string, error)

+ func (s *InteractiveSharedStorage) GetVar(key string) (string, error)

+ func (s *InteractiveSharedStorage) ListEnvVars() ([]string, error)

+ func (s *InteractiveSharedStorage) ListVars() ([]string, error)

+ func (s *InteractiveSharedStorage) SetEnvVar(key, value string) error

+ func (s *InteractiveSharedStorage) SetVar(key, value string) error

+ type InteractiveStreamCleanupArgs struct

+ SessionID string

+ type InteractiveStreamCleanupResponse struct

+ Error error

+ Success bool

+ type InteractiveStreamInitArgs struct

+ FunctionName string

+ Params map[string]interface{}

+ type InteractiveStreamInitResponse struct

+ Error error

+ SessionID string

+ type InteractiveStreamInputArgs struct

+ Input string

+ SessionID string

+ type InteractiveStreamInputResponse struct

+ Error error

+ Success bool

+ type InteractiveStreamOutputArgs struct

+ SessionID string

+ type InteractiveStreamOutputResponse struct

+ Completed bool

+ Error error

+ InputPrompt string

+ NeedsInput bool

+ NewOutput []string

+ type InteractiveStreamSession struct

+ Cancel context.CancelFunc

+ Completed bool

+ Context context.Context

+ ErrorChan chan error

+ FinalError error

+ FunctionName string

+ InputChan chan string

+ InputPrompt string

+ LastSentIndex int

+ OutputBuffer []string

+ OutputChan chan string

+ Params map[string]interface{}

+ WaitingForInput bool

+ type LogLevel string

+ const DebugLevel

+ const ErrorLevel

+ const InfoLevel

+ const WarnLevel

+ type Logger struct

+ func GetPluginLogger() *Logger

+ func InitPluginLogger(pluginName string) (*Logger, error)

+ func (l *Logger) Close() error

+ func (l *Logger) Debug(msg string)

+ func (l *Logger) Debugf(format string, args ...interface{})

+ func (l *Logger) Error(msg string)

+ func (l *Logger) Errorf(format string, args ...interface{})

+ func (l *Logger) Info(msg string)

+ func (l *Logger) Infof(format string, args ...interface{})

+ func (l *Logger) Warn(msg string)

+ func (l *Logger) Warnf(format string, args ...interface{})

+ func (l *Logger) WithComponent(component string) *logrus.Entry

+ func (l *Logger) WithError(err error) *logrus.Entry

+ func (l *Logger) WithFields(fields map[string]interface{}) *logrus.Entry

type Menu

+ ExecuteAction *MenuAction

+ ExecuteKey string

+ IsCheckboxMenu bool

type MenuEntry

+ CheckboxGroup string

+ ID string

+ IsCheckbox bool

+ IsChecked bool

+ func GenerateAutoNumberedEntries(entries []MenuEntryConfig, config DynamicMenuConfig) []MenuEntry

+ type MenuEntryConfig struct

+ Action string

+ Command string

+ Key string

+ Label string

+ Message string

+ Params map[string]interface{}

+ Target string

+ type ParameterDefinition struct

+ Choices []string

+ Default string

+ Description string

+ ExampleValue string

+ MaxValue *int

+ MinValue *int

+ Name string

+ Pattern string

+ Required bool

+ Type ParameterType

+ func BoolParameter(name, description string, defaultValue bool) ParameterDefinition

+ func BoolParameterWithExample(name, description string, defaultValue bool, exampleValue string) ParameterDefinition

+ func ChoiceParam(name, description string, choices []string, required bool) ParameterDefinition

+ func OptionalIntParam(name, description string, defaultValue int) ParameterDefinition

+ func OptionalIntParamWithExample(name, description string, defaultValue int, exampleValue string) ParameterDefinition

+ func OptionalStringParam(name, description, defaultValue string) ParameterDefinition

+ func OptionalStringParamWithExample(name, description, defaultValue, exampleValue string) ParameterDefinition

+ func PortParameter(name, description string, required bool) ParameterDefinition

+ func RequiredIntParam(name, description string) ParameterDefinition

+ func RequiredIntParamWithExample(name, description, exampleValue string) ParameterDefinition

+ func RequiredStringParam(name, description string) ParameterDefinition

+ func RequiredStringParamWithExample(name, description, exampleValue string) ParameterDefinition

+ func (p *ParameterDefinition) ValidateValue(value string) error

+ type ParameterType string

+ const BoolParam

+ const IntParam

+ const PortParam

+ const StringParam

+ const UrlParam

type PlatformInfo

+ ArchiveExt string

+ BinaryExt string

+ InPath bool

+ InstallDir string

+ Platform string

type Plugin

+ GetStreamingCLICommands func() (map[string]StreamingCLICommandHandler, error)

+ ReloadConfig func(config map[string]any) error

type PluginBase

+ func (p *PluginBase) AddStreamingCLICommand(name string, handler StreamingCLICommandHandler)

+ func (p *PluginBase) GetStreamingCLICommands() (map[string]StreamingCLICommandHandler, error)

+ func (p *PluginBase) ReloadConfig(config map[string]any) error

+ func (p *PluginBase) WithStreamingCLICommand(name string, handler StreamingCLICommandHandler) *PluginBase

type PluginBuilder

+ func MustNewPluginBuilderFromEmbeddedYAML(embeddedData []byte) *PluginBuilder

+ func NewPluginBuilderFromEmbeddedYAML(embeddedData []byte) (*PluginBuilder, error)

+ func NewPluginBuilderFromMetadata(metadata *PluginMetadata) *PluginBuilder

+ func (b *PluginBuilder) GetFullMenuID(menuID string) string

+ func (b *PluginBuilder) SetDisplayName(displayName string) *PluginBuilder

+ func (b *PluginBuilder) WithActionMappings() *ActionMappingBuilder

+ func (b *PluginBuilder) WithArgumentBasedAction(config ArgumentBasedActionConfig) *PluginBuilder

+ func (b *PluginBuilder) WithAutoConfigPresets() *PluginBuilder

+ func (b *PluginBuilder) WithAutoStartMenu(menuID string) *PluginBuilder

+ func (b *PluginBuilder) WithBasicMenuProvider(entries []MenuEntry) *PluginBuilder

+ func (b *PluginBuilder) WithCLICommandAndUIMapping(name, description string, handler CLICommandHandler, ...) *PluginBuilder

+ func (b *PluginBuilder) WithCLICommandOptions(name, description string, handler CLICommandHandler, hidden bool) *PluginBuilder

+ func (b *PluginBuilder) WithCheckboxMenu(menuID, title string, items []CheckboxItem, ...) *PluginBuilder

+ func (b *PluginBuilder) WithCheckboxMenuSimple(menuID, title string, itemLabels []string, ...) *PluginBuilder

+ func (b *PluginBuilder) WithCommandShortcuts(shortcuts map[string]string) *PluginBuilder

+ func (b *PluginBuilder) WithConfigPreset(name, displayName, description string, config map[string]interface{}) *PluginBuilder

+ func (b *PluginBuilder) WithConfigProvider(componentName, param, description string, ...) *PluginBuilder

+ func (b *PluginBuilder) WithDataProvider(componentName, param, description string, ...) *PluginBuilder

+ func (b *PluginBuilder) WithFavoritesMenu(config FavoritesConfig) *PluginBuilder

+ func (b *PluginBuilder) WithFormMenu(menuID, title string, fields []FormField, submitAction string) *PluginBuilder

+ func (b *PluginBuilder) WithHiddenCLICommand(name, description string, handler CLICommandHandler) *PluginBuilder

+ func (b *PluginBuilder) WithMainMenuProvider(description string, providerFunc func(string) ([]MenuEntry, error)) *PluginBuilder

+ func (b *PluginBuilder) WithMenuIntegration(autoRegister bool, key, label, icon string, priority int) *PluginBuilder

+ func (b *PluginBuilder) WithMenuIntegrationAdvanced(integration PluginMenuIntegration) *PluginBuilder

+ func (b *PluginBuilder) WithMenuProvider(componentName, param, description string, ...) *PluginBuilder

+ func (b *PluginBuilder) WithMenuStartupShortcut(command, menuID, description string) *PluginBuilder

+ func (b *PluginBuilder) WithPluginFromYAML() *PluginBuilder

+ func (b *PluginBuilder) WithQuickMenu(menuID, title string, entries []MenuEntry) *PluginBuilder

+ func (b *PluginBuilder) WithQuickSetup(menuEntries []MenuEntry) *PluginBuilder

+ func (b *PluginBuilder) WithSelectionMenuProvider(menuID, title string, items []SelectionItem, ...) *PluginBuilder

+ func (b *PluginBuilder) WithShellCommand(key, label, description, command string) *PluginBuilder

+ func (b *PluginBuilder) WithShellCommands(commands map[string]ShellCommandEntry) *PluginBuilder

+ func (b *PluginBuilder) WithSimplePlugin(config SimplePluginConfig) *PluginBuilder

+ func (b *PluginBuilder) WithSmartCLICommand(config SmartCLICommandConfig) *PluginBuilder

+ func (b *PluginBuilder) WithStandardInteractiveFunction(functionName string, function InteractiveGoFunction) *PluginBuilder

+ func (b *PluginBuilder) WithStandardProvider(componentName, providerType, param, description string, ...) *PluginBuilder

+ func (b *PluginBuilder) WithStreamingCLICommand(name, description string, handler StreamingCLICommandHandler) *PluginBuilder

+ func (b *PluginBuilder) WithTags(tags []string) *PluginBuilder

+ func (b *PluginBuilder) WithUnifiedProvider(description string) *UnifiedProviderBuilder

type PluginInfo

+ ConfigPresets map[string]ConfigPreset

+ DisplayName string

+ MenuIntegration *PluginMenuIntegration

type PluginInfoRPC

+ ConfigPresetsJSON string

+ DisplayName string

+ MenuIntegration *PluginMenuIntegration

+ type PluginMenuIntegration struct

+ AutoRegister bool

+ Group string

+ Icon string

+ Key string

+ Label string

+ MenuID string

+ Priority int

type PluginMetadata

+ Category string

+ ConfigPresets map[string]ConfigPreset

+ DisplayName string

+ MenuIntegration *PluginMenuIntegration

+ MinimumMopsVersion string

+ func LoadPluginMetadataFromBytes(data []byte) (*PluginMetadata, error)

type PluginRPCClient

+ func (g *PluginRPCClient) GetStreamingCLICommands() (map[string]StreamingCLICommandHandler, error)

+ func (g *PluginRPCClient) ReloadConfig(config map[string]any) error

type PluginRPCServer

+ func (s *PluginRPCServer) CleanupInteractiveStream(args *InteractiveStreamCleanupArgs, resp *InteractiveStreamCleanupResponse) error

+ func (s *PluginRPCServer) ExecuteStreamingCLICommand(args *CLICommandExecuteArgs, resp *CLICommandExecuteResponse) error

+ func (s *PluginRPCServer) GetInteractiveStreamOutput(args *InteractiveStreamOutputArgs, resp *InteractiveStreamOutputResponse) error

+ func (s *PluginRPCServer) GetStreamingCLICommands(args interface{}, resp *map[string]CLICommandInfo) error

+ func (s *PluginRPCServer) InitInteractiveStream(args *InteractiveStreamInitArgs, resp *InteractiveStreamInitResponse) error

+ func (s *PluginRPCServer) ReloadConfig(configJSON string, resp *error) error

+ func (s *PluginRPCServer) SendInteractiveStreamInput(args *InteractiveStreamInputArgs, resp *InteractiveStreamInputResponse) error

+ type SelectionItem struct

+ Description string

+ Icon string

+ Name string

+ Params map[string]interface{}

+ Title string

+ type ShellCommandEntry struct

+ Command string

+ Description string

+ Label string

+ type SimplePluginConfig struct

+ Author string

+ AutoLoadPresets bool

+ CLIShortcuts []CLIShortcut

+ DisplayName string

+ InteractiveFunctions map[string]InteractiveGoFunction

+ MenuEntries []MenuEntry

type SimpleProvider

+ func (p *SimpleProvider) GenerateEntries(param string) ([]MenuEntry, error)

+ func (p *SimpleProvider) GetDescription() string

+ func (p *SimpleProvider) SupportsRefresh() bool

+ type SmartCLICommandConfig struct

+ Command string

+ Description string

+ DirectExecutor func(ctx context.Context, outputChan chan<- string, inputChan <-chan string, ...) error

+ DirectHandler func(args []string) error

+ InteractiveSelector func(ctx context.Context, outputChan chan<- string, inputChan <-chan string, ...) error

+ SmartFunctionName string

+ UITarget string

+ UITitle string

+ Usage string

+ type SmartSelectorConfig struct

+ CommandName string

+ DirectExecutor func(ctx context.Context, outputChan chan<- string, inputChan <-chan string, ...) error

+ InteractiveSelector func(ctx context.Context, outputChan chan<- string, inputChan <-chan string, ...) error

+ Usage string

+ type StandardProvider struct

+ func NewStandardProvider(name, providerType, param, description string, ...) *StandardProvider

+ func (p *StandardProvider) GenerateEntries(param string) ([]MenuEntry, error)

+ func (p *StandardProvider) GetDescription() string

+ func (p *StandardProvider) GetName() string

+ func (p *StandardProvider) GetParam() string

+ func (p *StandardProvider) GetType() string

+ func (p *StandardProvider) SupportsRefresh() bool

+ type StreamingCLICommandHandler interface

+ Execute func(ctx context.Context, args []string) error

+ ExecuteStreaming func(ctx context.Context, args []string, outputChan chan<- string) error

+ GetHelp func() string

+ SupportsStreaming func() bool

+ type StreamingCommandWrapper struct

+ func (w *StreamingCommandWrapper) Execute(ctx context.Context, args []string) error

+ func (w *StreamingCommandWrapper) ExecuteStreaming(ctx context.Context, args []string, outputChan chan<- string) error

+ func (w *StreamingCommandWrapper) GetHelp() string

+ func (w *StreamingCommandWrapper) SupportsStreaming() bool

+ type SudoChecker struct

+ func NewSudoChecker() *SudoChecker

+ func (sc *SudoChecker) CheckSudoAvailability() (*SudoInfo, error)

+ func (sc *SudoChecker) CheckSudoPrivileges() (*SudoInfo, error)

+ func (sc *SudoChecker) GetSafeSudoStatus() string

+ func (sc *SudoChecker) GetSudoStatus() string

+ func (sc *SudoChecker) HasSudo() bool

+ func (sc *SudoChecker) PromptForSudo() error

+ func (sc *SudoChecker) RequireSudo() error

+ func (sc *SudoChecker) TestSudoExecution(command string, args ...string) error

+ type SudoInfo struct

+ CanSudoWithoutPwd bool

+ CurrentUser string

+ ErrorMessage string

+ HasSudo bool

+ IsRoot bool

+ SudoPath string

+ SudoTimeLeft int

+ type ToolChecker struct

+ func NewToolChecker() *ToolChecker

+ func (tc *ToolChecker) CheckMultipleTools(toolNames []string) map[string]*ToolInfo

+ func (tc *ToolChecker) FindTool(toolName string) (*ToolInfo, error)

+ func (tc *ToolChecker) IsInstalled(toolName string) bool

+ func (tc *ToolChecker) RequireTool(toolName string) error

+ func (tc *ToolChecker) RequireTools(toolNames []string) error

+ type ToolInfo struct

+ Installed bool

+ Name string

+ Path string

+ Version string

+ type ToolInstallCommand struct

+ Args []string

+ Command string

+ Env map[string]string

+ PrimeSudoCache bool

+ RequiresSudo bool

+ Shell string

+ WorkDir string

+ type ToolInstallConfig struct

+ ForceUpdate bool

+ InstallCommands map[string]ToolInstallCommand

+ ToolName string

+ VerifyCommand *ToolInstallCommand

+ Version string

+ VersionCommands map[string]ToolVersionCommand

+ type ToolInstallResult struct

+ AlreadyInstalled bool

+ Error error

+ Platform string

+ Success bool

+ Version string

+ VersionRetrievable bool

+ type ToolInstaller struct

+ func NewToolInstaller(ctx context.Context, outputChan chan<- string, inputChan <-chan string) *ToolInstaller

+ func (ti *ToolInstaller) CheckToolStatus(config *ToolInstallConfig) (*ToolInstallResult, error)

+ func (ti *ToolInstaller) GetCurrentPlatform() string

+ func (ti *ToolInstaller) GetSupportedPlatforms() []string

+ func (ti *ToolInstaller) InstallTool(config *ToolInstallConfig) (*ToolInstallResult, error)

+ type ToolInstallerInterface interface

+ CheckToolStatus func(config *ToolInstallConfig) (*ToolInstallResult, error)

+ GetCurrentPlatform func() string

+ GetSupportedPlatforms func() []string

+ InstallTool func(config *ToolInstallConfig) (*ToolInstallResult, error)

+ type ToolVersionCommand struct

+ CheckCommand *ToolInstallCommand

+ VersionCommand *ToolInstallCommand

+ VersionParser func(string) string

+ VersionRetrievable bool

+ type UnifiedProvider struct

+ func NewUnifiedProvider(name, description string) *UnifiedProvider

+ func (p *UnifiedProvider) GenerateEntries(param string) ([]MenuEntry, error)

+ func (p *UnifiedProvider) GetDescription() string

+ func (p *UnifiedProvider) GetName() string

+ func (p *UnifiedProvider) HasMainMenu() bool

+ func (p *UnifiedProvider) SupportsRefresh() bool

+ func (p *UnifiedProvider) WithConfigHandler(title string, handler func(param string) ([]MenuEntry, error)) *UnifiedProvider

+ func (p *UnifiedProvider) WithDataHandler(title string, handler func(param string) ([]MenuEntry, error)) *UnifiedProvider

+ func (p *UnifiedProvider) WithMenuHandler(title string, handler func(param string) ([]MenuEntry, error)) *UnifiedProvider

+ type UnifiedProviderBuilder struct

+ func (upb *UnifiedProviderBuilder) Done() *PluginBuilder

+ func (upb *UnifiedProviderBuilder) WithConfig(title string, handler func(param string) ([]MenuEntry, error)) *UnifiedProviderBuilder

+ func (upb *UnifiedProviderBuilder) WithData(title string, handler func(param string) ([]MenuEntry, error)) *UnifiedProviderBuilder

+ func (upb *UnifiedProviderBuilder) WithMainMenu(handler func(param string) ([]MenuEntry, error)) *UnifiedProviderBuilder

+ func (upb *UnifiedProviderBuilder) WithMenu(title string, handler func(param string) ([]MenuEntry, error)) *UnifiedProviderBuilder

+ type ValidationError struct

+ Message string

+ Parameter string

+ func (e ValidationError) Error() string

+ type VersionCheckResult struct

+ Comparison int

+ CurrentVersion string

+ Error error

+ LatestVersion string

+ UpdateAvailable bool

v1.0.1

Aug 20, 2025

Changes in this version

+ const PluginName

+ const ProtocolVersion

+ var PluginMap = map[string]plugin.Plugin

+ func Main(pluginImpl Plugin)

+ type ActionExecutor interface

+ Execute func(entry MenuEntry, input string) ActionResult

+ GetActionType func() string

+ type ActionExecutorRPC struct

+ ActionType string

+ type ActionExecutorRPCClient struct

+ func (a *ActionExecutorRPCClient) Execute(entry MenuEntry, input string) ActionResult

+ func (a *ActionExecutorRPCClient) GetActionType() string

+ type ActionResult struct

+ Error error

+ IsStreaming bool

+ Output string

+ RefreshMenu bool

+ ShowOutput bool

+ Success bool

+ Title string

+ type AppState int

+ const DoneScreen

+ const MainMenu

+ type BuildTarget struct

+ Arch string

+ OS string

+ Output string

+ type CLICommandExecuteArgs struct

+ Args []string

+ Name string

+ type CLICommandExecuteResponse struct

+ Error error

+ Output string

+ type CLICommandHandler func(args []string) error

+ type CLICommandInfo struct

+ Description string

+ Examples []string

+ Name string

+ Usage string

+ type DynamicProvider interface

+ GetEntries func(param string) ([]MenuEntry, error)

+ GetName func() string

+ type DynamicProviderRPC struct

+ Name string

+ type DynamicProviderRPCClient struct

+ func (d *DynamicProviderRPCClient) GetEntries(param string) ([]MenuEntry, error)

+ func (d *DynamicProviderRPCClient) GetName() string

+ type ExecutorExecuteArgs struct

+ ActionType string

+ Entry MenuEntry

+ Input string

+ type InteractiveFunctionCallArgs struct

+ Name string

+ Params map[string]interface{}

+ type InteractiveFunctionCallResponse struct

+ Error error

+ Output []string

+ type InteractiveGoFunction func(ctx context.Context, outputChan chan<- string, inputChan <-chan string, ...) error

+ type Menu struct

+ CancelKey string

+ CancelNextID string

+ ConfirmAction *MenuAction

+ Entries []MenuEntry

+ ID string

+ Input bool

+ Map map[string]Menu

+ Provider string

+ ProviderParam string

+ Title string

+ type MenuAction struct

+ Action string

+ Command string

+ NextID string

+ Params map[string]interface{}

+ Target string

+ type MenuConfig struct

+ Menus []Menu

+ type MenuEntry struct

+ Action string

+ Command string

+ FilePath string

+ IsDynamic bool

+ IsInteractive bool

+ Key string

+ KeyBind string

+ Label string

+ Message string

+ NextID string

+ Params map[string]interface{}

+ Target string

+ type MopsPlugin struct

+ Impl Plugin

+ func (p *MopsPlugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error)

+ func (p *MopsPlugin) Server(*plugin.MuxBroker) (interface{}, error)

+ type MopsVersionConstraint struct

+ MaxVersion string

+ MinVersion string

+ type NavMsg struct

+ Data any

+ IsBack bool

+ Next AppState

+ NextID string

+ Params map[string]interface{}

+ TitleOverride string

+ type PlatformInfo struct

+ Arch string

+ OS string

+ func GetCurrentPlatform() PlatformInfo

+ type Plugin interface

+ Cleanup func() error

+ GetCLICommands func() (map[string]CLICommandHandler, error)

+ GetInfo func() PluginInfo

+ GetMenuEntries func() (map[string][]MenuEntry, error)

+ Initialize func(config map[string]any) error

+ RegisterExecutors func() []ActionExecutor

+ RegisterInteractiveFunctions func() map[string]InteractiveGoFunction

+ RegisterProviders func() []DynamicProvider

+ ValidateConfig func(config map[string]any) error

+ type PluginBase struct

+ func NewPluginBase(info PluginInfo) *PluginBase

+ func (p *PluginBase) AddCLICommand(name string, handler CLICommandHandler)

+ func (p *PluginBase) AddExecutor(executor ActionExecutor)

+ func (p *PluginBase) AddInteractiveFunction(name string, fn InteractiveGoFunction)

+ func (p *PluginBase) AddMenuEntry(menuID string, entry MenuEntry)

+ func (p *PluginBase) AddProvider(provider DynamicProvider)

+ func (p *PluginBase) Cleanup() error

+ func (p *PluginBase) GetCLICommands() (map[string]CLICommandHandler, error)

+ func (p *PluginBase) GetInfo() PluginInfo

+ func (p *PluginBase) GetMenuEntries() (map[string][]MenuEntry, error)

+ func (p *PluginBase) Initialize(config map[string]any) error

+ func (p *PluginBase) RegisterExecutors() []ActionExecutor

+ func (p *PluginBase) RegisterInteractiveFunctions() map[string]InteractiveGoFunction

+ func (p *PluginBase) RegisterProviders() []DynamicProvider

+ func (p *PluginBase) ValidateConfig(config map[string]any) error

+ func (p *PluginBase) WithCLICommand(name string, handler CLICommandHandler) *PluginBase

+ func (p *PluginBase) WithInteractiveFunction(name string, fn InteractiveGoFunction) *PluginBase

+ func (p *PluginBase) WithMenuEntry(menuID string, entry MenuEntry) *PluginBase

+ func (p *PluginBase) WithSimpleExecutor(actionType string, fn func(entry MenuEntry, input string) ActionResult) *PluginBase

+ func (p *PluginBase) WithSimpleProvider(name string, fn func(param string) ([]MenuEntry, error)) *PluginBase

+ type PluginBuilder struct

+ func NewPluginBuilder(name, version, description string) *PluginBuilder

+ func (b *PluginBuilder) AddDependency(dependency string) *PluginBuilder

+ func (b *PluginBuilder) AddTag(tag string) *PluginBuilder

+ func (b *PluginBuilder) Build() Plugin

+ func (b *PluginBuilder) SetAuthor(author string) *PluginBuilder

+ func (b *PluginBuilder) SetDefaultConfig(config map[string]any) *PluginBuilder

+ func (b *PluginBuilder) SetHomepage(homepage string) *PluginBuilder

+ func (b *PluginBuilder) SetLicense(license string) *PluginBuilder

+ func (b *PluginBuilder) SetMopsVersions(minVersion, maxVersion string) *PluginBuilder

+ func (b *PluginBuilder) WithCLICommand(name, description string, handler CLICommandHandler) *PluginBuilder

+ func (b *PluginBuilder) WithInteractiveFunction(name string, fn InteractiveGoFunction) *PluginBuilder

+ func (b *PluginBuilder) WithMenuEntry(menuID string, entry MenuEntry) *PluginBuilder

+ func (b *PluginBuilder) WithSimpleExecutor(actionType string, fn func(entry MenuEntry, input string) ActionResult) *PluginBuilder

+ func (b *PluginBuilder) WithSimpleProvider(name, description string, fn func(param string) ([]MenuEntry, error)) *PluginBuilder

+ type PluginInfo struct

+ Author string

+ CLICommands []CLICommandInfo

+ DefaultConfig map[string]any

+ Dependencies []string

+ Description string

+ Homepage string

+ License string

+ MopsMaxVersion string

+ MopsMinVersion string

+ Name string

+ Platform PlatformInfo

+ SupportedPlatforms []PlatformInfo

+ Tags []string

+ Version string

+ type PluginInfoRPC struct

+ Author string

+ CLICommands []CLICommandInfo

+ DefaultConfigJSON string

+ Dependencies []string

+ Description string

+ Homepage string

+ License string

+ MopsMaxVersion string

+ MopsMinVersion string

+ Name string

+ Platform PlatformInfo

+ SupportedPlatforms []PlatformInfo

+ Tags []string

+ Version string

+ func NewPluginInfoRPC(info PluginInfo) (PluginInfoRPC, error)

+ func (rpc *PluginInfoRPC) ToPluginInfo() (PluginInfo, error)

+ type PluginMetadata struct

+ Author string

+ BuildTargets []BuildTarget

+ CLICommands []CLICommandInfo

+ DefaultConfig map[string]any

+ Description string

+ Homepage string

+ License string

+ MopsVersion MopsVersionConstraint

+ Name string

+ Repository string

+ Tags []string

+ Version string

+ type PluginRPCClient struct

+ func (g *PluginRPCClient) Cleanup() error

+ func (g *PluginRPCClient) GetCLICommands() (map[string]CLICommandHandler, error)

+ func (g *PluginRPCClient) GetInfo() PluginInfo

+ func (g *PluginRPCClient) GetMenuEntries() (map[string][]MenuEntry, error)

+ func (g *PluginRPCClient) Initialize(config map[string]any) error

+ func (g *PluginRPCClient) RegisterExecutors() []ActionExecutor

+ func (g *PluginRPCClient) RegisterInteractiveFunctions() map[string]InteractiveGoFunction

+ func (g *PluginRPCClient) RegisterProviders() []DynamicProvider

+ func (g *PluginRPCClient) ValidateConfig(config map[string]any) error

+ type PluginRPCServer struct

+ Impl Plugin

+ func (s *PluginRPCServer) CallInteractiveFunction(args *InteractiveFunctionCallArgs, resp *InteractiveFunctionCallResponse) error

+ func (s *PluginRPCServer) Cleanup(args interface{}, resp *error) error

+ func (s *PluginRPCServer) ExecuteAction(args *ExecutorExecuteArgs, resp *ActionResult) error

+ func (s *PluginRPCServer) ExecuteCLICommand(args *CLICommandExecuteArgs, resp *CLICommandExecuteResponse) error

+ func (s *PluginRPCServer) GenerateProviderEntries(args *ProviderGenerateEntriesArgs, resp *[]MenuEntry) error

+ func (s *PluginRPCServer) GetCLICommands(args interface{}, resp *map[string]CLICommandInfo) error

+ func (s *PluginRPCServer) GetInfo(args interface{}, resp *PluginInfoRPC) error

+ func (s *PluginRPCServer) GetMenuEntries(args interface{}, resp *map[string][]MenuEntry) error

+ func (s *PluginRPCServer) Initialize(configJSON string, resp *error) error

+ func (s *PluginRPCServer) RegisterExecutors(args interface{}, resp *[]ActionExecutorRPC) error

+ func (s *PluginRPCServer) RegisterInteractiveFunctions(args interface{}, resp *map[string]string) error

+ func (s *PluginRPCServer) RegisterProviders(args interface{}, resp *[]DynamicProviderRPC) error

+ func (s *PluginRPCServer) ValidateConfig(args map[string]any, resp *error) error

+ type ProviderGenerateEntriesArgs struct

+ Name string

+ Param string

+ type Registry interface

+ GetExecutor func(actionType string) (ActionExecutor, bool)

+ GetProvider func(name string) (DynamicProvider, bool)

+ ListExecutors func() []string

+ ListProviders func() []string

+ RegisterExecutor func(executor ActionExecutor)

+ RegisterProvider func(provider DynamicProvider)

+ type RepositoryPlugin struct

+ Author string

+ Checksums map[string]string

+ Description string

+ Homepage string

+ LastUpdated time.Time

+ License string

+ MopsVersion MopsVersionConstraint

+ Name string

+ Platforms map[string]RepositoryPluginAsset

+ Repository string

+ Tags []string

+ Version string

+ type RepositoryPluginAsset struct

+ Checksum string

+ DownloadURL string

+ Filename string

+ Platform PlatformInfo

+ Size int64

+ type RepositoryRegistry struct

+ Plugins map[string]RepositoryPlugin

+ Repository struct{ ... }

+ type SimpleExecutor struct

+ func NewSimpleExecutor(actionType string, fn func(entry MenuEntry, input string) ActionResult) *SimpleExecutor

+ func (e *SimpleExecutor) Execute(entry MenuEntry, input string) ActionResult

+ func (e *SimpleExecutor) GetActionType() string

+ type SimpleProvider struct

+ func NewSimpleProvider(name string, fn func(param string) ([]MenuEntry, error)) *SimpleProvider

+ func (p *SimpleProvider) GetEntries(param string) ([]MenuEntry, error)

+ func (p *SimpleProvider) GetName() string

v1.0.0

Aug 13, 2025

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