kit

package

Go to main page

Versions in this module

v0

v0.12.3

Mar 17, 2026

v0.12.2

Mar 16, 2026

v0.12.1

Mar 16, 2026

Changes in this version

type ToolResultMetadata

+ SubagentSessionID string

v0.12.0

Mar 16, 2026

Changes in this version

+ const ToolKindEdit

+ const ToolKindExecute

+ const ToolKindRead

+ const ToolKindSearch

+ const ToolKindSubagent

type AfterToolResultHook

+ ToolCallID string

type BeforeToolCallHook

+ ToolCallID string

+ type DiffBlock struct

+ NewText string

+ OldText string

+ type FileDiffInfo struct

+ Additions int

+ Deletions int

+ DiffBlocks []DiffBlock

+ IsNew bool

+ Path string

type Kit

+ func (m *Kit) GetStructuredMessages() []StructuredMessage

+ func (m *Kit) Subagent(ctx context.Context, cfg SubagentConfig) (*SubagentResult, error)

+ type StructuredMessage struct

+ ID string

+ Model string

+ ParentID string

+ Parts []ContentPart

+ Provider string

+ Role MessageRole

+ Timestamp string

+ type SubagentConfig struct

+ Model string

+ NoSession bool

+ OnEvent func(Event)

+ Prompt string

+ SystemPrompt string

+ Timeout time.Duration

+ Tools []Tool

+ type SubagentResult struct

+ Elapsed time.Duration

+ Error error

+ Response string

+ SessionID string

+ StopReason string

+ Usage *FantasyUsage

type Tool

+ func SubagentTools(opts ...ToolOption) []Tool

type ToolCallEvent

+ ParsedArgs map[string]any

+ ToolCallID string

+ ToolKind string

type ToolExecutionEndEvent

+ ToolCallID string

+ ToolKind string

type ToolExecutionStartEvent

+ ToolCallID string

+ ToolKind string

type ToolResultEvent

+ Metadata *ToolResultMetadata

+ ParsedArgs map[string]any

+ ToolCallID string

+ ToolKind string

+ type ToolResultMetadata struct

+ FileDiffs []FileDiffInfo

type TurnEndEvent

+ StopReason string

type TurnResult

+ SessionID string

+ StopReason string

v0.11.0

Mar 15, 2026

v0.10.3

Mar 15, 2026

v0.10.2

Mar 15, 2026

v0.10.1

Mar 15, 2026

v0.10.0

Mar 14, 2026

Changes in this version

type ToolExecutionStartEvent

+ ToolArgs string

v0.9.0

Mar 9, 2026

v0.8.0

Mar 9, 2026

v0.7.1

Mar 9, 2026

v0.7.0

Mar 8, 2026

Changes in this version

type EventType

+ const EventReasoningDelta

type Kit

+ func (m *Kit) GetThinkingLevel() string

+ func (m *Kit) IsReasoningModel() bool

+ func (m *Kit) PromptResultWithFiles(ctx context.Context, message string, files []fantasy.FilePart) (*TurnResult, error)

+ func (m *Kit) SetThinkingLevel(ctx context.Context, level string) error

+ type ReasoningDeltaEvent struct

+ Delta string

+ func (e ReasoningDeltaEvent) EventType() EventType

v0.6.0

Mar 6, 2026

v0.5.1

Mar 5, 2026

v0.5.0

Mar 5, 2026

v0.4.0

Mar 5, 2026

v0.3.0

Mar 2, 2026

Changes in this version

+ type BeforeCompactHook struct

+ ContextLimit int

+ EstimatedTokens int

+ IsAutomatic bool

+ MessageCount int

+ UsagePercent float64

+ type BeforeCompactResult struct

+ Cancel bool

+ Reason string

+ type ContextPrepareHook struct

+ Messages []fantasy.Message

+ type ContextPrepareResult struct

+ Messages []fantasy.Message

type Kit

+ func (m *Kit) AppendExtensionEntry(extType, data string) (string, error)

+ func (m *Kit) EmitBeforeFork(targetID string, isUserMsg bool, userText string) (cancelled bool, reason string)

