plugins

package

v1.4.201 Latest Latest Go to latest Published: Jun 12, 2025 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/danielmiessler/fabric

Links

Documentation ¶

Index ¶

Constants
func BuildEnvVariable(name string) string
func BuildEnvVariablePrefix(name string) (ret string)
func ParseBool(val string) (bool, error)
func ParseBoolElseFalse(val string) (ret bool)
type Plugin
type PluginBase
type Setting
- func NewSetting(envVariable string, required bool) *Setting
type Settings
type SetupQuestion
- func NewSetupQuestion(question string) *SetupQuestion
- func (o *SetupQuestion) Ask(label string) (err error)
- func (o *SetupQuestion) OnAnswer(answer string) (err error)
type SetupQuestions
- func (o SetupQuestions) Ask(label string) (err error)

Constants ¶

View Source

const AnswerReset = "reset"

View Source

const SettingTypeBool = "bool"

Variables ¶

This section is empty.

Functions ¶

func BuildEnvVariable ¶

func BuildEnvVariable(name string) string

func BuildEnvVariablePrefix ¶

func BuildEnvVariablePrefix(name string) (ret string)

func ParseBool ¶ added in v1.4.197

func ParseBool(val string) (bool, error)

func ParseBoolElseFalse ¶ added in v1.4.197

func ParseBoolElseFalse(val string) (ret bool)

Types ¶

type Plugin ¶

type Plugin interface {
	GetName() string
	GetSetupDescription() string
	IsConfigured() bool
	Configure() error
	Setup() error
	SetupFillEnvFileContent(*bytes.Buffer)
}

type PluginBase ¶

type PluginBase struct {
	Settings
	SetupQuestions

	Name             string
	SetupDescription string
	EnvNamePrefix    string

	ConfigureCustom func() error
}

func (*PluginBase) AddSetting ¶

func (o *PluginBase) AddSetting(name string, required bool) (ret *Setting)

func (*PluginBase) AddSetupQuestion ¶

func (o *PluginBase) AddSetupQuestion(name string, required bool) (ret *SetupQuestion)

func (*PluginBase) AddSetupQuestionBool ¶ added in v1.4.197

func (o *PluginBase) AddSetupQuestionBool(name string, required bool) (ret *SetupQuestion)

func (*PluginBase) AddSetupQuestionCustom ¶

func (o *PluginBase) AddSetupQuestionCustom(name string, required bool, question string) (ret *SetupQuestion)

func (*PluginBase) AddSetupQuestionCustomBool ¶ added in v1.4.197

func (o *PluginBase) AddSetupQuestionCustomBool(name string, required bool, question string) (ret *SetupQuestion)

func (*PluginBase) Configure ¶

func (o *PluginBase) Configure() (err error)

func (*PluginBase) GetName ¶

func (o *PluginBase) GetName() string

func (*PluginBase) GetSetupDescription ¶

func (o *PluginBase) GetSetupDescription() (ret string)

func (*PluginBase) Setup ¶

func (o *PluginBase) Setup() (err error)

func (*PluginBase) SetupFillEnvFileContent ¶

func (o *PluginBase) SetupFillEnvFileContent(fileEnvFileContent *bytes.Buffer)

func (*PluginBase) SetupOrSkip ¶

func (o *PluginBase) SetupOrSkip() (err error)

type Setting ¶

type Setting struct {
	EnvVariable string
	Value       string
	Required    bool
	Type        string // "string" (default), "bool"
}

func NewSetting ¶

func NewSetting(envVariable string, required bool) *Setting

func (*Setting) Configure ¶

func (o *Setting) Configure() error

func (*Setting) FillEnvFileContent ¶

func (o *Setting) FillEnvFileContent(buffer *bytes.Buffer)

func (*Setting) IsDefined ¶

func (o *Setting) IsDefined() bool

func (*Setting) IsValid ¶

func (o *Setting) IsValid() bool

func (*Setting) IsValidErr ¶

func (o *Setting) IsValidErr() (err error)

func (*Setting) Print ¶

func (o *Setting) Print()

type Settings ¶

type Settings []*Setting

func (Settings) Configure ¶

func (o Settings) Configure() (err error)

func (Settings) FillEnvFileContent ¶

func (o Settings) FillEnvFileContent(buffer *bytes.Buffer)

func (Settings) IsConfigured ¶

func (o Settings) IsConfigured() (ret bool)

type SetupQuestion ¶

type SetupQuestion struct {
	*Setting
	Question string
}

func NewSetupQuestion ¶

func NewSetupQuestion(question string) *SetupQuestion

func (*SetupQuestion) Ask ¶

func (o *SetupQuestion) Ask(label string) (err error)

func (*SetupQuestion) OnAnswer ¶

func (o *SetupQuestion) OnAnswer(answer string) (err error)

type SetupQuestions ¶

type SetupQuestions []*SetupQuestion

func (SetupQuestions) Ask ¶

func (o SetupQuestions) Ask(label string) (err error)

Source Files ¶

View all Source files

plugin.go

Directories ¶

Path	Synopsis
ai
anthropic
azure
dryrun
exolab
gemini
gemini_openai
lmstudio
ollama
openai
openai_compatible
db
fsdb
strategy
template Package template provides datetime operations for the template system	Package template provides datetime operations for the template system
tools
code_helper command
converter
githelper
jina
lang
to_pdf command
youtube Package youtube provides YouTube video transcript and comment extraction functionality.	Package youtube provides YouTube video transcript and comment extraction functionality.

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