api

Feb 10, 2026

Changes in this version

+ var ErrMissingClient = errors.New(...)

type CmdModule

+ func (c *CmdModule) Pid(id *janet.Value) (*int, error)

Jan 18, 2026

Changes in this version

+ type ExecContext struct

+ SourceNode *tree.NodeID

Aug 12, 2025

Changes in this version

+ var DOCS_CLIPBOARD string

+ var KEYWORD_PERSIST = janet.Keyword("persist")

type Client

+ Clipboard func() clipboard.Clipboard

+ type ClipboardModule struct

+ Clipboard clipboard.Clipboard

+ func (c *ClipboardModule) Documentation() string

+ func (c *ClipboardModule) Get(context interface{}) (string, error)

+ func (c *ClipboardModule) Set(context interface{}, text string) error

type CmdModule

+ func (c *CmdModule) Title(id *janet.Value) (*string, error)

type ParamModule

+ PersistentStore *params.PersistentStore

Aug 8, 2025

Changes in this version

type InputModule

+ func (i *InputModule) Renames() map[string]string

+ func (i *InputModule) Thumbs(ctx context.Context, context interface{}, named *janet.Named[ThumbsParams]) (interface{}, error)

+ func (i *InputModule) ThumbsDefaultPatterns(ctx context.Context) []string

type PaneModule

+ func (p *PaneModule) SendText(id *janet.Value, text string) error

type TextParams

+ Single bool

+ type ThumbsParams struct

+ Alphabet *string

+ Patterns *[]string

Nov 8, 2024

Changes in this version

+ var DOCS_REGISTER string

+ type RegisterModule struct

+ Registers Registers

+ func (c *RegisterModule) Documentation() string

+ func (c *RegisterModule) Get(register string) (string, error)

+ func (c *RegisterModule) Set(register string, text string) error

+ type Registers interface

+ Get func(register string) (string, error)

+ GetAll func() (map[string]string, error)

+ Set func(register string, text string) error

Oct 20, 2024

Changes in this version

type ParamModule

+ Server Server

type Server

+ RerenderClients func()

Oct 3, 2024

Changes in this version

+ var DOCS_COLORMAPS string

type CmdModule

+ func (c *CmdModule) Kill(id *janet.Value) error

+ type ColorMapsModule struct

+ func (c *ColorMapsModule) GetAll() []colormaps.Scheme

+ func (t *ColorMapsModule) Documentation() string

type TreeModule

+ func (t *TreeModule) Rm(id *janet.Value) error

Sep 18, 2024

Changes in this version

+ var DOCS_TIME string

type CmdModule

+ Store CommandStore

+ func (c *CmdModule) Query() ([]C.CommandEvent, error)

+ type CommandStore interface

+ OpenDatabases func([]string) error

+ QueryCommands func(context.Context) ([]C.CommandEvent, error)

type FuzzyParams

+ Height *int

+ Width *int

+ type OpenBorgParams struct

+ AltScreen *bool

+ Focus *geom.Vec2

+ Highlights *[]search.Selection

type ReplayParams

+ AltScreen *bool

+ Focus *geom.Vec2

+ type TimeModule struct

+ func (t *TimeModule) Documentation() string

+ func (t *TimeModule) Format(ts time.Time, layout string) string

+ func (t *TimeModule) Now() time.Time

Sep 6, 2024

Changes in this version

+ var DOCS_SEARCH string

+ var KEYWORD_SEARCH = janet.Keyword("search")

type KeyModule

+ SearchBinds *bind.BindScope

+ type SearchModule struct

+ CopyBinds *bind.BindScope

+ Lifetime util.Lifetime

+ SearchBinds *bind.BindScope

+ TimeBinds *bind.BindScope

+ Tree *tree.Tree

+ func (m *SearchModule) Cancel(context interface{}) error

+ func (m *SearchModule) First(context interface{}) error

+ func (m *SearchModule) FocusInput(context interface{}) error

+ func (m *SearchModule) Last(context interface{}) error

+ func (m *SearchModule) New(groupId *janet.Value, query string, named *janet.Named[SearchParams]) (tree.NodeID, error)

+ func (m *SearchModule) Next(context interface{}) error

+ func (m *SearchModule) Prev(context interface{}) error

+ func (s *SearchModule) Documentation() string

+ type SearchParams struct

+ Files []string

+ Workers *int

Aug 21, 2024

Changes in this version

type CmdModule

+ Server Server

type PaneModule

+ func (p *PaneModule) SendKeys(id *janet.Value, keys []string) error

