shell

Documentation

Overview

Package shell works with shell for eclectica

Index

• func Compose(plugins []string) (result string)
• func Name() string
• func Path() string
• func Start() bool
• type Shell
  • func New(plugins []string) *Shell
  • func (shell *Shell) Check()
  • func (shell *Shell) Initiate() (err error)
  • func (shell *Shell) Remove() (err error)
  • func (shell *Shell) Start() bool

Functions

func Compose

func Compose(plugins []string) (result string)

Compose returns $PATH paths for all provided languages

func Name

func Name() string

Name name of the current shell

func Path

func Path() string

Path gets path to current shell binary

func Start

func Start() bool

Start starts a shell This is the only place beside cmd modules where we might output stuff to std(out | err)

Types

type Shell

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

Shell essential structure

func New

func New(plugins []string) *Shell

New cretates new Shell struct

func (*Shell) Check

func (shell *Shell) Check()

Check if we need to restart the shell

func (*Shell) Initiate

func (shell *Shell) Initiate() (err error)

Initiate the shell if needed

func (*Shell) Remove

func (shell *Shell) Remove() (err error)

Remove some text from the shell config file

func (*Shell) Start

func (shell *Shell) Start() bool

Start starts the shell if needed