Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

menu

package module

Go to main page

Versions in this module

v0

v0.1.3

Sep 7, 2026

Changes in this version

+ type RunOptions struct

+ Input chan string

+ Output chan string

v0.1.2

Sep 7, 2026

v0.1.1

Aug 4, 2026

Changes in this version

type Keybind

+ const KeyAltA

+ const KeyAltB

+ const KeyAltC

+ const KeyAltD

+ const KeyAltE

+ const KeyAltF

+ const KeyAltG

+ const KeyAltH

+ const KeyAltI

+ const KeyAltJ

+ const KeyAltK

+ const KeyAltL

+ const KeyAltM

+ const KeyAltN

+ const KeyAltO

+ const KeyAltP

+ const KeyAltQ

+ const KeyAltR

+ const KeyAltS

+ const KeyAltT

+ const KeyAltU

+ const KeyAltV

+ const KeyAltW

+ const KeyAltX

+ const KeyAltY

+ const KeyAltZ

+ const KeyBTab

+ const KeyCtrlB

+ const KeyCtrlC

+ const KeyCtrlD

+ const KeyCtrlF

+ const KeyCtrlG

+ const KeyCtrlH

+ const KeyCtrlI

+ const KeyCtrlJ

+ const KeyCtrlM

+ const KeyCtrlN

+ const KeyCtrlP

+ const KeyCtrlQ

+ const KeyCtrlS

+ const KeyCtrlT

+ const KeyCtrlU

+ const KeyCtrlV

+ const KeyCtrlX

+ const KeyCtrlZ

+ const KeyDown

+ const KeyEnd

+ const KeyEsc

+ const KeyF1

+ const KeyF10

+ const KeyF11

+ const KeyF12

+ const KeyF2

+ const KeyF3

+ const KeyF4

+ const KeyF5

+ const KeyF6

+ const KeyF7

+ const KeyF8

+ const KeyF9

+ const KeyHome

+ const KeyLeft

+ const KeyPgDn

+ const KeyPgUp

+ const KeyRight

+ const KeyShiftDown

+ const KeyShiftLeft

+ const KeyShiftRight

+ const KeyShiftUp

+ const KeySpace

+ const KeyUp

type Keymap

+ func (k *Keymap) String() string

+ func (k *Keymap) WithBecome(cmd string) *Keymap

+ func (k *Keymap) WithCommand(cmd string) *Keymap

v0.1.0

Jul 31, 2026

Changes in this version

+ const ExitSuccess

+ var ErrActionAborted = errors.New("action aborted: code 130")

+ var ErrArgEmpty = errors.New("argument cannot be empty")

+ var ErrFzf = errors.New("error: code 2")

+ var ErrInvalidConfigKeymap = errors.New("invalid keymap")

+ var ErrInvalidConfigSettings = errors.New("invalid settings")

+ var ErrInvalidHeaderArg = errors.New("invalid header argument")

+ var ErrInvalidShellCommand = errors.New("invalid shell command for become action: code 126")

+ var ErrNoItems = errors.New("no items found")

+ var ErrNoMatching = errors.New("no matching record: code 1")

+ var ErrPermissionDenied = errors.New("permission denied from become action: code 127")

+ func Select[T any](items []T, opts ...Option) ([]T, error)

+ type Args []string

+ func (a Args) Validate() error

+ type ArgsBuilder struct

+ func NewArgsBuilder() *ArgsBuilder

+ func (a *ArgsBuilder) Add(s ...string) *ArgsBuilder

+ func (a *ArgsBuilder) Build() Args

+ func (a *ArgsBuilder) Custom(s ...string) *ArgsBuilder

+ func (a *ArgsBuilder) Parse() error

+ func (a *ArgsBuilder) String() string

+ func (a *ArgsBuilder) Validate() error

+ func (a *ArgsBuilder) WithAnsi() *ArgsBuilder

+ func (a *ArgsBuilder) WithBorder(b Border) *ArgsBuilder

+ func (a *ArgsBuilder) WithBorderLabel(s string) *ArgsBuilder

+ func (a *ArgsBuilder) WithColor(target string, styles ...string) *ArgsBuilder

+ func (a *ArgsBuilder) WithCycle() *ArgsBuilder

+ func (a *ArgsBuilder) WithFooter(footer string) *ArgsBuilder

