shell

Documentation

Overview

Package shell contains high-level features that use the syntax and interp packages under the hood.

This package is a work in progress and EXPERIMENTAL; its API is not subject to the 1.x backwards compatibility guarantee.

Index

• func Expand(s string, env func(string) string) (string, error)
• func SourceFile(path string) (map[string]interp.Variable, error)
• func SourceNode(node syntax.Node) (map[string]interp.Variable, error)

Functions

func Expand

func Expand(s string, env func(string) string) (string, error)

Expand performs shell expansion on s, using env to resolve variables. The expansion will apply to parameter expansions like $var and ${#var}, but also to arithmetic expansions like $((var + 3)), and command substitutions like $(echo foo).

If env is nil, the current environment variables are used.

Any side effects or modifications to the system are forbidden when interpreting the program. This is enforced via whitelists when executing programs and opening paths. The interpreter also has a timeout of two seconds.

func SourceFile

func SourceFile(path string) (map[string]interp.Variable, error)

SourceFile sources a shell file from disk and returns the variables declared in it.

A default parser is used; to set custom options, use SourceNode instead.

func SourceNode

func SourceNode(node syntax.Node) (map[string]interp.Variable, error)

SourceNode sources a shell program from a node and returns the variables declared in it.

Any side effects or modifications to the system are forbidden when interpreting the program. This is enforced via whitelists when executing programs and opening paths. The interpreter also has a timeout of two seconds.