butterfish

May 28, 2024

Changes in this version

+ var CONTROL_STARTS = map[byte]bool

May 21, 2024

Changes in this version

type ButterfishConfig

+ ColorDark bool

type ShellState

+ PromptGoalAnswerWriter io.Writer

May 10, 2024

Changes in this version

+ const DEFAULT_AUTOSUGGEST_ENCODER

+ const DEFAULT_PROMPT_ENCODER

type ButterfishConfig

+ ShellMaxPromptTokens int

Apr 30, 2024

Changes in this version

type ButterfishConfig

+ TokenTimeout time.Duration

Apr 28, 2024

Changes in this version

type ButterfishConfig

+ ShellMaxResponseTokens int

+ ShellTokenTimeout time.Duration

Jan 5, 2024

Changes in this version

type ShellColorScheme

+ AnswerHighlight string

Dec 23, 2023

Changes in this version

+ var EditSysMsg = `You're helping an expert programmer edit a file of code. You can either respond with questions and clarifications, or you can use the edit() tool, which replaces a range from the file with new code. In some cases you may want to call edit() multiple times, I will apply the edits and give you the updated file after every call. Use the most recent file for your edits. If there are no more edits, just say "DONE!"`

+ var EditTools = []util.ToolDefinition

+ func ApplyEditToolToLineBuffer(toolCall *util.ToolCall, lineBuffer *LineBuffer) error

+ func JSONString(input any) string

+ func PrettyJSON(input string) string

type ButterfishCtx

+ func (this *ButterfishCtx) EditLineBuffer(lineBuffer *LineBuffer, prompt string, options *CliCommandConfig) error

type CliCommandConfig

+ Edit struct{ ... }

+ type EditToolParameters struct

+ CodeEdit string

+ RangeEnd int

+ RangeStart int

+ type LineBuffer struct

+ Lines []string

+ func NewLineBuffer(filepath string) (*LineBuffer, error)

+ func (this *LineBuffer) PrefixLineNumbers() string

+ func (this *LineBuffer) ReplaceRange(start, end int, replacement string) error

+ func (this *LineBuffer) String() string

Nov 22, 2023

Changes in this version

type ShellState

+ StyleWriter *util.StyleCodeblocksWriter

+ func (this *ShellState) ParentInput(ctx context.Context, data []byte) []byte

+ func (this *ShellState) ParentInputLoop(data []byte)

Nov 13, 2023

Changes in this version

type ButterfishConfig

+ BaseURL string

type ShellState

+ LastTabPassthrough time.Time

Oct 16, 2023

Changes in this version

type ShellState

+ func (this *ShellState) GoalModeFunction(output *util.CompletionResponse)

Oct 4, 2023

Changes in this version

+ const CLEAR_COLOR

Sep 27, 2023

Changes in this version

type ButterfishConfig

+ ShellNewlineAutosuggestTimeout time.Duration

Sep 26, 2023

Changes in this version

+ func IsCompletionModel(modelName string) bool

type GPT

+ func (this *GPT) InstructCompletion(request *util.CompletionRequest) (*util.CompletionResponse, error)

+ func (this *GPT) InstructCompletionStream(request *util.CompletionRequest, writer io.Writer) (*util.CompletionResponse, error)

type PromptLibrary

+ GetUninterpolatedPrompt func(name string) (string, error)

+ InterpolatePrompt func(prompt string, args ...string) (string, error)

Aug 28, 2023

Changes in this version

+ func GetSystemInfo() string

type CliCommandConfig

+ Promptedit struct{ ... }

type ShellState

+ func (this *ShellState) GoalModeFunctionResponse(output string)

Aug 17, 2023

Changes in this version

+ var ZSH_CLEAR_REGEX = regexp.MustCompile("^\x1b\\[1m\x1b\\[3m%\x1b\\[23m\x1b\\[1m\x1b\\[0m\x20+\x0d\x20\x0d")

+ func AddDoubleEscapesForJSON(s string) string

+ func ShellHistoryBlocksToGPTChat(systemMsg string, blocks []util.HistoryBlock) []openai.ChatCompletionMessage

+ func ShellHistoryTypeToRole(t int) string

type HistoryBuffer

+ FunctionName string