+ func (a *ArgsBuilder) WithFooterBorder(b Border) *ArgsBuilder

+ func (a *ArgsBuilder) WithHeader(s string) *ArgsBuilder

+ func (a *ArgsBuilder) WithHeaderBorder(b Border) *ArgsBuilder

+ func (a *ArgsBuilder) WithHeight(s string) *ArgsBuilder

+ func (a *ArgsBuilder) WithHighlightLine() *ArgsBuilder

+ func (a *ArgsBuilder) WithInfo(is InfoStyle) *ArgsBuilder

+ func (a *ArgsBuilder) WithLayout(l Layout) *ArgsBuilder

+ func (a *ArgsBuilder) WithMultiSelection() *ArgsBuilder

+ func (a *ArgsBuilder) WithNoColor() *ArgsBuilder

+ func (a *ArgsBuilder) WithNoScrollbar() *ArgsBuilder

+ func (a *ArgsBuilder) WithNth(idx ...string) *ArgsBuilder

+ func (a *ArgsBuilder) WithPointer(s string) *ArgsBuilder

+ func (a *ArgsBuilder) WithPreview(s string) *ArgsBuilder

+ func (a *ArgsBuilder) WithPreviewBorder(b Border) *ArgsBuilder

+ func (a *ArgsBuilder) WithPreviewWindow(s string) *ArgsBuilder

+ func (a *ArgsBuilder) WithPrompt(s string) *ArgsBuilder

+ func (a *ArgsBuilder) WithSync() *ArgsBuilder

+ func (a *ArgsBuilder) WithTac() *ArgsBuilder

+ type Border string

+ const BorderBlock

+ const BorderBold

+ const BorderBottom

+ const BorderDashed

+ const BorderDouble

+ const BorderHorizontal

+ const BorderLeft

+ const BorderLine

+ const BorderNone

+ const BorderRight

+ const BorderRounded

+ const BorderSharp

+ const BorderThinblock

+ const BorderTop

+ const BorderVertical

+ func (b Border) Arg(s string) string

+ type ColorValue string

+ const AttributeBold

+ const AttributeDim

+ const AttributeItalic

+ const AttributeRegular

+ const AttributeReverse

+ const AttributeStrikethrough

+ const AttributeStrip

+ const AttributeUnderline

+ const AttributeUnderlineCurly

+ const AttributeUnderlineDashed

+ const AttributeUnderlineDotted

+ const AttributeUnderlineDouble

+ const ColorBlack

+ const ColorBlue

+ const ColorBrightBlack

+ const ColorBrightBlue

+ const ColorBrightCyan

+ const ColorBrightGreen

+ const ColorBrightMagenta

+ const ColorBrightRed

+ const ColorBrightWhite

+ const ColorBrightYellow

+ const ColorCyan

+ const ColorDefault

+ const ColorGreen

+ const ColorMagenta

+ const ColorRed

+ const ColorWhite

+ const ColorYellow

+ type FmtFunc func(item T) string

+ type InfoStyle string

+ const InfoStyleDefault

+ const InfoStyleHidden

+ const InfoStyleInline

+ const InfoStyleInlineRight

+ const InfoStyleRight

+ type Items struct

+ Formatter FmtFunc[T]

+ type Keybind string

+ const KeyCtrlA

+ const KeyCtrlE

+ const KeyCtrlK

+ const KeyCtrlL

+ const KeyCtrlO

+ const KeyCtrlR

+ const KeyCtrlSlash

+ const KeyCtrlW

+ const KeyCtrlY

+ const KeyEnter

+ const KeyTab

+ type KeybindAction string

+ const KeybindActionAbort

+ const KeybindActionAccept

+ const KeybindActionChangePreviewWindow

+ const KeybindActionDeselectAll

+ const KeybindActionDown

+ const KeybindActionFirst

+ const KeybindActionHalfPageDown

+ const KeybindActionHalfPageUp

+ const KeybindActionLast

+ const KeybindActionPageDown

+ const KeybindActionPageUp

+ const KeybindActionPreviewDown

+ const KeybindActionPreviewHalfPageDown

+ const KeybindActionPreviewHalfPageUp

+ const KeybindActionPreviewPageDown

+ const KeybindActionPreviewPageUp

+ const KeybindActionPreviewUp

