tools

Documentation

Index

• Variables
• func CheckPrerequisite(name string) error
• func CheckTool(name string) error
• func GetMissingTools() []string
• func MissingPrerequisites() string
• func SufficientSelfVersion(minimal string) bool
• type Prerequisite
  • func GetRequirements() ([]Prerequisite, error)
  • func GetSelfRequirement() (Prerequisite, error)

Variables

var RequiredTools = []Prerequisite{
	{Name: "Python", Command: "python3", URL: "https://www.python.org/downloads/"},
	{Name: "uv", Command: "uv", URL: "https://docs.astral.sh/uv/getting-started/installation/"},
	{Name: "task", Command: "task", URL: "https://taskfile.dev/docs/installation"},
	{Name: "pulumi", Command: "pulumi", URL: "https://www.pulumi.com/docs/get-started/download-install/"},
}

RequiredTools lists all tools required for the quickstart process

Functions

func CheckPrerequisite

func CheckPrerequisite(name string) error

func CheckTool

func CheckTool(name string) error

CheckTool verifies if a specific tool is installed

func GetMissingTools

func GetMissingTools() []string

GetMissingTools returns a list of missing prerequisite tools

func MissingPrerequisites

func MissingPrerequisites() string

MissingPrerequisites verifies that all required tools are installed

func SufficientSelfVersion

func SufficientSelfVersion(minimal string) bool

Types

type Prerequisite

type Prerequisite struct {
	Key            string
	Name           string `yaml:"name"`
	MinimumVersion string `yaml:"minimum-version"`
	Command        string `yaml:"command"`
	URL            string `yaml:"url"`
}

Prerequisite represents a required tool

func GetRequirements

func GetRequirements() ([]Prerequisite, error)

func GetSelfRequirement

func GetSelfRequirement() (Prerequisite, error)