+ FunctionParams string

type ShellHistory

+ func (this *ShellHistory) AddFunctionCall(name, params string)

+ func (this *ShellHistory) AppendFunctionOutput(name, data string)

type ShellState

+ ActiveFunction string

+ func (this *ShellState) FilterChildOut(data string) bool

Aug 9, 2023

Changes in this version

+ const BOX_WIDTH

+ const H_LINE

+ const NE_CORNER

+ const NW_CORNER

+ const SE_CORNER

+ const SW_CORNER

+ const V_LINE

+ var BOX_COLORS = []string

+ func LogChatCompletionRequest(req openai.ChatCompletionRequest)

+ func LogCompletionRequest(req openai.CompletionRequest)

+ func LogCompletionResponse(resp util.CompletionResponse)

+ func PrintLoggingBox(box LoggingBox)

+ type LoggingBox struct

+ Children []LoggingBox

+ Color int

+ Content string

+ Title string

Aug 5, 2023

Changes in this version

+ type CommandParams struct

+ Cmd string

+ type FinishParams struct

+ Success bool

+ type UserInputParams struct

+ Question string

Jun 7, 2023

Changes in this version

+ const EMOJI_DEFAULT

+ const EMOJI_GOAL

+ const EMOJI_GOAL_UNSAFE

+ const ESC_CLEAR

+ const ESC_CUP

+ const ESC_LEFT

+ const ESC_RIGHT

+ const ESC_UP

+ const PROMPT_PREFIX

+ const PROMPT_PREFIX_ESCAPED

+ const PROMPT_SUFFIX

+ const PROMPT_SUFFIX_ESCAPED

+ var DarkShellColorScheme = &ShellColorScheme

+ var LegacyModelTypes = []string

+ var LightShellColorScheme = &ShellColorScheme

+ var MODEL_TO_NUM_TOKENS = map[string]int

+ var MODEL_TO_TOKENS_PER_MESSAGE = map[string]int

+ func CompletionRoutine(request *util.CompletionRequest, client LLM, writer io.Writer, ...)

+ func HistoryTypeToString(historyType int) string

+ func IsLegacyModel(model string) bool

+ func NumTokensForModel(model string) int

+ func NumTokensPerMessageForModel(model string) int

+ func ParsePS1(data string, regex *regexp.Regexp, currIcon string) (int, int, string)

type ButterfishConfig

+ ShellBinary string

+ ShellColorDark bool

+ ShellLeavePromptAlone bool

+ ShellMaxHistoryBlockTokens int

+ ShellPluginMode bool

+ func (this *ButterfishConfig) ParseShell() string

type ButterfishCtx

+ func (this *ButterfishCtx) PluginFrontend(pluginClient *PluginClient)

+ func (this *ButterfishCtx) SetPS1(childIn io.Writer)

+ func (this *ButterfishCtx) StartPluginClient(hostname string, port int) (*PluginClient, error)

type HistoryBuffer

+ Tokenizations map[string]Tokenization

+ func (this *HistoryBuffer) GetTokenization(encoding string, length int) (string, int, bool)

+ func (this *HistoryBuffer) SetTokenization(encoding string, inputLength int, numTokens int, data string)

+ type PluginClient struct

+ CommandChan chan string

+ CommandExecutionChan chan *commandExecution

+ func (this *PluginClient) HandleCommandExecution(ctx context.Context, id string)

+ func (this *PluginClient) Mux(ctx context.Context) error

+ type ShellColorScheme struct

+ Answer string

+ Autosuggest string

+ Command string

+ Error string

+ GoalMode string

+ Prompt string

+ PromptGoal string

+ PromptGoalUnsafe string

type ShellHistory

+ func (this *ShellHistory) IterateBlocks(cb func(block *HistoryBuffer) bool)

type ShellState

+ AutosuggestEncoder *tiktoken.Tiktoken

+ AutosuggestMaxTokens int

+ Color *ShellColorScheme

+ CursorPosChan chan *cursorPosition

+ GoalMode bool

+ GoalModeBuffer string

+ GoalModeGoal string

+ GoalModeUnsafe bool

+ PrintErrorChan chan error

+ PromptEncoder *tiktoken.Tiktoken

+ PromptMaxTokens int

