tui

package

Go to main page

Versions in this module

v0

v0.2.0

Jul 25, 2026

Changes in this version

type Preview

+ Companion string

+ RawOutput bool

type RuntimeControlResult

+ RawOutput *bool

type ShellOptions

+ Companion *companion.Manifest

+ RawOutput bool

+ ToggleRaw RuntimeControlFunc

type SlashResult

+ Companion *companion.Manifest

+ CompanionChanged bool

+ RawOutput *bool

v0.1.2

Jul 15, 2026

v0.1.1

Jul 15, 2026

Changes in this version

type ShellOptions

+ GitBranch string

+ ShowWelcome bool

+ Version string

+ Workspace string

v0.1.0

Jul 14, 2026

Changes in this version

+ func ConfirmWorkspaceTrust(ctx context.Context, workspace string) (bool, error)

+ func ConfirmWorkspaceTrustWithTheme(ctx context.Context, workspace string, theme string) (bool, error)

+ func NormalizeThemeName(name string) (string, bool)

+ func SelectSession(ctx context.Context, choices []SessionChoice) (string, error)

+ func SelectSessionWithTheme(ctx context.Context, choices []SessionChoice, theme string) (string, error)

+ func SelectTheme(ctx context.Context, current string, intro bool) (string, bool, error)

+ func Shell(ctx context.Context, options ShellOptions) error

+ func ThemeNames() []string

+ type BackgroundFunc func(context.Context, string) (string, error)

+ type CommandView struct

+ SelectedItem int

+ SelectedTab int

+ Tabs []CommandViewTab

+ Title string

+ type CommandViewItem struct

+ Action string

+ Command string

+ Description string

+ Label string

+ SecondaryAction string

+ SecondaryCommand string

+ SecondaryKey string

+ SecondaryLabel string

+ Value string

+ type CommandViewTab struct

+ Items []CommandViewItem

+ Lines []string

+ RefreshCommand string

+ Title string

+ type ConversationExportFunc func(context.Context, string) (RuntimeControlResult, error)

+ type ConversationForkFunc func(context.Context, int) (RuntimeControlResult, error)

+ type ConversationRestoreFunc func(context.Context, int) (RuntimeControlResult, error)

+ type ConversationSummarizeFunc func(context.Context, int) (RuntimeControlResult, error)

+ type DiffFile struct

+ Diff string

+ Path string

+ Status string

+ Summary string

+ type DiffSource struct

+ Files []DiffFile

+ Name string

+ Subtitle string

+ type DiffView struct

+ Sources []DiffSource

+ type Entry struct

+ Permission *PermissionRequest

+ Question *QuestionRequest

+ Role string

+ Text string

+ Tool *ToolActivity

+ type ExportDialog struct

+ DefaultFilename string

+ type ExternalEditorFunc func(context.Context, string) (string, error)

+ type InformationView struct

+ DismissOnConfirm bool

+ Lines []string

+ Title string

+ type MessageCopyFunc func(context.Context, string) (RuntimeControlResult, error)

+ type ModelSelectFunc func(context.Context, string) (RuntimeControlResult, error)

+ type PasteContent struct

+ AttachmentPath string

+ MediaType string

+ Text string

+ type PasteFunc func(context.Context) (PasteContent, error)

+ type PermissionModeOption struct

+ Current bool

+ Description string

+ Label string

+ Name string

+ type PermissionModeSelectFunc func(context.Context, string) (RuntimeControlResult, error)

+ type PermissionRequest struct

+ AllowAlways bool

+ Input string

+ Message string

+ Required string

+ SuggestedRule string

+ Tool string

+ type PermissionResponse struct

+ Decision string

+ Feedback string

+ Rule string

+ type PermissionSettings struct

+ Allow []string

+ Ask []string

+ Deny []string

+ Modes []PermissionModeOption

+ type Preview struct

+ Attachments []string

+ AttachmentsOpen bool

+ CommandHint string

+ CommandView bool

+ DiffDialog bool

+ ExportDialog bool

+ GlobalSearch bool

+ HasStash bool

+ HelpOpen bool

+ InformationView bool

+ InlineHint string

+ Matches []string

+ MessageMenu bool