+ func (m *Kit) EmitBeforeSessionSwitch(switchReason string) (cancelled bool, reason string)

+ func (m *Kit) EmitExtensionCustomEvent(name, data string)

+ func (m *Kit) EmitModelChange(newModel, previousModel, source string)

+ func (m *Kit) ExecuteCompletion(ctx context.Context, req extensions.CompleteRequest) (extensions.CompleteResponse, error)

+ func (m *Kit) GetAvailableModels() []extensions.ModelInfoEntry

+ func (m *Kit) GetExtensionEntries(extType string) []extensions.ExtensionEntry

+ func (m *Kit) GetExtensionMessageRenderer(name string) *extensions.MessageRendererConfig

+ func (m *Kit) GetExtensionOption(name string) string

+ func (m *Kit) GetExtensionShortcuts() map[string]func()

+ func (m *Kit) GetExtensionStatusEntries() []extensions.StatusBarEntry

+ func (m *Kit) GetExtensionToolInfos() []extensions.ToolInfo

+ func (m *Kit) GetExtensionUIVisibility() *extensions.UIVisibility

+ func (m *Kit) GetSessionFilePath() string

+ func (m *Kit) GetSessionMessages() []extensions.SessionMessage

+ func (m *Kit) OnBeforeCompact(p HookPriority, h func(BeforeCompactHook) *BeforeCompactResult) func()

+ func (m *Kit) OnContextPrepare(p HookPriority, h func(ContextPrepareHook) *ContextPrepareResult) func()

+ func (m *Kit) ReloadExtensions() error

+ func (m *Kit) RemoveExtensionStatus(key string)

+ func (m *Kit) SetExtensionActiveTools(names []string)

+ func (m *Kit) SetExtensionOption(name, value string)

+ func (m *Kit) SetExtensionStatus(entry extensions.StatusBarEntry)

+ func (m *Kit) SetExtensionUIVisibility(v extensions.UIVisibility)

+ func (m *Kit) SetModel(ctx context.Context, modelString string) error

+ func (m *Kit) UpdateExtensionContextModel(model string)

v0.2.1

Mar 1, 2026

v0.2.0

Feb 28, 2026

Changes in this version

+ type CLIOptions struct

+ MCPConfig *config.Config

+ ShowSpinner bool

+ SpinnerFunc SpinnerFunc

+ UseBufferedLogger bool

type Kit

+ func (m *Kit) EmitSessionStart()

+ func (m *Kit) ExtensionCommands() []extensions.CommandDef

+ func (m *Kit) GetBufferedDebugMessages() []string

+ func (m *Kit) GetExtensionContext() extensions.Context

+ func (m *Kit) GetExtensionEditor() *extensions.EditorConfig

+ func (m *Kit) GetExtensionFooter() *extensions.HeaderFooterConfig

+ func (m *Kit) GetExtensionHeader() *extensions.HeaderFooterConfig

+ func (m *Kit) GetExtensionToolCount() int

+ func (m *Kit) GetExtensionToolRenderer(toolName string) *extensions.ToolRenderConfig

+ func (m *Kit) GetExtensionWidgets(placement extensions.WidgetPlacement) []extensions.WidgetConfig

+ func (m *Kit) GetLoadedServerNames() []string

+ func (m *Kit) GetLoadingMessage() string

+ func (m *Kit) GetMCPToolCount() int

+ func (m *Kit) GetToolNames() []string

+ func (m *Kit) HasExtensions() bool

+ func (m *Kit) RemoveExtensionFooter()

+ func (m *Kit) RemoveExtensionHeader()

+ func (m *Kit) RemoveExtensionWidget(id string)

+ func (m *Kit) ResetExtensionEditor()

+ func (m *Kit) SetExtensionContext(ctx extensions.Context)

+ func (m *Kit) SetExtensionEditor(config extensions.EditorConfig)

+ func (m *Kit) SetExtensionFooter(config extensions.HeaderFooterConfig)

+ func (m *Kit) SetExtensionHeader(config extensions.HeaderFooterConfig)

+ func (m *Kit) SetExtensionWidget(config extensions.WidgetConfig)

type Options

+ CLI *CLIOptions