+ PromptSuffixCounter int

+ TokensReservedForAnswer int

+ func (this *ShellState) AssembleChat(prompt, sysMsg string) (string, []util.HistoryBlock, error)

+ func (this *ShellState) Errorf(format string, args ...any)

+ func (this *ShellState) GetCursorPosition() (int, int)

+ func (this *ShellState) GoalModeChat()

+ func (this *ShellState) GoalModeCommandResponse(status int, output string)

+ func (this *ShellState) GoalModeStart()

+ func (this *ShellState) HandleLocalPrompt() bool

+ func (this *ShellState) ParsePS1(data string) (int, int, string)

+ func (this *ShellState) PrintError(err error)

+ func (this *ShellState) PrintHistory()

+ func (this *ShellState) SendPromptResponse(data string)

+ type Tokenization struct

+ Data string

+ InputLength int

+ NumTokens int

Apr 21, 2023

Changes in this version

+ const ERR_429

+ const ERR_429_HELP

type ButterfishConfig

+ BuildInfo string

+ ShellAutosuggestEnabled bool

+ ShellCommandPrompt string

type ShellState

+ func (this *ShellState) PrintHelp()

+ func (this *ShellState) PrintStatus()

Mar 21, 2023

Changes in this version

type ShellState

+ AnswerColorString string

Mar 20, 2023

Changes in this version

+ func RequestCancelableAutosuggest(ctx context.Context, delay time.Duration, currCommand string, prompt string, ...)

Mar 19, 2023

Changes in this version

+ const BestAutosuggestModel

+ func ChatCompletionRequestMessagesString(msgs []gpt3.ChatCompletionRequestMessage) string

+ func HasRunningChildren() bool

+ func HistoryBlocksToString(blocks []util.HistoryBlock) string

+ func RunShell(ctx context.Context, config *ButterfishConfig, shell string) error

+ func ShellHistoryBlockToGPTChat(systemMsg string, blocks []util.HistoryBlock) []gpt3.ChatCompletionRequestMessage

+ type AutosuggestResult struct

+ Command string

+ Suggestion string

type ButterfishConfig

+ ShellAutosuggestHistoryWindow int

+ ShellAutosuggestModel string

+ ShellAutosuggestTimeout time.Duration

+ ShellMode bool

+ ShellPromptHistoryWindow int

+ ShellPromptModel string

type ButterfishCtx

+ func (this *ButterfishCtx) ShellMultiplexer(childIn io.Writer, childOut io.Reader, parentIn io.Reader, parentOut io.Writer)

type GPT

+ func (this *GPT) FullChatCompletion(request *util.CompletionRequest) (string, error)

+ func (this *GPT) FullChatCompletionStream(request *util.CompletionRequest, writer io.Writer) (string, error)

+ func (this *GPT) Printf(format string, args ...any)

+ func (this *GPT) SetVerboseLogging()

+ type HistoryBuffer struct

+ Content *ShellBuffer

+ Type int

+ type ShellBuffer struct

+ func NewShellBuffer() *ShellBuffer

+ func (this *ShellBuffer) Clear() []byte

+ func (this *ShellBuffer) ClearLast(colorStr string) []byte

+ func (this *ShellBuffer) Cursor() int

+ func (this *ShellBuffer) EatAutosuggestRune()

+ func (this *ShellBuffer) SetColor(r int, g int, b int)

+ func (this *ShellBuffer) SetPromptLength(promptLength int)

+ func (this *ShellBuffer) SetTerminalWidth(width int)

+ func (this *ShellBuffer) Size() int

+ func (this *ShellBuffer) String() string

+ func (this *ShellBuffer) Write(data string) []byte

+ func (this *ShellBuffer) WriteAutosuggest(autosuggestText string, jumpForward int, colorStr string) []byte

+ type ShellHistory struct

+ Blocks []HistoryBuffer

+ TruncateLength int

+ func NewShellHistory() *ShellHistory

+ func (this *ShellHistory) Add(historyType int, block string)

+ func (this *ShellHistory) Append(historyType int, data string)

+ func (this *ShellHistory) GetLastNBytes(numBytes int) []util.HistoryBlock

+ func (this *ShellHistory) LogRecentHistory()