+ Mode string

+ ModelPicker bool

+ Prompt string

+ QuickOpen bool

+ Quit bool

+ Submitted bool

+ TextInputDialog bool

+ ThemePicker bool

+ TodosOpen bool

+ Transcript bool

+ Value string

+ View string

+ func PreviewInlineWithCandidates(input string, candidates []string, width int, height int, complete bool, ...) Preview

+ func PreviewWithAttachmentNavigation(input string, attachments []string, keys []string, width int, height int) Preview

+ func PreviewWithAttachmentRemoval(input string, attachments []string, width int, height int) Preview

+ func PreviewWithAttachments(input string, attachments []string, width int, height int) Preview

+ func PreviewWithBashHistory(input string, history []string, files []string, width int, height int, ...) Preview

+ func PreviewWithBashMode(input string, width int, height int) Preview

+ func PreviewWithCandidates(input string, candidates []string, width int, height int, complete bool, ...) Preview

+ func PreviewWithCommandView(view CommandView, keys []string, width int, height int) Preview

+ func PreviewWithContextKeybindings(target string, bindings map[string]map[string][]string, keys []string, ...) Preview

+ func PreviewWithDiffDialog(sources []DiffSource, keys []string, width int, height int) Preview

+ func PreviewWithEscape(input string, presses int, width int, height int) Preview

+ func PreviewWithExportDialog(dialog ExportDialog, keys []string, width int, height int) Preview

+ func PreviewWithFileCandidates(input string, files []string, width int, height int, complete bool) Preview

+ func PreviewWithGlobalSearch(input string, files []string, query string, width int, height int, accept bool) Preview

+ func PreviewWithInformation(view InformationView, keys []string, width int, height int) Preview

+ func PreviewWithKeybindings(input string, bindings map[string][]string, files []string, key string, ...) Preview

+ func PreviewWithMessageActionTarget(entries []Entry, width int, height int, action int, targetDelta int) Preview

+ func PreviewWithMessageActions(entries []Entry, width int, height int, action int) Preview

+ func PreviewWithModelPicker(input string, models []string, current string, width int, height int, ...) Preview

+ func PreviewWithPaste(input string, clipboardText string, width int, height int) Preview

+ func PreviewWithPasteAttachment(input string, attachmentPath string, width int, height int) Preview

+ func PreviewWithQueued(input string, queued []string, width int, height int) Preview

+ func PreviewWithQuickOpen(input string, files []string, query string, width int, height int, accept bool) Preview

+ func PreviewWithRuntimeControl(input string, key string, result RuntimeControlResult, width int, height int) Preview

+ func PreviewWithRuntimeToggle(input string, key string, result RuntimeControlResult, width int, height int) Preview

+ func PreviewWithStash(input string, attachments []string, width int, height int) Preview

+ func PreviewWithTextInputDialog(dialog TextInputDialog, keys []string, width int, height int) Preview

+ func PreviewWithTodos(input string, items []TodoItem, width int, height int) Preview

+ func PreviewWithTranscript(entries []Entry, width int, height int) Preview

+ func PreviewWithUndo(input string, inserted string, width int, height int) Preview

+ func PreviewWithVimMode(input string, keys []string, width int, height int) Preview

+ type Question struct

+ Header string

+ MultiSelect bool

+ Options []QuestionOption

+ Question string

+ type QuestionOption struct

+ Description string

+ Label string

+ Preview string

+ type QuestionRequest struct

+ Choices []string

+ Default string

+ Question string

+ Questions []Question

+ type Result struct

+ Attachments []string

+ Prompt string

+ Submitted bool

+ func Prompt() (Result, error)

+ func PromptWithCandidates(candidates []string) (Result, error)

+ func PromptWithCandidatesPrefill(candidates []string, prefill string) (Result, error)

+ type RuntimeControlFunc func(context.Context) (RuntimeControlResult, error)

+ type RuntimeControlResult struct

+ Badges []string

+ Lines []string

+ Setting string

+ Status string

+ Title string

+ Value string

+ VimEnabled *bool

+ type SessionChoice struct

+ BranchName string

+ ID string

+ MessageCount int

+ Tag string

+ Title string

+ UpdatedAt time.Time

