shellhook

Documentation

Index

• type Result
  • func Add(line, comment string) ([]Result, error)
  • func Remove(line, comment string) ([]Result, error)
• type Shell

Types

type Result

type Result struct {
	Path    string
	Updated bool // false = already present (Add) or line not found (Remove)
}

Result describes what happened to a single profile file.

func Add

func Add(line, comment string) ([]Result, error)

Add appends comment and line to the detected shell's primary profile. Only one profile is written to avoid duplication on platforms where multiple profiles are sourced in the same session (e.g. Git Bash sources both .bashrc and .bash_profile). Falls back to the first existing candidate if the shell cannot be detected.

func Remove

func Remove(line, comment string) ([]Result, error)

Remove strips every occurrence of line (full-line match) and any immediately preceding line equal to comment from all existing profiles. Returns one Result per candidate profile found on disk.

type Shell

type Shell int

Shell identifies a shell type.

const (
	ShellUnknown Shell = iota
	ShellPowerShell
	ShellBash
	ShellZsh
)