+ const KeybindActionSelect

+ const KeybindActionSelectAll

+ const KeybindActionToggle

+ const KeybindActionToggleAll

+ const KeybindActionTogglePreview

+ const KeybindActionUp

+ type Keymap struct

+ Action KeybindAction

+ Args Args

+ Bind Keybind

+ Desc string

+ Enabled bool

+ Hidden bool

+ func KeymapToggleAll() *Keymap

+ func KeymapTogglePreview() *Keymap

+ func NewKeymap() *Keymap

+ func (k *Keymap) Arguments() []string

+ func (k *Keymap) BindString() string

+ func (k *Keymap) Hide() *Keymap

+ func (k *Keymap) IsEnabled() bool

+ func (k *Keymap) WithArgs(fn func(b *ArgsBuilder) *ArgsBuilder) *Keymap

+ func (k *Keymap) WithBind(b Keybind) *Keymap

+ func (k *Keymap) WithBuiltinAction(cmd KeybindAction) *Keymap

+ func (k *Keymap) WithDesc(s string) *Keymap

+ func (k *Keymap) WithEnabled(b bool) *Keymap

+ func (k *Keymap) WithExecute(cmd string) *Keymap

+ func (k *Keymap) WithSilentExecute(cmd string) *Keymap

+ type KeymapFormatter func(bind, sep, desc string) string

+ type KeymapManager struct

+ func NewKeymapManager() *KeymapManager

+ func (km *KeymapManager) Find(bind *Keymap) *Keymap

+ func (km *KeymapManager) Len() int

+ func (km *KeymapManager) List() []*Keymap

+ func (km *KeymapManager) NewKeymap() *Keymap

+ func (km *KeymapManager) Register(keys ...*Keymap)

+ func (km *KeymapManager) Remove(k *Keymap)

+ type Layout string

+ const LayoutDefault

+ const LayoutReverse

+ const LayoutReverseList

+ type Menu struct

+ func New[T any](opts ...Option) *Menu[T]

+ func (m *Menu[T]) Select(items []T) ([]T, error)

+ func (m *Menu[T]) SetFormatter(preprocessor FmtFunc[T])

+ func (m *Menu[T]) SetInterruptFn(fn func(error))

+ func (m Menu[T]) Validate() error

+ type MenuRunner interface

+ Parse func(defaults bool, args Args) (*fzf.Options, error)

+ Run func(options *fzf.Options) (int, error)

+ type Option func(*Options)

+ func WithAnsi() Option

+ func WithArgs(fn func(b *ArgsBuilder) *ArgsBuilder) Option

+ func WithArgsCustom(args ...string) Option

+ func WithBorder(b Border) Option

+ func WithBorderLabel(s string) Option

+ func WithColor(target string, values ...ColorValue) Option

+ func WithCycle() Option

+ func WithDefaults(b bool) Option

+ func WithFooter(footer string) Option

+ func WithFooterBorder(b Border) Option

+ func WithHeader(header string) Option

+ func WithHeaderBorder(b Border) Option

+ func WithHeaderFirst() Option

+ func WithHeaderKeymapFmt(fn KeymapFormatter) Option

+ func WithHeaderKeymaps() Option

+ func WithHeaderLabel(s string) Option

+ func WithHeaderSeparator(sep string) Option

+ func WithHeaderSeparatorFmt(fn SeparatorFormatter) Option

+ func WithHeight(s string) Option

+ func WithInfo(is InfoStyle) Option

+ func WithInterruptFn(fn func(error)) Option

+ func WithKeybinds(keys ...*Keymap) Option

+ func WithLayout(l Layout) Option

+ func WithMultiSelection() Option

+ func WithMultilineView() Option

+ func WithNoOutputColor() Option

+ func WithNoScrollbar() Option

+ func WithNth(idx ...string) Option

+ func WithOutputColor(b bool) Option

+ func WithPointer(s string) Option

+ func WithPreviewBorder(b Border) Option

+ func WithPreviewCmd(cmd string) Option

+ func WithPreviewWindow(args string) Option

+ func WithPrompt(s string) Option

+ func WithRunner(r MenuRunner) Option

+ func WithSync() Option

+ func WithTac() Option

+ func WithoutHeader(b bool) Option

+ type Options struct

+ type SeparatorFormatter func(sep string) string