<< All versions
Skill v1.0.0
currentAutomated scan100/100kurojs/enderdots/gentleman-installer
──Details
PublishedNovember 20, 2026 at 03:57 AM
Content Hashsha256:8a71d1f6080a396e...
Git SHA76f10b4c624b
──Files
Files (1 file, 7.3 KB)
SKILL.md7.3 KBactive
SKILL.md · 279 lines · 7.3 KB
name: gentleman-installer description: > Installation step patterns for Gentleman.Dots TUI installer. Trigger: When editing installer.go, adding installation steps, or modifying the installation flow. license: Apache-2.0 metadata: author: gentleman-programming version: "1.0"
When to Use
Use this skill when:
- Adding new installation steps
- Modifying existing tool installations
- Working on backup/restore functionality
- Implementing non-interactive mode support
- Adding new OS/platform support
Critical Patterns
Pattern 1: InstallStep Structure
All steps follow this structure in model.go:
go
type InstallStep struct {ID string // Unique identifier: "terminal", "shell", etc.Name string // Display name: "Install Fish"Description string // Short descriptionStatus StepStatus // Pending, Running, Done, Failed, SkippedProgress float64 // 0.0 - 1.0Error error // Error if failedInteractive bool // Needs terminal control (sudo, chsh)}
Pattern 2: Step Registration in SetupInstallSteps
Steps MUST be registered in SetupInstallSteps() in model.go:
go
func (m *Model) SetupInstallSteps() {m.Steps = []InstallStep{}// Conditional step based on user choiceif m.Choices.SomeChoice {m.Steps = append(m.Steps, InstallStep{ID: "newstep",Name: "Install Something",Description: "Description here",Status: StatusPending,Interactive: false, // true if needs sudo/password})}}
Pattern 3: Step Execution in executeStep
All step logic goes in installer.go:
go
func executeStep(stepID string, m *Model) error {switch stepID {case "newstep":return stepNewStep(m)// ... other casesdefault:return fmt.Errorf("unknown step: %s", stepID)}}func stepNewStep(m *Model) error {stepID := "newstep"SendLog(stepID, "Starting installation...")// Check if already installedif system.CommandExists("newtool") {SendLog(stepID, "Already installed, skipping...")return nil}// Install based on OSvar result *system.ExecResultif m.SystemInfo.IsTermux {result = system.RunPkgInstall("newtool", nil, func(line string) {SendLog(stepID, line)})} else {result = system.RunBrewWithLogs("install newtool", nil, func(line string) {SendLog(stepID, line)})}if result.Error != nil {return wrapStepError("newstep", "Install NewTool","Failed to install NewTool",result.Error)}SendLog(stepID, "✓ NewTool installed")return nil}
Pattern 4: Interactive Steps (sudo/password required)
Mark step as Interactive and use runInteractiveStep:
go
// In SetupInstallSteps:m.Steps = append(m.Steps, InstallStep{ID: "interactive_step",Name: "Configure System",Description: "Requires password",Status: StatusPending,Interactive: true, // KEY: marks as interactive})// In runNextStep (update.go):if step.Interactive {return runInteractiveStep(step.ID, &m)}
Decision Tree
Adding new tool installation?├── Add step to SetupInstallSteps() with conditions├── Add case in executeStep() switch├── Create step{Name}() function in installer.go├── Handle all OS variants (Mac, Linux, Arch, Debian, Termux)├── Use SendLog() for progress updates└── Return wrapStepError() on failureStep needs password/sudo?├── Set Interactive: true in InstallStep├── Use system.RunSudo() or system.RunSudoWithLogs()└── Use tea.ExecProcess for full terminal controlStep should be conditional?├── Check m.Choices.{option} before appending├── Check m.SystemInfo for OS-specific logic└── Use StatusSkipped if conditions not met
Code Examples
Example 1: OS-Specific Installation
go
func stepInstallTool(m *Model) error {stepID := "tool"if !system.CommandExists("tool") {SendLog(stepID, "Installing tool...")var result *system.ExecResultswitch {case m.SystemInfo.IsTermux:result = system.RunPkgInstall("tool", nil, logFunc(stepID))case m.SystemInfo.OS == system.OSArch:result = system.RunSudoWithLogs("pacman -S --noconfirm tool", nil, logFunc(stepID))case m.SystemInfo.OS == system.OSMac:result = system.RunBrewWithLogs("install tool", nil, logFunc(stepID))default: // Debian/Ubunturesult = system.RunBrewWithLogs("install tool", nil, logFunc(stepID))}if result.Error != nil {return wrapStepError("tool", "Install Tool","Failed to install tool",result.Error)}}// Copy configurationSendLog(stepID, "Copying configuration...")homeDir := os.Getenv("HOME")if err := system.CopyDir(filepath.Join("Gentleman.Dots", "ToolConfig/*"),filepath.Join(homeDir, ".config/tool/")); err != nil {return wrapStepError("tool", "Install Tool","Failed to copy configuration",err)}SendLog(stepID, "✓ Tool configured")return nil}func logFunc(stepID string) func(string) {return func(line string) {SendLog(stepID, line)}}
Example 2: Error Wrapping Pattern
go
func wrapStepError(stepID, stepName, description string, cause error) error {return &StepError{StepID: stepID,StepName: stepName,Description: description,Cause: cause,}}// Usage:if result.Error != nil {return wrapStepError("terminal", "Install Alacritty","Failed to install Alacritty. Check your internet connection.",result.Error)}
Example 3: Config Patching
go
// Patch config based on user choicesfunc stepInstallShell(m *Model) error {// ... install shell ...// Patch config for window manager choiceconfigPath := filepath.Join(homeDir, ".config/fish/config.fish")if err := system.PatchFishForWM(configPath, m.Choices.WindowMgr, m.Choices.InstallNvim); err != nil {return wrapStepError("shell", "Install Fish","Failed to configure window manager in shell",err)}return nil}
Logging Pattern
Always use SendLog for step progress:
go
SendLog(stepID, "Starting...") // StartSendLog(stepID, "Downloading...") // ProgressSendLog(stepID, " → file.txt") // Sub-itemSendLog(stepID, "✓ Step completed") // Success
Commands
bash
cd installer && go build ./cmd/gentleman-installer # Build./gentleman-installer --help # Show help./gentleman-installer --non-interactive --shell=fish # Non-interactiveGENTLEMAN_VERBOSE=1 ./gentleman-installer --non-interactive # Verbose logs
Resources
- Steps: See
installer/internal/tui/installer.gofor step implementations - Model: See
installer/internal/tui/model.gofor SetupInstallSteps - System: See
installer/internal/system/exec.gofor command execution - Non-interactive: See
installer/internal/tui/non_interactive.gofor CLI mode