cli

Documentation

Overview

Package cli provides utilities for CLI tool management and validation.

Index

• func FormatCheckResults(results []CheckResult) string
• func ValidateRequired(prereqs []Prerequisite) error
• type CheckResult
  • func Check(prereq Prerequisite) CheckResult
  • func CheckAll(prereqs []Prerequisite) []CheckResult
• type Prerequisite
  • func DefaultPrerequisites() []Prerequisite

Functions

func FormatCheckResults

func FormatCheckResults(results []CheckResult) string

FormatCheckResults formats check results for display

func ValidateRequired

func ValidateRequired(prereqs []Prerequisite) error

ValidateRequired checks that all required prerequisites are met Returns nil if all required tools are found, otherwise returns an error describing what's missing

Types

type CheckResult

type CheckResult struct {
	Prerequisite Prerequisite
	Found        bool
	Path         string // Path to the executable if found
	Version      string // Version string if available
	Error        error
}

CheckResult contains the result of checking a prerequisite

func Check

func Check(prereq Prerequisite) CheckResult

Check verifies that a CLI tool is available in PATH

func CheckAll

func CheckAll(prereqs []Prerequisite) []CheckResult

CheckAll verifies all prerequisites and returns results

type Prerequisite

type Prerequisite struct {
	Name        string // Command name (e.g., "claude", "git")
	Required    bool   // Whether the tool is required to run the app
	Description string // Human-readable description
	InstallURL  string // URL for installation instructions
}

Prerequisite represents a required CLI tool

func DefaultPrerequisites

func DefaultPrerequisites() []Prerequisite

DefaultPrerequisites returns the list of CLI tools needed by Plural