readline

package module

Go to main page

Versions in this module

v1

v1.15.1

May 2, 2026

v1.15.0

Apr 27, 2026

v1.14.3

Apr 11, 2026

Changes in this version

+ var CmdRepaintLine = NewGoCommand("REPAINT_LINE", cmdRepaintLine)

v1.14.2

Apr 9, 2026

Changes in this version

type Editor

+ OnAfterRender func(B *Buffer, availWidth int)

v1.14.1

Jan 29, 2026

v1.14.0

Jan 28, 2026

Changes in this version

+ var CmdBackwardKillWord = NewGoCommand("BACKWARD_KILL_WORD", cmdBackwardKillWord)

+ var CmdKillWord = NewGoCommand("KILL_WORD", cmdKillWord)

type Buffer

+ Tty *pendingEscTty

v1.13.0

Nov 28, 2025

Changes in this version

+ var CmdAcceptPredict = NewGoCommand("ACCEPT_PREDICT", cmdAcceptPredict)

+ var CmdForwardCharOrAcceptPredict = NewGoCommand("FORWARD_CHAR_OR_ACCEPT_PREDICT", cmdForwardCharOrAcceptPredict)

v1.12.3

Nov 10, 2025

v1.12.2

Nov 3, 2025

v1.12.1

Nov 2, 2025

v1.12.0

Nov 1, 2025

Changes in this version

type WidthT

+ const ScrollMargin

v1.11.0

Oct 24, 2025

v1.10.0

Oct 17, 2025

v1.9.1

Jun 25, 2025

v1.9.0

Feb 11, 2025

v1.8.0

Feb 9, 2025

Changes in this version

+ type Clipboard interface

+ Read func() (string, error)

+ Write func(string) error

type Editor

+ Clipboard Clipboard

v1.7.4

Jan 28, 2025

Changes in this version

type HighlightColorSequence

+ func HighlightToColorSequence(input string, resetColor, defaultColor string, H []Highlight, N int) *HighlightColorSequence

v1.7.3

Jan 23, 2025

v1.7.2

Jan 21, 2025

Changes in this version

+ type ColorInterface interface

+ Equals func(ColorInterface) bool

type Editor

+ AfterCommand func(*Buffer)

+ type EscapeSequenceId uint

+ func NewEscapeSequenceId(s string) EscapeSequenceId

+ func (e EscapeSequenceId) Equals(other ColorInterface) bool

+ func (e EscapeSequenceId) WriteTo(w io.Writer) (int64, error)

+ type HighlightColorSequence struct

+ ColorMap []EscapeSequenceId

+ Index int

+ ResetSeq EscapeSequenceId

+ func HighlightToColoring(input string, resetColor, defaultColor string, H []Highlight) *HighlightColorSequence

+ func (H *HighlightColorSequence) Init() ColorInterface

+ func (H *HighlightColorSequence) Next(r rune) ColorInterface

v1.7.1

Jan 18, 2025

v1.7.0

Jan 11, 2025

Changes in this version

type ColorSequence

+ func (c ColorSequence) Equals(other colorInterface) bool

type Editor

+ DefaultColor string

+ Highlight []Highlight

+ ResetColor string

+ type Highlight struct

+ Pattern interface{ ... }

+ Sequence string

v1.6.3

Jan 7, 2025

v1.6.2

Nov 19, 2024

v1.6.1

Nov 8, 2024

Changes in this version

+ func GetKeys(tty XTty) ([]string, error)

+ func GetRawKey(tty XTty) (string, error)

v1.6.0

Nov 4, 2024

Changes in this version

+ var PredictColorBlueItalic = [...]string

type Editor

+ Predictor func(*Buffer) string

v1.5.0

Oct 6, 2024

Changes in this version

type Buffer

+ func (B *Buffer) Suffix() []Moji

type Editor

+ PredictColor [2]string

v1.4.1

Oct 2, 2024

Changes in this version

+ func SetZWJSWidthGetter(f func(w1, w2 int) int)

v1.4.0

Jun 16, 2024

v1.3.1

Apr 20, 2024

v1.3.0