type Server

+ SocketName func() string

Aug 7, 2024

Changes in this version

+ var DOCS_STYLE string

+ type StyleModule struct

+ func (s *StyleModule) Documentation() string

+ func (s *StyleModule) Render(style *style.Style, text string) string

Aug 3, 2024

Changes in this version

type FuzzyParams

+ CaseSensitive bool

Aug 1, 2024

Changes in this version

+ var DOCS_LAYOUT string

type Client

+ GetLayout func() layout.Layout

+ SetLayout func(layout.Layout) error

type CmdParams

+ Restart bool

+ type LayoutModule struct

+ func (l *LayoutModule) Documentation() string

+ func (l *LayoutModule) Get(user interface{}) (*layout.Layout, error)

+ func (l *LayoutModule) Set(user interface{}, value *janet.Value) error

Jul 21, 2024

Changes in this version

type ViewportModule

+ func (c *ViewportModule) GetAnimations(context interface{}) []string

Jul 20, 2024

Changes in this version

type InputModule

+ func (i *InputModule) Text(ctx context.Context, user interface{}, prompt string, ...) (interface{}, error)

+ type TextParams struct

+ Animated *bool

+ Full bool

+ Placeholder *string

+ Preset *string

+ Reverse bool

Jul 19, 2024

Changes in this version

+ var DOCS_MSG string

+ var DOCS_PARAM string

+ var KEYWORD_CLIENT = janet.Keyword("client")

+ var KEYWORD_ERROR = janet.Keyword("error")

+ var KEYWORD_INFO = janet.Keyword("info")

+ var KEYWORD_WARN = janet.Keyword("warn")

type Client

+ HistoryBackward func() error

+ HistoryForward func() error

+ Toast func(toasts.Toast)

type GroupModule

+ func (g *GroupModule) Mkdir(parentId *janet.Value, path string) (tree.NodeID, error)

+ type MsgModule struct

+ Server Server

+ func (m *MsgModule) Documentation() string

+ func (m *MsgModule) Log(level *janet.Value, text string) error

+ func (m *MsgModule) Toast(context interface{}, level *janet.Value, message string) error

type PaneModule

+ func (p *PaneModule) HistoryBackward(context interface{}) error

+ func (p *PaneModule) HistoryForward(context interface{}) error

+ type ParamModule struct

+ Tree *tree.Tree

+ func (p *ParamModule) Documentation() string

+ func (p *ParamModule) Get(context interface{}, key *janet.Value, named *janet.Named[ParamParams]) (interface{}, error)

+ func (p *ParamModule) Set(context interface{}, target *janet.Value, key *janet.Value, value *janet.Value) error

+ type ParamParams struct

+ Target *janet.Value

type ReplayModule

+ func (m *ReplayModule) OpenFile(groupId *janet.Value, path string) (tree.NodeID, error)

+ type ReplayParams struct

+ Copy bool

+ Location *geom.Vec2

+ Main bool

type Server

+ Log func(level zerolog.Level, message string)

Jul 7, 2024

Changes in this version

type ReplayModule

+ func (m *ReplayModule) BigWordBackward(context interface{}) error

+ func (m *ReplayModule) BigWordEndBackward(context interface{}) error

+ func (m *ReplayModule) BigWordEndForward(context interface{}) error

+ func (m *ReplayModule) BigWordForward(context interface{}) error

+ func (m *ReplayModule) CommandSelectBackward(context interface{}) error

+ func (m *ReplayModule) CommandSelectForward(context interface{}) error

+ func (m *ReplayModule) WordBackward(context interface{}) error

+ func (m *ReplayModule) WordEndBackward(context interface{}) error

+ func (m *ReplayModule) WordEndForward(context interface{}) error

+ func (m *ReplayModule) WordForward(context interface{}) error

Jun 26, 2024

Changes in this version

+ var KEYWORD_COPY = janet.Keyword("copy")

+ var KEYWORD_TIME = janet.Keyword("time")

+ type BindParams struct

+ Tag string

type Binding

+ Tag string

type CmdModule

+ CopyBinds *bind.BindScope

+ TimeBinds *bind.BindScope

type KeyModule

+ CopyBinds *bind.BindScope

+ TimeBinds *bind.BindScope

type ReplayModule

+ CopyBinds *bind.BindScope

+ TimeBinds *bind.BindScope

Jun 16, 2024

Changes in this version

+ var DOCS_EXEC string

type CmdModule

+ func (c *CmdModule) Commands(id *janet.Value) (*[]detect.Command, error)