+ Workspace string

+ type SessionPickerPreview struct

+ MatchCount int

+ Query string

+ SelectedID string

+ View string

+ func PreviewSessionPicker(choices []SessionChoice, query string, width int, height int, selectMatch bool) SessionPickerPreview

+ type SessionState struct

+ Candidates []string

+ Entries []Entry

+ History []string

+ ID string

+ type ShellOptions struct

+ Background BackgroundFunc

+ Candidates []string

+ CompactSession RuntimeControlFunc

+ ContextKeybindings map[string]map[string][]string

+ CopyConversation RuntimeControlFunc

+ CopyMessage MessageCopyFunc

+ CurrentModel string

+ CycleMode func() string

+ Entries []Entry

+ ExportConversation RuntimeControlFunc

+ ExportConversationTo ConversationExportFunc

+ ExternalEditor ExternalEditorFunc

+ FileCandidates []string

+ ForkConversation ConversationForkFunc

+ FullScreen bool

+ History []string

+ InitialAttachments []string

+ InitialPrompt string

+ Keybindings map[string][]string

+ ModeLabel string

+ ModelOptions []string

+ Paste PasteFunc

+ PermissionAnswer func(string)

+ PermissionRespond func(PermissionResponse)

+ Prefill string

+ QuestionAnswer func(string)

+ ReadModeLabel func() string

+ RestoreConversation ConversationRestoreFunc

+ RuntimeBadges []string

+ SelectModel ModelSelectFunc

+ SelectPermissionMode PermissionModeSelectFunc

+ SelectTheme ThemeSelectFunc

+ Slash SlashFunc

+ StopBackground RuntimeControlFunc

+ Submit SubmitFunc

+ SubmitAttachments SubmitWithAttachmentsFunc

+ SubmitStream StreamSubmitFunc

+ SubmitStreamAttachments StreamSubmitWithAttachmentsFunc

+ SubmitTextInput TextInputSubmitFunc

+ SummarizeConversation ConversationSummarizeFunc

+ SummarizeUpToConversation ConversationSummarizeFunc

+ TaskBoard TaskBoardFunc

+ Theme string

+ Todos TodoListFunc

+ ToggleFast RuntimeControlFunc

+ ToggleThinking RuntimeControlFunc

+ ToggleVim RuntimeControlFunc

+ UndoLast RuntimeControlFunc

+ VimMode bool

+ type SlashFunc func(context.Context, string) (SlashResult, error)

+ type SlashResult struct

+ CommandView *CommandView

+ Diff *DiffView

+ ExportDialog *ExportDialog

+ Handled bool

+ Information *InformationView

+ OpenMessageActions bool

+ OpenModelPicker bool

+ OpenThemePicker bool

+ OpenTodos bool

+ Output string

+ PermissionSettings *PermissionSettings

+ Query string

+ RuntimeAction string

+ Session *SessionState

+ SessionChoices []SessionChoice

+ TextInputDialog *TextInputDialog

+ type StreamSubmitFunc func(context.Context, string, func(Entry)) (string, error)

+ type StreamSubmitWithAttachmentsFunc func(context.Context, string, []string, func(Entry)) (string, error)

+ type SubmitFunc func(context.Context, string) (string, error)

+ type SubmitWithAttachmentsFunc func(context.Context, string, []string) (string, error)

+ type TaskBoardFunc func(context.Context) (string, error)

+ type TextInputDialog struct

+ Action string

+ InitialValue string

+ Prompt string

+ Title string

+ type TextInputSubmitFunc func(context.Context, string, string) (RuntimeControlResult, error)

+ type ThemeSelectFunc func(context.Context, string) (RuntimeControlResult, error)

+ type TodoItem struct

+ ActiveForm string

+ Content string

+ ID string

+ Priority string

+ Status string

+ type TodoListFunc func(context.Context) ([]TodoItem, error)

+ type ToolActivity struct

+ ID string

+ Input string

+ IsError bool

+ Name string

+ Output string

+ Status string

+ type WorkspaceTrustPreview struct

+ SelectedChoice int

+ View string

+ func PreviewWorkspaceTrust(workspace string, width int) WorkspaceTrustPreview

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