Apr 17, 2024

Changes in this version

type ITty

+ GetKey func() (string, error)

v1.2.0

Feb 29, 2024

v1.1.0

Feb 27, 2024

v1.0.1

Oct 8, 2023

v1.0.0

Oct 5, 2023

v0

v0.15.2

Oct 1, 2023

Changes in this version

type ColorSequence

+ func (c ColorSequence) Chain(value ColorSequence) ColorSequence

v0.15.1

Sep 30, 2023

Changes in this version

+ const CursorPositionDummyRune

type ColorSequence

+ func (c ColorSequence) Add(value int) ColorSequence

v0.15.0

Sep 29, 2023

Changes in this version

+ var NameToFunc = map[string]Command

v0.14.1

Sep 13, 2023

Changes in this version

+ type XTty interface

+ Buffered func() bool

+ Raw func() (func() error, error)

+ ReadRune func() (rune, error)

v0.14.0

Aug 28, 2023

Changes in this version

type Buffer

+ func (B *Buffer) RepaintLastLine()

v0.13.2

Jul 29, 2023

v0.13.1

May 28, 2023

Changes in this version

type KeyMap

+ func (km *KeyMap) Lookup(key keys.Code) (Command, bool)

v0.13.0

May 19, 2023

v0.12.3

May 15, 2023

Changes in this version

type Editor

+ func (editor *Editor) Init()

v0.12.2

May 15, 2023

v0.12.1

May 14, 2023

v0.12.0

May 12, 2023

Changes in this version

type Editor

+ LineFeedWriter func(Result, io.Writer) (int, error)

v0.11.7

May 12, 2023

Changes in this version

type Cell

+ func (C Cell) String() string

type Editor

+ func (editor *Editor) LookupCommand(key string) Command

v0.11.6

May 8, 2023

Changes in this version

+ func MojiCountInString(s string) int

v0.11.5

May 6, 2023

Changes in this version

type ColorSequence

+ const ColorReset

+ const DarkDefaultForeGroundColor

v0.11.4

May 6, 2023

v0.11.3

May 5, 2023

Changes in this version

type Editor

+ PromptWriter func(io.Writer) (int, error)

v0.11.2

May 1, 2023

Changes in this version

+ type AnonymousCommand func(context.Context, *Buffer) Result

+ func (f AnonymousCommand) Call(ctx context.Context, B *Buffer) Result

+ func (f AnonymousCommand) String() string

+ type SelfInserter string

+ func (s SelfInserter) Call(ctx context.Context, this *Buffer) Result

+ func (s SelfInserter) String() string

v0.11.1

Apr 27, 2023

Changes in this version

+ var CmdAcceptLine = NewGoCommand("ACCEPT_LINE", cmdAcceptLine)

+ var CmdBackwardChar = NewGoCommand("BACKWARD_CHAR", cmdBackwardChar)

+ var CmdBackwardDeleteChar = NewGoCommand("BACKWARD_DELETE_CHAR", cmdBackwardDeleteChar)

+ var CmdBackwardWord = NewGoCommand("BACKWARD_WORD", cmdBackwardWord)

+ var CmdBeginningOfLine = NewGoCommand("BEGINNING_OF_LINE", cmdBeginningOfLine)

+ var CmdClearScreen = NewGoCommand("CLEAR_SCREEN", cmdClearScreen)

+ var CmdDeleteChar = NewGoCommand("DELETE_CHAR", cmdDeleteChar)

+ var CmdDeleteOrAbort = NewGoCommand("DELETE_OR_ABORT", cmdDeleteOrAbort)

+ var CmdEndOfLine = NewGoCommand("END_OF_LINE", cmdEndOfLine)

+ var CmdForwardChar = NewGoCommand("FORWARD_CHAR", cmdForwardChar)

+ var CmdForwardWord = NewGoCommand("FORWARD_WORD", cmdForwardWord)

+ var CmdISearchBackward = NewGoCommand("ISEARCH_BACKWARD", cmdISearchBackward)

+ var CmdInterrupt = NewGoCommand("INTR", cmdInterrupt)