+ func (this *ShellHistory) NewBlock()

+ type ShellState struct

+ AutosuggestBuffer *ShellBuffer

+ AutosuggestCancel context.CancelFunc

+ AutosuggestChan chan *AutosuggestResult

+ AutosuggestColorString string

+ AutosuggestCtx context.Context

+ AutosuggestEnabled bool

+ AutosuggestStyle lipgloss.Style

+ Butterfish *ButterfishCtx

+ ChildIn io.Writer

+ ChildOutReader chan *byteMsg

+ Command *ShellBuffer

+ CommandColorString string

+ History *ShellHistory

+ LastAutosuggest string

+ ParentInReader chan *byteMsg

+ ParentOut io.Writer

+ PendingAutosuggest *AutosuggestResult

+ Prompt *ShellBuffer

+ PromptAnswerWriter io.Writer

+ PromptColorString string

+ PromptOutputChan chan *byteMsg

+ PromptResponseCancel context.CancelFunc

+ PromptStyle lipgloss.Style

+ Sigwinch chan os.Signal

+ State int

+ TerminalWidth int

+ func (this *ShellState) ClearAutosuggest(colorStr string)

+ func (this *ShellState) InputFromParent(ctx context.Context, data []byte)

+ func (this *ShellState) Mux()

+ func (this *ShellState) RealizeAutosuggest(buffer *ShellBuffer, sendToChild bool, colorStr string)

+ func (this *ShellState) RefreshAutosuggest(newData []byte, buffer *ShellBuffer, colorStr string)

+ func (this *ShellState) RequestAutosuggest(delay time.Duration, command string)

+ func (this *ShellState) RequestCancelableAutosuggest(ctx context.Context, delay time.Duration, currCommand string, prompt string, ...)

+ func (this *ShellState) SendPrompt()

+ func (this *ShellState) ShowAutosuggest(buffer *ShellBuffer, result *AutosuggestResult, cursorCol int, termWidth int)

Mar 2, 2023

Changes in this version

+ const BestCompletionModel

type ButterfishConfig

+ ExeccheckMaxTokens int

+ ExeccheckModel string

+ ExeccheckTemperature float32

+ GencmdMaxTokens int

+ GencmdModel string

+ GencmdTemperature float32

+ SummarizeMaxTokens int

+ SummarizeModel string

+ SummarizeTemperature float32

type GPT

+ func (this *GPT) LegacyCompletion(request *util.CompletionRequest) (string, error)

+ func (this *GPT) LegacyCompletionStream(request *util.CompletionRequest, writer io.Writer) (string, error)

+ func (this *GPT) SimpleChatCompletion(request *util.CompletionRequest) (string, error)

+ func (this *GPT) SimpleChatCompletionStream(request *util.CompletionRequest, writer io.Writer) (string, error)

Mar 1, 2023

Changes in this version

type ButterfishCtx

+ func (this *ButterfishCtx) StyleSprintf(style lipgloss.Style, format string, a ...any) string

Feb 23, 2023

Changes in this version

+ const GPTEditModel

+ const GPTEmbeddingsMaxTokens

+ const GPTEmbeddingsModel

+ var GruvboxDark = ColorScheme

+ var GruvboxLight = ColorScheme

+ func ColorSchemeToStyles(colorScheme *ColorScheme) *styles

+ func NewByteMsg(data []byte) *byteMsg

+ func NewDiskPromptLibrary(path string, verbose bool, writer io.Writer) (*prompt.DiskPromptLibrary, error)

+ func RunConsole(ctx context.Context, config *ButterfishConfig) error

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

+ type ButterfishConfig struct

+ ColorScheme *ColorScheme

+ LLMClient LLM

+ OpenAIToken string

+ PromptLibrary PromptLibrary

+ PromptLibraryPath string

+ Styles *styles

+ SummarizeChunkSize int

+ SummarizeMaxChunks int

+ Verbose bool

+ func MakeButterfishConfig() *ButterfishConfig

+ type ButterfishCtx struct

+ Cancel context.CancelFunc

+ ClientController ClientController

+ CommandRegister string

+ Config *ButterfishConfig

+ ConsoleCmdChan <-chan string

+ Ctx context.Context

