install

package

v1.2.9 Latest Latest Go to latest Published: Feb 20, 2026 License: MIT Imports: 16 Imported by: 0

Details

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

Repository

github.com/VoxDroid/krnr

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package install provides installation utilities.

Index ¶

func ContainsPath(pathEnv, dir string) bool
func DefaultUserBin() string
func ExecuteInstall(opts Options) ([]string, error)
func PlanInstall(opts Options) ([]string, string, error)
func PlanUninstall() ([]string, error)
func Uninstall(verbose bool) ([]string, error)
type Options
type Status
- func GetStatus() (*Status, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ContainsPath ¶

func ContainsPath(pathEnv, dir string) bool

ContainsPath checks if the given directory is in the PATH environment variable.

func DefaultUserBin ¶

func DefaultUserBin() string

DefaultUserBin returns a sensible per-user bin directory per OS.

func ExecuteInstall ¶

func ExecuteInstall(opts Options) ([]string, error)

ExecuteInstall performs the install actions (will create dirs, copy file, set modes). It returns human-friendly messages describing what was actually done (created directories, copied the binary, added to PATH, etc.).

func PlanInstall ¶

func PlanInstall(opts Options) ([]string, string, error)

PlanInstall returns a list of human-readable actions that would be performed.

func PlanUninstall ¶

func PlanUninstall() ([]string, error)

PlanUninstall returns a list of actions that would be performed by Uninstall.

func Uninstall ¶

func Uninstall(verbose bool) ([]string, error)

Uninstall removes previously installed binary and reverses PATH modifications.

Types ¶

type Options ¶

type Options struct {
	User      bool
	System    bool
	Path      string
	From      string
	DryRun    bool
	Check     bool
	Yes       bool
	AddToPath bool // if true, installer will add target dir to PATH (with confirmation)
}

Options controls install behavior.

type Status ¶

type Status struct {
	UserPath        string
	SystemPath      string
	UserInstalled   bool
	SystemInstalled bool
	UserOnPath      bool
	SystemOnPath    bool
	MetadataFound   bool
}

Status represents the presence of krnr in user and system locations and PATH.

func GetStatus ¶

func GetStatus() (*Status, error)

GetStatus inspects the system and returns installation status for user and system locations.

Source Files ¶

View all Source files

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