+ var CmdKillLine = NewGoCommand("KILL_LINE", cmdKillLine)

+ var CmdKillWholeLine = NewGoCommand("KILL_WHOLE_LINE", cmdKillWholeLine)

+ var CmdNextHistory = NewGoCommand("NEXT_HISTORY", cmdNextHistory)

+ var CmdPreviousHistory = NewGoCommand("PREVIOUS_HISTORY", cmdPreviousHistory)

+ var CmdQuotedInsert = NewGoCommand("QUOTED_INSERT", cmdQuotedInsert)

+ var CmdRepaintOnNewline = NewGoCommand("REPAINT_ON_NEWLINE", cmdRepaintOnNewline)

+ var CmdSwapChar = NewGoCommand("SWAPCHAR", cmdSwapChar)

+ var CmdUndo = NewGoCommand("UNDO", cmdUndo)

+ var CmdUnixLineDiscard = NewGoCommand("UNIX_LINE_DISCARD", cmdUnixLineDiscard)

+ var CmdUnixWordRubout = NewGoCommand("UNIX_WORD_RUBOUT", cmdUnixWordRubout)

+ var CmdYank = NewGoCommand("YANK", cmdYank)

+ var CmdYankWithQuote = NewGoCommand("YANK_WITH_QUOTE", cmdYankWithQuote)

+ type Command interface

+ Call func(ctx context.Context, buffer *Buffer) Result

+ String func() string

+ type GoCommand struct

+ Func func(ctx context.Context, buffer *Buffer) Result

+ Name string

+ func NewGoCommand(name string, f func(context.Context, *Buffer) Result) *GoCommand

+ func (K *GoCommand) Call(ctx context.Context, buffer *Buffer) Result

+ func (K GoCommand) String() string

type KeyMap

+ func (km *KeyMap) BindKey(key keys.Code, f Command)

v0.11.0

Apr 26, 2023

Changes in this version

+ func EnableSurrogatePair(value bool)

+ func IsSurrogatePairEnabled() bool

type Editor

+ Tty ITty

+ type ITty interface

+ Buffered func() bool

+ Close func() error

+ GetResizeNotifier func() func() (int, int, bool)

+ Open func() error

+ Raw func() (func() error, error)

+ ReadRune func() (rune, error)

+ Size func() (int, int, error)

v0.10.1

Apr 13, 2023

v0.10.0

Apr 13, 2023

Changes in this version

+ type ColorSequence int64

+ func (c ColorSequence) WriteTo(w io.Writer) (int64, error)

v0.9.1

Apr 10, 2023

v0.9.0

Apr 9, 2023

Changes in this version

+ type Cell struct

+ Moji Moji

type Moji

+ func StringToMoji(s string) []Moji

v0.8.5

Apr 2, 2023

v0.8.4

Mar 24, 2023

Changes in this version

type Editor

+ func (editor *Editor) GetBindKey(key string) KeyFuncT

v0.8.3

Sep 24, 2022

v0.8.2

Aug 12, 2022

v0.8.1

Jun 25, 2022

v0.8.0

Mar 23, 2022

Changes in this version

type Buffer

+ func (B *Buffer) Write(b []byte) (int, error)

v0.7.0

Feb 25, 2022

Changes in this version

+ const DefaultForeGroundColor

v0.6.3

Dec 29, 2021

Changes in this version

+ func SGR1(n1 int) int

+ func SGR2(n1, n2 int) int

+ func SGR3(n1, n2, n3 int) int

+ func SGR4(n1, n2, n3, n4 int) int

type Editor

+ HistoryCycling bool

v0.6.2

Dec 11, 2021

Changes in this version

+ const DarkBlue

+ const DarkCyan

+ const DarkGray

+ const DarkGree

+ const DarkMagenta

+ const DarkRed

+ const DarkWhite

+ const DarkYellow

v0.6.1

Dec 2, 2021

Changes in this version

type Coloring

+ Next func(rune) int

v0.6.0

Nov 27, 2021

Changes in this version

+ const Black

+ const Blue

+ const Cyan

+ const Green

+ const Magenta

+ const Red

+ const White

