tui

README

GitCells TUI

The GitCells Terminal User Interface (TUI) provides an interactive way to manage Excel file tracking and conversion.

Design Philosophy

The TUI is focused exclusively on GitCells-specific features:

• Excel file tracking configuration
• Monitoring conversion status

Users should use their preferred git tools (command line, SourceTree, GitHub Desktop, etc.) for all git operations including:

• Creating and switching branches
• Committing changes
• Pushing and pulling
• Merging branches
• Resolving conflicts

Available Modes

1. Setup Wizard

Configure GitCells for your Excel tracking repository:

• Set directories to watch
• Configure file extensions
• Set conversion options

2. Status Dashboard

Monitor your Excel file tracking in real-time:

• View tracked Excel files
• Monitor conversion status
• See pending conversions
• Check auto-sync status

Usage

gitcells tui

Key Bindings

• Tab - Switch between tabs/sections
• ↑/↓ or j/k - Navigate lists
• Enter - Select/confirm
• Esc - Go back/cancel
• q - Quit
• ? - Show help

Integration with Git

GitCells creates a git repository to track your Excel files as JSON. Once set up, you can use any git workflow:

1. GitCells watches and converts Excel files to JSON
2. Use your git tools to commit, branch, merge, and collaborate
3. For Excel-aware conflict resolution, use gitcells CLI commands

This separation allows teams to use their existing git workflows while GitCells handles the Excel-specific conversion challenges.

Documentation

Index

• func Run() error
• func RunV2() error
• type Mode
• type ModeV2
• type Model
  • func NewModel() Model
  • func (m Model) Init() tea.Cmd
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string
• type ModelV2
  • func NewModelV2() *ModelV2
  • func (m *ModelV2) Init() tea.Cmd
  • func (m *ModelV2) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m *ModelV2) View() string

Functions

func Run

func Run() error

func RunV2

func RunV2() error

Types

type Mode

type Mode int

const (
	ModeMenu Mode = iota
	ModeSetup
	ModeDashboard
	ModeWatcher
	ModeTools
	ModeSettings
	ModeErrorLog
)

type ModeV2

type ModeV2 int

const (
	ModeV2Dashboard ModeV2 = iota
	ModeV2Diff
	ModeV2Settings
	ModeV2ErrorLog
	ModeV2Setup
)

type Model

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

func NewModel

func NewModel() Model

func (Model) Init

func (m Model) Init() tea.Cmd

func (Model) Update

func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (Model) View

func (m Model) View() string

type ModelV2

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

func NewModelV2

func NewModelV2() *ModelV2

func (*ModelV2) Init

func (m *ModelV2) Init() tea.Cmd

func (*ModelV2) Update

func (m *ModelV2) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*ModelV2) View

func (m *ModelV2) View() string