v0.1.0

Feb 27, 2026

Changes in this version

+ const RoleAssistant

+ const RoleSystem

+ const RoleTool

+ const RoleUser

+ var CreateProvider = models.CreateProvider

+ var GetGlobalRegistry = models.GetGlobalRegistry

+ var LoadSystemPrompt = config.LoadSystemPrompt

+ var ParseModelString = models.ParseModelString

+ var WithWorkDir = core.WithWorkDir

+ func BuildProviderConfig() (*models.ProviderConfig, string, error)

+ func CheckProviderReady(provider string) error

+ func ConvertToFantasyMessages(msg *Message) []fantasy.Message

+ func DeleteSession(path string) error

+ func FormatSkillsForPrompt(s []*Skill) string

+ func GetAnthropicAPIKey() string

+ func GetFantasyProviders() []string

+ func GetModelsForProvider(provider string) (map[string]ModelInfo, error)

+ func GetSupportedProviders() []string

+ func HasAnthropicCredentials() bool

+ func InitConfig(configFile string, debug bool) error

+ func InitTreeSession(opts *Options) (*session.TreeManager, error)

+ func LoadConfigWithEnvSubstitution(configPath string) error

+ func RefreshModelRegistry()

+ func SuggestModels(provider, invalidModel string) []string

+ func ValidateEnvironment(provider string, apiKey string) error

+ type AfterToolResultHook struct

+ IsError bool

+ Result string

+ ToolArgs string

+ ToolName string

+ type AfterToolResultResult struct

+ IsError *bool

+ Result *string

+ type AfterTurnHook struct

+ Error error

+ Response string

+ type AfterTurnResult struct

+ type AgentConfig = agent.AgentConfig

+ type AgentSetupOptions struct

+ CoreTools []fantasy.AgentTool

+ ExtraTools []fantasy.AgentTool

+ MCPConfig *config.Config

+ Quiet bool

+ ShowSpinner bool

+ SpinnerFunc agent.SpinnerFunc

+ ToolWrapper func([]fantasy.AgentTool) []fantasy.AgentTool

+ UseBufferedLogger bool

+ type AgentSetupResult struct

+ Agent *agent.Agent

+ BufferedLogger *tools.BufferedDebugLogger

+ ExtRunner *extensions.Runner

+ func SetupAgent(ctx context.Context, opts AgentSetupOptions) (*AgentSetupResult, error)

+ type AnthropicCredentials = auth.AnthropicCredentials

+ type BeforeToolCallHook struct

+ ToolArgs string

+ ToolName string

+ type BeforeToolCallResult struct

+ Block bool

+ Reason string

+ type BeforeTurnHook struct

+ Prompt string

+ type BeforeTurnResult struct

+ InjectText *string

+ Prompt *string

+ SystemPrompt *string

+ type CompactionEvent struct

+ CompactedTokens int

+ MessagesRemoved int

+ OriginalTokens int

+ Summary string

+ func (e CompactionEvent) EventType() EventType

+ type CompactionOptions = compaction.CompactionOptions

+ type CompactionResult = compaction.CompactionResult

+ type Config = config.Config

+ type ContentPart = message.ContentPart

+ type ContextFile struct

+ Content string

+ Path string

+ type ContextStats struct

+ ContextLimit int

+ EstimatedTokens int

+ MessageCount int

+ UsagePercent float64

+ type CredentialManager = auth.CredentialManager

+ func NewCredentialManager() (*CredentialManager, error)

+ type CredentialStore = auth.CredentialStore

+ type Event interface

+ EventType func() EventType

+ type EventListener func(event Event)

+ type EventType string

+ const EventCompaction

+ const EventMessageEnd

+ const EventMessageStart

+ const EventMessageUpdate

+ const EventResponse

+ const EventToolCall

+ const EventToolCallContent

+ const EventToolExecutionEnd

+ const EventToolExecutionStart

+ const EventToolResult

+ const EventTurnEnd

+ const EventTurnStart

+ type FantasyMessage = fantasy.Message

+ type FantasyResponse = fantasy.Response

+ type FantasyUsage = fantasy.Usage