+ const Yellow

type Buffer

+ func (buf *Buffer) RefreshColor()

+ type Coloring interface

+ Get func(rune) int

+ Init func()

type Editor

+ Coloring Coloring

v0.5.1

Sep 23, 2021

Changes in this version

+ type MinimumTty interface

+ Buffered func() bool

+ Raw func() (func() error, error)

+ ReadRune func() (rune, error)

v0.5.0

Sep 12, 2021

Changes in this version

+ const F_ACCEPT_LINE

+ const F_BACKWARD_CHAR

+ const F_BACKWARD_DELETE_CHAR

+ const F_BACKWARD_WORD

+ const F_BEGINNING_OF_LINE

+ const F_CLEAR_SCREEN

+ const F_DELETE_CHAR

+ const F_DELETE_OR_ABORT

+ const F_END_OF_LINE

+ const F_FORWARD_CHAR

+ const F_FORWARD_WORD

+ const F_HISTORY_DOWN

+ const F_HISTORY_UP

+ const F_INTR

+ const F_ISEARCH_BACKWARD

+ const F_KILL_LINE

+ const F_KILL_WHOLE_LINE

+ const F_NEXT_HISTORY

+ const F_PASS

+ const F_PREVIOUS_HISTORY

+ const F_QUOTED_INSERT

+ const F_REPAINT_ON_NEWLINE

+ const F_SWAPCHAR

+ const F_UNDO

+ const F_UNIX_LINE_DISCARD

+ const F_UNIX_WORD_RUBOUT

+ const F_YANK

+ const F_YANK_WITH_QUOTE

+ const K_ALT_A

+ const K_ALT_B

+ const K_ALT_BACKSPACE

+ const K_ALT_BREAK

+ const K_ALT_C

+ const K_ALT_D

+ const K_ALT_E

+ const K_ALT_F

+ const K_ALT_G

+ const K_ALT_H

+ const K_ALT_I

+ const K_ALT_J

+ const K_ALT_K

+ const K_ALT_L

+ const K_ALT_M

+ const K_ALT_N

+ const K_ALT_O

+ const K_ALT_OEM_2

+ const K_ALT_P

+ const K_ALT_Q

+ const K_ALT_R

+ const K_ALT_S

+ const K_ALT_T

+ const K_ALT_U

+ const K_ALT_V

+ const K_ALT_W

+ const K_ALT_X

+ const K_ALT_Y

+ const K_ALT_Z

+ const K_BACKSPACE

+ const K_CAPSLOCK

+ const K_CLEAR

+ const K_CTRL

+ const K_CTRL_A

+ const K_CTRL_B

+ const K_CTRL_BACKSLASH

+ const K_CTRL_BREAK

+ const K_CTRL_C

+ const K_CTRL_CARET

+ const K_CTRL_D

+ const K_CTRL_DOWN

+ const K_CTRL_E

+ const K_CTRL_F

+ const K_CTRL_G

+ const K_CTRL_H

+ const K_CTRL_I

+ const K_CTRL_J

+ const K_CTRL_K

+ const K_CTRL_L

+ const K_CTRL_LBRACKET

+ const K_CTRL_LEFT

+ const K_CTRL_M

+ const K_CTRL_N

+ const K_CTRL_O

+ const K_CTRL_P

+ const K_CTRL_Q

+ const K_CTRL_R

+ const K_CTRL_RBRACKET

+ const K_CTRL_RIGHT

+ const K_CTRL_S

+ const K_CTRL_T

+ const K_CTRL_U

+ const K_CTRL_UNDERBAR

+ const K_CTRL_UP

+ const K_CTRL_V

+ const K_CTRL_W

+ const K_CTRL_X

+ const K_CTRL_Y

+ const K_CTRL_Z

+ const K_DELETE

+ const K_DOWN

+ const K_END

+ const K_ENTER

+ const K_ESCAPE

+ const K_F1

+ const K_F10

+ const K_F11

+ const K_F12

+ const K_F13

+ const K_F14

+ const K_F15

+ const K_F16

+ const K_F17

+ const K_F18

+ const K_F19