+ InConsoleMode bool

+ LLMClient LLM

+ Out io.Writer

+ PromptLibrary PromptLibrary

+ VectorIndex embedding.FileEmbeddingIndex

+ func NewButterfish(ctx context.Context, config *ButterfishConfig) (*ButterfishCtx, error)

+ func (this *ButterfishCtx) CalculateEmbeddings(ctx context.Context, content []string) ([][]float64, error)

+ func (this *ButterfishCtx) Command(cmd string) error

+ func (this *ButterfishCtx) ErrorPrintf(format string, a ...any)

+ func (this *ButterfishCtx) ExecCommand(parsed *kong.Context, options *CliCommandConfig) error

+ func (this *ButterfishCtx) ParseCommand(cmd string) (*kong.Context, *CliCommandConfig, error)

+ func (this *ButterfishCtx) Printf(format string, a ...any)

+ func (this *ButterfishCtx) Prompt(prompt string, model string, maxTokens int, temperature float32) error

+ func (this *ButterfishCtx) StylePrintf(style lipgloss.Style, format string, a ...any)

+ func (this *ButterfishCtx) SummarizeChunks(chunks [][]byte) error

+ func (this *ButterfishCtx) SummarizePath(path string) error

+ func (this *ButterfishCtx) SummarizePaths(paths []string) error

+ type CliCommandConfig struct

+ Clearindex struct{ ... }

+ Exec struct{ ... }

+ Execremote struct{ ... }

+ Gencmd struct{ ... }

+ Index struct{ ... }

+ Indexquestion struct{ ... }

+ Indexsearch struct{ ... }

+ Loadindex struct{ ... }

+ Prompt struct{ ... }

+ Rewrite struct{ ... }

+ Showindex struct{ ... }

+ Summarize struct{ ... }

+ type ClientController interface

+ GetClientLastCommand func(client int) (string, error)

+ GetClientOpenCommand func(client int) (string, error)

+ GetClientWithOpenCmdLike func(cmd string) int

+ GetReader func() <-chan *ClientOut

+ Write func(client int, data string) error

+ func RunIPCServer(ctx context.Context, output io.Writer) ClientController

+ type ClientOut struct

+ Client int

+ Data []byte

+ type ColorScheme struct

+ Background string

+ Color1 string

+ Color2 string

+ Color3 string

+ Color4 string

+ Color5 string

+ Color6 string

+ Error string

+ Foreground string

+ Grey string

+ type GPT struct

+ func NewGPT(token string, verbose bool, verboseWriter io.Writer) *GPT

+ func (this *GPT) Completion(request *util.CompletionRequest) (string, error)

+ func (this *GPT) CompletionStream(request *util.CompletionRequest, writer io.Writer) (string, error)

+ func (this *GPT) Edits(ctx context.Context, content, instruction, model string) (string, error)

+ func (this *GPT) Embeddings(ctx context.Context, input []string) ([][]float64, error)

+ func (this *GPT) SetVerbose(verbose bool)

+ type IPCClient struct

+ func (this *IPCClient) Recv() (*proto.ServerPush, error)

+ func (this *IPCClient) SendInput(input []byte) error

+ func (this *IPCClient) SendOutput(output []byte) error

+ func (this *IPCClient) SendWrappedCommand(cmd string) error

+ type IPCServer struct

+ func (this *IPCServer) GetClientLastCommand(client int) (string, error)

+ func (this *IPCServer) GetClientOpenCommand(client int) (string, error)

+ func (this *IPCServer) GetClientWithOpenCmdLike(cmd string) int

+ func (this *IPCServer) GetReader() <-chan *ClientOut

+ func (this *IPCServer) StreamsForWrapping(srv proto.Butterfish_StreamsForWrappingServer) error

+ func (this *IPCServer) Write(client int, data string) error

+ type LLM interface

+ Completion func(request *util.CompletionRequest) (string, error)

+ CompletionStream func(request *util.CompletionRequest, writer io.Writer) (string, error)

+ Edits func(ctx context.Context, content, instruction, model string) (string, error)

+ Embeddings func(ctx context.Context, input []string) ([][]float64, error)

+ type PromptLibrary interface

+ GetPrompt func(name string, args ...string) (string, error)