cli

Documentation

Index

• func AppendMessage(message string, newMessage string) (ret string)
• func Cli(version string) (err error)
• func CopyToClipboard(message string) (err error)
• func CreateOutputFile(message string, fileName string) (err error)
• func WriteOutput(message string, outputFile string) (err error)
• type Flags
  • func Init() (ret *Flags, err error)
  • func (o *Flags) AppendMessage(message string)
  • func (o *Flags) BuildChatOptions() (ret *common.ChatOptions)
  • func (o *Flags) BuildChatRequest(Meta string) (ret *common.ChatRequest, err error)
  • func (o *Flags) IsChatRequest() (ret bool)
  • func (o *Flags) WriteOutput(message string) (err error)

Functions

func AppendMessage

func AppendMessage(message string, newMessage string) (ret string)

func Cli

func Cli(version string) (err error)

Cli Controls the cli. It takes in the flags and runs the appropriate functions

func CopyToClipboard

func CopyToClipboard(message string) (err error)

func CreateOutputFile

func CreateOutputFile(message string, fileName string) (err error)

func WriteOutput

func WriteOutput(message string, outputFile string) (err error)

Types

type Flags

type Flags struct {
	Pattern            string            `short:"p" long:"pattern" description:"Choose a pattern from the available patterns" default:""`
	PatternVariables   map[string]string `short:"v" long:"variable" description:"Values for pattern variables, e.g. -v=#role:expert -v=#points:30"`
	Context            string            `short:"C" long:"context" description:"Choose a context from the available contexts" default:""`
	Session            string            `long:"session" description:"Choose a session from the available sessions"`
	Attachments        []string          `short:"a" long:"attachment" description:"Attachment path or URL (e.g. for OpenAI image recognition messages)"`
	Setup              bool              `short:"S" long:"setup" description:"Run setup for all reconfigurable parts of fabric"`
	Temperature        float64           `short:"t" long:"temperature" description:"Set temperature" default:"0.7"`
	TopP               float64           `short:"T" long:"topp" description:"Set top P" default:"0.9"`
	Stream             bool              `short:"s" long:"stream" description:"Stream"`
	PresencePenalty    float64           `short:"P" long:"presencepenalty" description:"Set presence penalty" default:"0.0"`
	Raw                bool              `` /* 180-byte string literal not displayed */
	FrequencyPenalty   float64           `short:"F" long:"frequencypenalty" description:"Set frequency penalty" default:"0.0"`
	ListPatterns       bool              `short:"l" long:"listpatterns" description:"List all patterns"`
	ListAllModels      bool              `short:"L" long:"listmodels" description:"List all available models"`
	ListAllContexts    bool              `short:"x" long:"listcontexts" description:"List all contexts"`
	ListAllSessions    bool              `short:"X" long:"listsessions" description:"List all sessions"`
	UpdatePatterns     bool              `short:"U" long:"updatepatterns" description:"Update patterns"`
	Message            string            `hidden:"true" description:"Messages to send to chat"`
	Copy               bool              `short:"c" long:"copy" description:"Copy to clipboard"`
	Model              string            `short:"m" long:"model" description:"Choose model"`
	ModelContextLength int               `long:"modelContextLength" description:"Model context length (only affects ollama)"`
	Output             string            `short:"o" long:"output" description:"Output to file" default:""`
	OutputSession      bool              `long:"output-session" description:"Output the entire session (also a temporary one) to the output file"`
	LatestPatterns     string            `short:"n" long:"latest" description:"Number of latest patterns to list" default:"0"`
	ChangeDefaultModel bool              `short:"d" long:"changeDefaultModel" description:"Change default model"`
	YouTube            string            `` /* 190-byte string literal not displayed */
	YouTubePlaylist    bool              `long:"playlist" description:"Prefer playlist over video if both ids are present in the URL"`
	YouTubeTranscript  bool              `long:"transcript" description:"Grab transcript from YouTube video and send to chat (it used per default)."`
	YouTubeComments    bool              `long:"comments" description:"Grab comments from YouTube video and send to chat"`
	Language           string            `short:"g" long:"language" description:"Specify the Language Code for the chat, e.g. -g=en -g=zh" default:""`
	ScrapeURL          string            `short:"u" long:"scrape_url" description:"Scrape website URL to markdown using Jina AI"`
	ScrapeQuestion     string            `short:"q" long:"scrape_question" description:"Search question using Jina AI"`
	Seed               int               `short:"e" long:"seed" description:"Seed to be used for LMM generation"`
	WipeContext        string            `short:"w" long:"wipecontext" description:"Wipe context"`
	WipeSession        string            `short:"W" long:"wipesession" description:"Wipe session"`
	PrintContext       string            `long:"printcontext" description:"Print context"`
	PrintSession       string            `long:"printsession" description:"Print session"`
	HtmlReadability    bool              `long:"readability" description:"Convert HTML input into a clean, readable view"`
	DryRun             bool              `long:"dry-run" description:"Show what would be sent to the model without actually sending it"`
	Serve              bool              `long:"serve" description:"Serve the Fabric Rest API"`
	ServeAddress       string            `long:"address" description:"The address to bind the REST API" default:":8080"`
	Version            bool              `long:"version" description:"Print current version"`
}

Flags create flags struct. the users flags go into this, this will be passed to the chat struct in cli

func Init

func Init() (ret *Flags, err error)

Init Initialize flags. returns a Flags struct and an error

func (*Flags) AppendMessage

func (o *Flags) AppendMessage(message string)

func (*Flags) BuildChatOptions

func (o *Flags) BuildChatOptions() (ret *common.ChatOptions)

func (*Flags) BuildChatRequest

func (o *Flags) BuildChatRequest(Meta string) (ret *common.ChatRequest, err error)

func (*Flags) IsChatRequest

func (o *Flags) IsChatRequest() (ret bool)

func (*Flags) WriteOutput

func (o *Flags) WriteOutput(message string) (err error)