shellhook

README

go-shellhook

shell hook library for go programs inspired by direnv

usage

get the latest version

go get -u github.com/patrickhuber/go-shellhook

For a full example see the example

note

This library executes in the shell prompt and does an export of variables in the current shell session. These shell variables will persist between commands.

Documentation

Index

• Constants
• Variables
• func Export(e Exporter, vars map[string]string) string
• func Hook(shell Shell, metadata *Metadata) (string, error)
• func Unset(u Unsetter, keys []string) string
• type Exporter
• type Hooker
• type Metadata
• type Namer
• type Shell
  • func New(shell string) (Shell, error)
  • func NewBash() Shell
  • func NewPowershell() Shell
• type Unsetter

Constants

const (
	Bash = "bash"
)

const (
	Powershell = "powershell"
)

Variables

var ErrNotExist = fs.ErrNotExist

Functions

func Export

func Export(e Exporter, vars map[string]string) string

func Hook

func Hook(shell Shell, metadata *Metadata) (string, error)

func Unset

func Unset(u Unsetter, keys []string) string

Types

type Exporter

type Exporter interface {
	Export(key string, value string) string
}

type Hooker

type Hooker interface {
	Hook() (string, error)
}

type Metadata

type Metadata struct {
	// the path to the executable
	Executable string

	// the name of the hook
	Name string

	// the args to pass
	Args []string
}

type Namer

type Namer interface {
	Name() string
}

type Shell

type Shell interface {
	Namer
	Exporter
	Hooker
	Unsetter
}

func New

func New(shell string) (Shell, error)

func NewBash

func NewBash() Shell

func NewPowershell

func NewPowershell() Shell

type Unsetter

type Unsetter interface {
	Unset(key string) string
}