+ type ExecModule struct

+ Server Server

+ func (e *ExecModule) File(path string) error

+ func (i *ExecModule) Documentation() string

type PaneModule

+ func (p *PaneModule) Screen(id *janet.Value) ([]string, error)

type ReplayModule

+ func (m *ReplayModule) CommandBackward(context interface{}) error

+ func (m *ReplayModule) CommandForward(context interface{}) error

+ func (m *ReplayModule) EndOfLine(context interface{}) error

+ func (m *ReplayModule) EndOfScreenLine(context interface{}) error

+ func (m *ReplayModule) FirstNonBlank(context interface{}) error

+ func (m *ReplayModule) FirstNonBlankScreen(context interface{}) error

+ func (m *ReplayModule) LastNonBlank(context interface{}) error

+ func (m *ReplayModule) LastNonBlankScreen(context interface{}) error

+ func (m *ReplayModule) MiddleOfLine(context interface{}) error

+ func (m *ReplayModule) MiddleOfScreenLine(context interface{}) error

+ func (m *ReplayModule) StartOfLine(context interface{}) error

+ func (m *ReplayModule) StartOfScreenLine(context interface{}) error

+ func (m *ReplayModule) SwapScreen(context interface{}) error

+ type Server interface

+ ExecuteJanet func(path string) error

Feb 9, 2024

Changes in this version

+ type Binding struct

+ Function *janet.Value

+ Node tree.NodeID

+ Sequence []string

+ func NewBinding(node tree.Node, leaf trie.Leaf[bind.Action]) Binding

type Client

+ Binds func() []Binding

type FuzzyParams

+ Headers *[]string

type KeyModule

+ func (k *KeyModule) Current(user interface{}) []Binding

+ func (k *KeyModule) Get(target *janet.Value) ([]Binding, error)

+ func (k *KeyModule) Remap(target *janet.Value, from, to *janet.Value) error

+ func (k *KeyModule) Unbind(target *janet.Value, sequence *janet.Value) error

Jan 16, 2024

Changes in this version

+ var DOCS_CMD string

type Client

+ Get func(key string) (value interface{}, ok bool)

+ type CmdModule struct

+ Lifetime util.Lifetime

+ ReplayBinds *bind.BindScope

+ Tree *tree.Tree

+ func (c *CmdModule) New(user interface{}, groupId *janet.Value, cmdParams *janet.Named[CmdParams]) (tree.NodeID, error)

+ func (c *CmdModule) Path(id *janet.Value) (*string, error)

+ func (i *CmdModule) Documentation() string

type CmdParams

+ Path string

Dec 16, 2023

Changes in this version

+ var DOCS_GROUP string

+ var DOCS_INPUT string

+ var DOCS_KEY string

+ var DOCS_PANE string

+ var DOCS_PATH string

+ var DOCS_REPLAY string

+ var DOCS_TREE string

+ var DOCS_VIEWPORT string

+ var KEYWORD_RE = janet.Keyword("re")

+ var KEYWORD_REPLAY = janet.Keyword("replay")

+ var KEYWORD_ROOT = janet.Keyword("root")

type Client

+ Frame func() *frames.Framer

+ Margins func() *screen.Margins

+ OuterLayers func() *screen.Layers

+ Params func() *params.Parameters

type Cmd

+ ReplayBinds *bind.BindScope

+ type FuzzyParams struct

+ Animated *bool

+ Full bool

+ Prompt string

+ Reverse bool

type GroupModule

+ func (g *GroupModule) Leaves(parentId tree.NodeID) ([]tree.NodeID, error)

+ func (i *GroupModule) Documentation() string

+ type InputModule struct

+ Lifetime util.Lifetime

+ Server *server.Server

+ Tree *tree.Tree

+ func (i *InputModule) Documentation() string

+ func (i *InputModule) Find(ctx context.Context, user interface{}, choices *janet.Value, ...) (interface{}, error)

+ type KeyModule struct

+ ReplayBinds *bind.BindScope

+ Tree *tree.Tree

+ func (i *KeyModule) Documentation() string

+ func (k *KeyModule) Bind(target *janet.Value, sequence *janet.Value, callback *janet.Function) error

type PaneModule

+ func (i *PaneModule) Documentation() string

type PathModule

+ func (i *PathModule) Documentation() string

+ func (p *PathModule) Glob(pattern string) ([]string, error)

type ReplayModule

+ Binds *bind.BindScope

+ Lifetime util.Lifetime

+ Tree *tree.Tree

+ func (i *ReplayModule) Documentation() string