+ type Finish = message.Finish

+ type GenerateResult = agent.GenerateWithLoopResult

+ type HookPriority int

+ const HookPriorityHigh

+ const HookPriorityLow

+ const HookPriorityNormal

+ type Kit struct

+ func New(ctx context.Context, opts *Options) (*Kit, error)

+ func (m *Kit) Branch(entryID string) error

+ func (m *Kit) ClearSession()

+ func (m *Kit) Close() error

+ func (m *Kit) Compact(ctx context.Context, opts *CompactionOptions, customInstructions string) (*CompactionResult, error)

+ func (m *Kit) EstimateContextTokens() int

+ func (m *Kit) FollowUp(ctx context.Context, text string) (string, error)

+ func (m *Kit) GetAgent() *agent.Agent

+ func (m *Kit) GetBufferedLogger() *tools.BufferedDebugLogger

+ func (m *Kit) GetContextFiles() []*ContextFile

+ func (m *Kit) GetContextStats() ContextStats

+ func (m *Kit) GetExtRunner() *extensions.Runner

+ func (m *Kit) GetModelInfo() *ModelInfo

+ func (m *Kit) GetModelString() string

+ func (m *Kit) GetSessionID() string

+ func (m *Kit) GetSessionPath() string

+ func (m *Kit) GetSkills() []*Skill

+ func (m *Kit) GetTools() []Tool

+ func (m *Kit) GetTreeSession() *TreeManager

+ func (m *Kit) OnAfterToolResult(p HookPriority, h func(AfterToolResultHook) *AfterToolResultResult) func()

+ func (m *Kit) OnAfterTurn(p HookPriority, h func(AfterTurnHook)) func()

+ func (m *Kit) OnBeforeToolCall(p HookPriority, h func(BeforeToolCallHook) *BeforeToolCallResult) func()

+ func (m *Kit) OnBeforeTurn(p HookPriority, h func(BeforeTurnHook) *BeforeTurnResult) func()

+ func (m *Kit) OnResponse(handler func(ResponseEvent)) func()

+ func (m *Kit) OnStreaming(handler func(MessageUpdateEvent)) func()

+ func (m *Kit) OnToolCall(handler func(ToolCallEvent)) func()

+ func (m *Kit) OnToolResult(handler func(ToolResultEvent)) func()

+ func (m *Kit) OnTurnEnd(handler func(TurnEndEvent)) func()

+ func (m *Kit) OnTurnStart(handler func(TurnStartEvent)) func()

+ func (m *Kit) Prompt(ctx context.Context, message string) (string, error)

+ func (m *Kit) PromptResult(ctx context.Context, message string) (*TurnResult, error)

+ func (m *Kit) PromptWithCallbacks(ctx context.Context, message string, onToolCall func(name, args string), ...) (string, error)

+ func (m *Kit) PromptWithOptions(ctx context.Context, msg string, opts PromptOptions) (string, error)

+ func (m *Kit) SetSessionName(name string) error

+ func (m *Kit) SetTreeSession(ts *TreeManager)

+ func (m *Kit) ShouldCompact() bool

+ func (m *Kit) Steer(ctx context.Context, instruction string) (string, error)

+ func (m *Kit) Subscribe(listener EventListener) func()

+ type MCPServerConfig = config.MCPServerConfig

+ type Message = message.Message

+ func ConvertFromFantasyMessage(msg fantasy.Message) Message

+ type MessageEndEvent struct

+ Content string

+ func (e MessageEndEvent) EventType() EventType

+ type MessageEntry = session.MessageEntry

+ type MessageRole = message.MessageRole

+ type MessageStartEvent struct

+ func (e MessageStartEvent) EventType() EventType

+ type MessageUpdateEvent struct

+ Chunk string

+ func (e MessageUpdateEvent) EventType() EventType

+ type ModelCost = models.Cost

+ type ModelInfo = models.ModelInfo

+ func LookupModel(provider, modelID string) *ModelInfo

+ type ModelLimit = models.Limit

+ type ModelsRegistry = models.ModelsRegistry

+ type Options struct

+ AutoCompact bool

+ CompactionOptions *CompactionOptions

