helper

Documentation

Index

• Variables
• func ConfigFiles() []string
• func InstallHelper(shell string, path string) error
• func SetLogger(l *logrus.Logger)
• func UninstallHelper(shell string, path string) error
• type SourceHelper
  • func NewSourceHelper(getExe func() (string, error), output io.Writer) *SourceHelper
  • func (h SourceHelper) Generate(shell string) error

Variables

var SHELL_SCRIPTS = map[string]fileMap{
	"bash": {
		Key:  "bash_profile.sh",
		Path: "~/.bash_profile",
	},
	"zsh": {
		Key:  "zshrc.sh",
		Path: "~/.zshrc",
	},
	"fish": {
		Key:  "aws-sso.fish",
		Path: getFishScript(),
	},
}

map of shells to their file we edit by default

Functions

func ConfigFiles

func ConfigFiles() []string

ConfigFiles returns a list of all the config files we might edit

func InstallHelper

func InstallHelper(shell string, path string) error

InstallHelper installs any helper code into our shell startup script(s)

func SetLogger

func SetLogger(l *logrus.Logger)

func UninstallHelper

func UninstallHelper(shell string, path string) error

UninstallHelper removes any helper code from our shell startup script(s)

Types

type SourceHelper

type SourceHelper struct {
	// contains filtered or unexported fields
}

func NewSourceHelper

func NewSourceHelper(getExe func() (string, error), output io.Writer) *SourceHelper

func (SourceHelper) Generate

func (h SourceHelper) Generate(shell string) error

SourceHelper can be used to generate the completions script for immediate sourcing in the active shell