+ func (m *ReplayModule) JumpAgain(context interface{}) error

+ func (m *ReplayModule) JumpBackward(context interface{}, char string) error

+ func (m *ReplayModule) JumpForward(context interface{}, char string) error

+ func (m *ReplayModule) JumpReverse(context interface{}) error

+ func (m *ReplayModule) JumpToBackward(context interface{}, char string) error

+ func (m *ReplayModule) JumpToForward(context interface{}, char string) error

+ func (m *ReplayModule) Open(groupId tree.NodeID, path string) (tree.NodeID, error)

type TreeModule

+ func (i *TreeModule) Documentation() string

+ func (t *TreeModule) Path(id tree.NodeID) *string

+ type ViewportModule struct

+ func (c *ViewportModule) GetFrames(context interface{}) []string

+ func (c *ViewportModule) SetFrame(context interface{}, name string)

+ func (c *ViewportModule) SetSize(context interface{}, size geom.Size)

+ func (c *ViewportModule) Size(context interface{}) *geom.Vec2

+ func (i *ViewportModule) Documentation() string

Nov 2, 2023

Changes in this version

+ type ReplayModule struct

+ func (m *ReplayModule) Beginning(context interface{}) error

+ func (m *ReplayModule) Copy(context interface{}) error

+ func (m *ReplayModule) CursorDown(context interface{}) error

+ func (m *ReplayModule) CursorLeft(context interface{}) error

+ func (m *ReplayModule) CursorRight(context interface{}) error

+ func (m *ReplayModule) CursorUp(context interface{}) error

+ func (m *ReplayModule) End(context interface{}) error

+ func (m *ReplayModule) HalfPageDown(context interface{}) error

+ func (m *ReplayModule) HalfPageUp(context interface{}) error

+ func (m *ReplayModule) Quit(context interface{}) error

+ func (m *ReplayModule) ScrollDown(context interface{}) error

+ func (m *ReplayModule) ScrollUp(context interface{}) error

+ func (m *ReplayModule) SearchAgain(context interface{}) error

+ func (m *ReplayModule) SearchBackward(context interface{}) error

+ func (m *ReplayModule) SearchForward(context interface{}) error

+ func (m *ReplayModule) SearchReverse(context interface{}) error

+ func (m *ReplayModule) Select(context interface{}) error

+ func (m *ReplayModule) TimePlay(context interface{}) error

+ func (m *ReplayModule) TimePlaybackRate(context interface{}, rate int) error

+ func (m *ReplayModule) TimeStepBack(context interface{}) error

+ func (m *ReplayModule) TimeStepForward(context interface{}) error

Sep 21, 2023

Changes in this version

type TreeModule

+ func (t *TreeModule) Kill(id tree.NodeID) error

Sep 11, 2023

Changes in this version

+ type Client interface

+ Attach func(tree.Node) error

+ Node func() tree.Node

+ type Cmd struct

+ Lifetime util.Lifetime

+ Tree *tree.Tree

+ func (c *Cmd) New(groupId tree.NodeID, path string, params *janet.Named[CmdParams]) (tree.NodeID, error)

+ func (c *Cmd) Path(id tree.NodeID) (*string, error)

+ type CmdParams struct

+ Args []string

+ Command string

+ Name string

+ type GroupModule struct

+ Tree *tree.Tree

+ func (g *GroupModule) Children(parentId tree.NodeID) ([]tree.NodeID, error)

+ func (g *GroupModule) New(parentId tree.NodeID, params *janet.Named[NodeParams]) (tree.NodeID, error)

+ type NodeParams struct

+ Name string

+ type PaneModule struct

+ Tree *tree.Tree

+ func (p *PaneModule) Attach(context interface{}, id tree.NodeID) error

+ func (p *PaneModule) Current(context interface{}) *tree.NodeID

+ type PathModule struct

+ func (p *PathModule) Abs(path string) (string, error)

+ func (p *PathModule) Base(path string) string

+ func (p *PathModule) Join(elem []string) string

+ type TreeModule struct

+ Tree *tree.Tree

+ func (t *TreeModule) Group(id tree.NodeID) bool

+ func (t *TreeModule) Name(id tree.NodeID) *string

+ func (t *TreeModule) Pane(id tree.NodeID) bool

+ func (t *TreeModule) Parent(id tree.NodeID) *tree.NodeID

+ func (t *TreeModule) Renames() map[string]string

+ func (t *TreeModule) Root() tree.NodeID

+ func (t *TreeModule) SetName(id tree.NodeID, name string)