Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

script

package

Go to main page

Versions in this module

v1

v1.0.5

Aug 21, 2026

v1.0.4

Jun 9, 2026

v1.0.4-rc2

Jun 9, 2026

v1.0.4-rc1

Jun 1, 2026

v1.0.3

May 27, 2026

v1.0.2

May 26, 2026

v1.0.1

Mar 13, 2026

v1.0.0

Mar 2, 2026

v0

v0.0.1

Jan 8, 2026

Changes in this version

+ var ErrUnexpectedSuccess = errors.New("unexpected success")

+ var ErrUsage = errors.New("invalid usage")

+ var ParseError = errors.New("parse error")

+ func DefaultCmds() map[string]Cmd

+ func DefaultConds() map[string]Cond

+ func MakeRaw(fd int) (restore func(), err error)

+ type Cmd interface

+ Run func(s *State, args ...string) (WaitFunc, error)

+ Usage func() *CmdUsage

+ func Break() Cmd

+ func Cat() Cmd

+ func Cd() Cmd

+ func Chmod() Cmd

+ func Cmp() Cmd

+ func Cmpenv() Cmd

+ func Command(usage CmdUsage, run func(*State, ...string) (WaitFunc, error)) Cmd

+ func Cp() Cmd

+ func Echo() Cmd

+ func Empty() Cmd

+ func Env() Cmd

+ func Exec(cancel func(*exec.Cmd) error, waitDelay time.Duration) Cmd

+ func Exists() Cmd

+ func Grep() Cmd

+ func Help() Cmd

+ func Mkdir() Cmd

+ func Mv() Cmd

+ func Program(name string, cancel func(*exec.Cmd) error, waitDelay time.Duration) Cmd

+ func Replace() Cmd

+ func Rm() Cmd

+ func Sed() Cmd

+ func Sleep() Cmd

+ func Stderr() Cmd

+ func Stdout() Cmd

+ func Stop() Cmd

+ func Symlink() Cmd

+ func Wait() Cmd

+ type CmdUsage struct

+ Args string

+ Async bool

+ AutocompleteArgs func(state *State, before []string, cur string) []string

+ AutocompleteFlag func(state *State, args []string, flag, cur string) []string

+ Detail []string

+ Flags func(fs *pflag.FlagSet)

+ RegexpArgs func(rawArgs ...string) []int

+ Summary string

+ type CommandError struct

+ Args []string

+ Err error

+ File string

+ Line int

+ Op string

+ func (e *CommandError) Error() string

+ func (e *CommandError) Unwrap() error

+ type Cond interface

+ Eval func(s *State, suffix string) (bool, error)

+ Usage func() *CondUsage

+ func BoolCondition(summary string, v bool) Cond

+ func CachedCondition(summary string, eval func(string) (bool, error)) Cond

+ func Condition(summary string, eval func(*State) (bool, error)) Cond

+ func OnceCondition(summary string, eval func() (bool, error)) Cond

+ func PrefixCondition(summary string, eval func(*State, string) (bool, error)) Cond

+ type CondUsage struct

+ Prefix bool

+ Summary string

+ type Engine struct

+ Cmds map[string]Cmd

+ Conds map[string]Cond

+ MaxRetryInterval time.Duration

+ Quiet bool

+ RetryInterval time.Duration

+ func NewEngine() *Engine

+ func (e *Engine) Autocomplete(terminal *term.Terminal, state *State) func(line string, pos int, key rune) (newLine string, newPos int, ok bool)

+ func (e *Engine) Execute(s *State, file string, script *bufio.Reader, log io.Writer) (err error)

+ func (e *Engine) ExecuteLine(s *State, line string, log io.Writer) (err error)

+ func (e *Engine) ListCmds(w io.Writer, verbose bool, regexMatch string) error

+ func (e *Engine) ListConds(w io.Writer, s *State, tags ...string) error

+ type State struct

+ BreakOnError bool

+ DoUpdate bool

+ FileUpdates map[string]string

+ Flags *pflag.FlagSet

+ RetryCount int

+ func NewState(ctx context.Context, workdir string, initialEnv []string) (*State, error)

+ func (s *State) Chdir(path string) error

+ func (s *State) CloseAndWait(log io.Writer) error

+ func (s *State) Context() context.Context

+ func (s *State) Environ() []string

+ func (s *State) ExpandEnv(str string, inRegexp bool) string

+ func (s *State) ExtractFiles(ar *txtar.Archive) error

+ func (s *State) FlushLog() error

+ func (s *State) Getwd() string

+ func (s *State) LogWriter() io.Writer

+ func (s *State) Logf(format string, args ...any)

+ func (s *State) LookupEnv(key string) (string, bool)

+ func (s *State) Path(path string) string

+ func (s *State) Setenv(key, value string) error

+ func (s *State) Stderr() string

+ func (s *State) Stdout() string

+ type UsageError struct

+ Command Cmd

+ Name string

+ func (e *UsageError) Error() string

+ type WaitFunc func(*State) (stdout, stderr string, err error)