shell

package

v0.15.0 Latest Latest Go to latest Published: Jan 24, 2021 License: BSD-2-Clause Imports: 39 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

Package shell is the entry point for the terminal interface of Elvish.

This section is empty.

View Source

var Program prog.Program = program{}

Program is the shell subprogram.

func CleanupRuntime(stderr io.Writer, ev *eval.Evaler)

CleanupRuntime cleans up the runtime.

func InitRuntime(stderr io.Writer, p Paths, spawn bool) *eval.Evaler

InitRuntime initializes the runtime. The caller should call CleanupRuntime when the Evaler is no longer needed.

func Interact(fds [3]*os.File, cfg *InteractConfig)

Interact runs an interactive shell session.

func Script(fds [3]*os.File, args []string, cfg *ScriptConfig) int

Script executes a shell script.

type InteractConfig struct {
	SpawnDaemon bool
	Paths       Paths
}

InteractConfig keeps configuration for the interactive mode.

type Paths struct {
	RunDir string
	Sock   string

	DataDir string
	Db      string
	Rc      string
	LibDir  string

	Bin string
}

Paths keeps all paths required for the Elvish runtime.

func MakePaths(stderr io.Writer, overrides Paths) Paths

MakePaths makes a populated Paths, using the given overrides.

type ScriptConfig struct {
	SpawnDaemon bool
	Paths       Paths

	Cmd         bool
	CompileOnly bool
	JSON        bool
}

ScriptConfig keeps configuration for the script mode.