+ ConfigFile string

+ Continue bool

+ Debug bool

+ ExtraTools []Tool

+ MCPConfig *config.Config

+ MaxSteps int

+ Model string

+ NoSession bool

+ Quiet bool

+ SessionDir string

+ SessionPath string

+ ShowSpinner bool

+ Skills []string

+ SkillsDir string

+ SpinnerFunc SpinnerFunc

+ Streaming bool

+ SystemPrompt string

+ Tools []Tool

+ UseBufferedLogger bool

+ type PromptBuilder = skills.PromptBuilder

+ func NewPromptBuilder(basePrompt string) *PromptBuilder

+ type PromptOptions struct

+ SystemMessage string

+ type PromptTemplate = skills.PromptTemplate

+ func LoadPromptTemplate(path string) (*PromptTemplate, error)

+ func NewPromptTemplate(name, content string) *PromptTemplate

+ type ProviderConfig = models.ProviderConfig

+ type ProviderInfo = models.ProviderInfo

+ func GetProviderInfo(provider string) *ProviderInfo

+ type ProviderResult = models.ProviderResult

+ type ReasoningContent = message.ReasoningContent

+ type ResponseEvent struct

+ Content string

+ func (e ResponseEvent) EventType() EventType

+ type ResponseHandler = agent.ResponseHandler

+ type SessionHeader = session.SessionHeader

+ type SessionInfo = session.SessionInfo

+ func ListAllSessions() ([]SessionInfo, error)

+ func ListSessions(dir string) ([]SessionInfo, error)

+ type Skill = skills.Skill

+ func LoadSkill(path string) (*Skill, error)

+ func LoadSkills(cwd string) ([]*Skill, error)

+ func LoadSkillsFromDir(dir string) ([]*Skill, error)

+ type SpinnerFunc = agent.SpinnerFunc

+ type StreamingResponseHandler = agent.StreamingResponseHandler

+ type TextContent = message.TextContent

+ type Tool = fantasy.AgentTool

+ func AllTools(opts ...ToolOption) []Tool

+ func CodingTools(opts ...ToolOption) []Tool

+ func NewBashTool(opts ...ToolOption) Tool

+ func NewEditTool(opts ...ToolOption) Tool

+ func NewFindTool(opts ...ToolOption) Tool

+ func NewGrepTool(opts ...ToolOption) Tool

+ func NewLsTool(opts ...ToolOption) Tool

+ func NewReadTool(opts ...ToolOption) Tool

+ func NewWriteTool(opts ...ToolOption) Tool

+ func ReadOnlyTools(opts ...ToolOption) []Tool

+ type ToolCall = message.ToolCall

+ type ToolCallContentEvent struct

+ Content string

+ func (e ToolCallContentEvent) EventType() EventType

+ type ToolCallContentHandler = agent.ToolCallContentHandler

+ type ToolCallEvent struct

+ ToolArgs string

+ ToolName string

+ func (e ToolCallEvent) EventType() EventType

+ type ToolCallHandler = agent.ToolCallHandler

+ type ToolExecutionEndEvent struct

+ ToolName string

+ func (e ToolExecutionEndEvent) EventType() EventType

+ type ToolExecutionHandler = agent.ToolExecutionHandler

+ type ToolExecutionStartEvent struct

+ ToolName string

+ func (e ToolExecutionStartEvent) EventType() EventType

+ type ToolOption = core.ToolOption

+ type ToolResult = message.ToolResult

+ type ToolResultEvent struct

+ IsError bool

+ Result string

+ ToolArgs string

+ ToolName string

+ func (e ToolResultEvent) EventType() EventType

+ type ToolResultHandler = agent.ToolResultHandler

+ type TreeManager = session.TreeManager

+ type TurnEndEvent struct

+ Error error

+ Response string

+ func (e TurnEndEvent) EventType() EventType

+ type TurnResult struct

+ FinalUsage *FantasyUsage

+ Messages []FantasyMessage

+ Response string

+ TotalUsage *FantasyUsage

+ type TurnStartEvent struct

+ Prompt string

+ func (e TurnStartEvent) EventType() EventType

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