ui

package

v1.1.3 Latest Latest Go to latest Published: Oct 18, 2026 License: MIT Imports: 26 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Paksonite/gitnest

Links

Open Source Insights

Documentation ¶

Overview ¶

Package ui is the bubbletea TUI: the repository list and the repository view.

Index ¶

Variables
func Run(cfg config.Config, noConfig bool, startDir, cdFile string) error
type App
type Shell

Constants ¶

This section is empty.

Variables ¶

View Source

var Version = "dev"

Version is the running gitnest's version, set by main; development builds never look for updates.

Functions ¶

func Run ¶

func Run(cfg config.Config, noConfig bool, startDir, cdFile string) error

Run starts the TUI. startDir, if non-empty, opens that repository directly. cdFile, when set, is where "o" writes the chosen repository for the gn shell function to cd into.

Types ¶

type App ¶

type App struct {
	// contains filtered or unexported fields
}

func (*App) Init ¶

func (a *App) Init() tea.Cmd

Init starts a single App on its own (the program runs a Shell, see panes.go).

func (*App) Update ¶

func (a *App) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*App) View ¶

func (a *App) View() string

type Shell ¶ added in v0.9.0

type Shell struct {
	// contains filtered or unexported fields
}

Shell holds several independent gitnests ("panes") in one terminal. Every pane is a full App with its own screen, selection, open repository, prompts and editor; the config, themes, scanner and the commit clipboard are shared. ctrl+n opens a pane, ctrl+w closes one, ctrl+arrows (or alt+arrows) move the focus and ctrl+g changes the layout. Up to maxTiled panes are tiled; more are shown as tabs.

func (*Shell) Init ¶ added in v0.9.0

func (s *Shell) Init() tea.Cmd

func (*Shell) Update ¶ added in v0.9.0

func (s *Shell) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*Shell) View ¶ added in v0.9.0

func (s *Shell) View() string

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