+ const K_F2

+ const K_F20

+ const K_F21

+ const K_F22

+ const K_F23

+ const K_F24

+ const K_F3

+ const K_F4

+ const K_F5

+ const K_F6

+ const K_F7

+ const K_F8

+ const K_F9

+ const K_HOME

+ const K_LEFT

+ const K_PAGEDOWN

+ const K_PAGEUP

+ const K_PAUSE

+ const K_RIGHT

+ const K_SHIFT

+ const K_UP

+ var CtrlC = (errors.New("^C"))

+ var Delimiters = "\"'"

+ var ModifierSequenceOk = isWindowsTerminal

+ var SurrogatePairOk = isWindowsTerminal

+ var VariationSequenceOk = isWindowsTerminal

+ var ZeroWidthJoinSequenceOk = isWindowsTerminal

+ func GetKey(tty1 KeyGetter) (string, error)

+ func ResetCharWidth()

+ func SetCharWidth(c rune, width int)

+ type Buffer struct

+ Buffer []Moji

+ ViewStart int

+ func (B *Buffer) CurrentWord() (string, int)

+ func (B *Buffer) CurrentWordTop() (wordTop int)

+ func (B *Buffer) Delete(pos int, n int) WidthT

+ func (B *Buffer) GetKey() (string, error)

+ func (B *Buffer) GetWidthBetween(from int, to int) WidthT

+ func (B *Buffer) InsertString(pos int, s string) int

+ func (B *Buffer) ResetViewStart()

+ func (B *Buffer) SubString(start, end int) string

+ func (B *Buffer) ViewWidth() WidthT

+ func (B Buffer) String() string

+ func (buf *Buffer) DrawFromHead()

+ func (buf *Buffer) GotoHead()

+ func (buf *Buffer) InsertAndRepaint(str string)

+ func (buf *Buffer) Repaint(pos int, del WidthT)

+ func (buf *Buffer) RepaintAfterPrompt()

+ func (buf *Buffer) RepaintAll()

+ func (buf *Buffer) ReplaceAndRepaint(pos int, str string)

+ type Editor struct

+ Cursor int

+ Default string

+ History IHistory

+ LineFeed func(Result)

+ OpenKeyGetter func() (KeyGetter, error)

+ Out *bufio.Writer

+ Prompt func() (int, error)

+ Writer io.Writer

+ func (editor *Editor) ReadLine(ctx context.Context) (string, error)

+ type IHistory interface

+ At func(int) string

+ Len func() int

+ type KeyFuncT interface

+ Call func(ctx context.Context, buffer *Buffer) Result

+ func GetFunc(funcName string) (KeyFuncT, error)

+ type KeyGetter interface

+ Buffered func() bool

+ Close func() error

+ GetResizeNotifier func() func() (int, int, bool)

+ Raw func() (func() error, error)

+ ReadRune func() (rune, error)

+ Size func() (int, int, error)

+ func NewDefaultTty() (KeyGetter, error)

+ type KeyGoFuncT struct

+ Func func(ctx context.Context, buffer *Buffer) Result

+ Name string

+ func (K *KeyGoFuncT) Call(ctx context.Context, buffer *Buffer) Result

+ func (K KeyGoFuncT) String() string

+ type KeyMap struct

+ KeyMap map[string]KeyFuncT

+ var GlobalKeyMap KeyMap

+ func (editor *KeyMap) BindKeyClosure(name string, f func(context.Context, *Buffer) Result) error

+ func (editor *KeyMap) BindKeyFunc(key string, f KeyFuncT) error

+ func (editor *KeyMap) BindKeySymbol(keyName, funcName string) error

+ func (editor *KeyMap) GetBindKey(key string) KeyFuncT

+ type Moji interface

+ PrintTo func(io.Writer)

+ Width func() WidthT

+ WriteTo func(io.Writer) (int64, error)

+ type Result int

+ const ABORT

+ const CONTINUE

+ const ENTER

+ const INTR

+ func (R Result) String() string

+ type WidthT int

+ func GetCharWidth(n rune) WidthT

+ func GetStringWidth(s string) WidthT

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