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

shell

package

Go to main page

Versions in this module

v0

v0.9.0

Aug 4, 2026

Changes in this version

+ const MaxFolderSearchDepth

+ func EnsureGitRepository() error

+ func EnsureProjectAnchor() error

type DefaultShell

+ func (s *DefaultShell) ExecCaptureWithEnv(command string, env map[string]string, args ...string) (string, error)

+ func (s *DefaultShell) ExecProgressWithEnv(message string, command string, env map[string]string, args ...string) (string, error)

+ func (s *DefaultShell) ExecSilentWithEnv(command string, env map[string]string, args ...string) (string, error)

+ func (s *DefaultShell) ExecSilentWithEnvAndTimeout(command string, env map[string]string, args []string, timeout time.Duration) (string, error)

+ func (s *DefaultShell) ExecSilentWithTimeout(command string, args []string, timeout time.Duration) (string, error)

+ func (s *DefaultShell) IsGlobal() bool

+ func (s *DefaultShell) IsVerbose() bool

+ func (s *DefaultShell) RenderAliases(aliases map[string]string) string

+ func (s *DefaultShell) UnsetAlias(aliases []string)

+ func (s *DefaultShell) UnsetEnvs(envVars []string)

type MockShell

+ ExecCaptureWithEnvFunc func(command string, env map[string]string, args ...string) (string, error)

+ ExecProgressWithEnvFunc func(message string, command string, env map[string]string, args ...string) (string, error)

+ ExecSilentWithEnvAndTimeoutFunc func(command string, env map[string]string, args []string, timeout time.Duration) (string, error)

+ ExecSilentWithEnvFunc func(command string, env map[string]string, args ...string) (string, error)

+ ExecSilentWithTimeoutFunc func(command string, args []string, timeout time.Duration) (string, error)

+ IsGlobalFunc func() bool

+ IsVerboseFunc func() bool

+ func (s *MockShell) ExecCaptureWithEnv(command string, env map[string]string, args ...string) (string, error)

+ func (s *MockShell) ExecProgressWithEnv(message string, command string, env map[string]string, args ...string) (string, error)

+ func (s *MockShell) ExecSilentWithEnv(command string, env map[string]string, args ...string) (string, error)

+ func (s *MockShell) ExecSilentWithEnvAndTimeout(command string, env map[string]string, args []string, timeout time.Duration) (string, error)

+ func (s *MockShell) ExecSilentWithTimeout(command string, args []string, timeout time.Duration) (string, error)

+ func (s *MockShell) IsGlobal() bool

+ func (s *MockShell) IsVerbose() bool

type Shell

+ ExecCaptureWithEnv func(command string, env map[string]string, args ...string) (string, error)

+ ExecProgressWithEnv func(message string, command string, env map[string]string, args ...string) (string, error)

+ ExecSilentWithEnv func(command string, env map[string]string, args ...string) (string, error)

+ ExecSilentWithEnvAndTimeout func(command string, env map[string]string, args []string, timeout time.Duration) (string, error)

+ ExecSilentWithTimeout func(command string, args []string, timeout time.Duration) (string, error)

+ IsGlobal func() bool

+ IsVerbose func() bool

type Shims

+ IsTerminal func(fd int) bool

v0.8.1

Dec 12, 2025

v0.8.0

Dec 2, 2025

Changes in this version

+ const SessionTokenPrefix

+ type DefaultShell struct

+ func NewDefaultShell() *DefaultShell

+ func (s *DefaultShell) AddCurrentDirToTrustedFile() error

+ func (s *DefaultShell) CheckResetFlags() (bool, error)

+ func (s *DefaultShell) CheckTrustedDirectory() error

+ func (s *DefaultShell) Exec(command string, args ...string) (string, error)

+ func (s *DefaultShell) ExecProgress(message string, command string, args ...string) (string, error)

+ func (s *DefaultShell) ExecSilent(command string, args ...string) (string, error)

+ func (s *DefaultShell) ExecSudo(message string, command string, args ...string) (string, error)

+ func (s *DefaultShell) GetProjectRoot() (string, error)

+ func (s *DefaultShell) GetSessionToken() (string, error)

+ func (s *DefaultShell) InstallHook(shellName string) error

+ func (s *DefaultShell) PrintEnvVars(envVars map[string]string, export bool)

+ func (s *DefaultShell) RegisterSecret(value string)

+ func (s *DefaultShell) RenderAliases(aliases map[string]string) string

+ func (s *DefaultShell) RenderEnvVars(envVars map[string]string, export bool) string

+ func (s *DefaultShell) Reset(quiet ...bool)

+ func (s *DefaultShell) ResetSessionToken()

+ func (s *DefaultShell) SetVerbosity(verbose bool)

+ func (s *DefaultShell) UnsetAlias(aliases []string)

+ func (s *DefaultShell) UnsetEnvs(envVars []string)

+ func (s *DefaultShell) WriteResetToken() (string, error)

+ type HookContext struct

+ SelfPath string

+ type MockShell struct

+ AddCurrentDirToTrustedFileFunc func() error

+ CheckResetFlagsFunc func() (bool, error)

+ CheckTrustedDirectoryFunc func() error

+ ExecFunc func(command string, args ...string) (string, error)

+ ExecProgressFunc func(message string, command string, args ...string) (string, error)

+ ExecSilentFunc func(command string, args ...string) (string, error)

+ ExecSudoFunc func(message string, command string, args ...string) (string, error)

+ GetProjectRootFunc func() (string, error)

+ GetSessionTokenFunc func() (string, error)

+ InstallHookFunc func(shellName string) error

+ RegisterSecretFunc func(value string)

+ RenderAliasesFunc func(aliases map[string]string) string

+ RenderEnvVarsFunc func(envVars map[string]string, export bool) string

+ ResetFunc func(...bool)

+ SetVerbosityFunc func(verbose bool)

+ UnsetAliasFunc func(aliases []string)

+ UnsetEnvsFunc func(envVars []string)

+ WriteResetTokenFunc func() (string, error)

+ func NewMockShell() *MockShell

+ func (s *MockShell) AddCurrentDirToTrustedFile() error

+ func (s *MockShell) CheckResetFlags() (bool, error)

+ func (s *MockShell) CheckTrustedDirectory() error

+ func (s *MockShell) Exec(command string, args ...string) (string, error)

+ func (s *MockShell) ExecProgress(message string, command string, args ...string) (string, error)

+ func (s *MockShell) ExecSilent(command string, args ...string) (string, error)

+ func (s *MockShell) ExecSudo(message string, command string, args ...string) (string, error)

+ func (s *MockShell) GetProjectRoot() (string, error)

+ func (s *MockShell) GetSessionToken() (string, error)

+ func (s *MockShell) InstallHook(shellName string) error

+ func (s *MockShell) RegisterSecret(value string)

+ func (s *MockShell) RenderAliases(aliases map[string]string) string

+ func (s *MockShell) RenderEnvVars(envVars map[string]string, export bool) string

+ func (s *MockShell) Reset(quiet ...bool)

+ func (s *MockShell) SetVerbosity(verbose bool)

+ func (s *MockShell) UnsetAlias(aliases []string)

+ func (s *MockShell) UnsetEnvs(envVars []string)

+ func (s *MockShell) WriteResetToken() (string, error)

+ type SecureShell struct

+ func NewSecureShell(sshClient ssh.Client) *SecureShell

+ func (s *SecureShell) Exec(command string, args ...string) (string, error)

+ func (s *SecureShell) ExecProgress(message string, command string, args ...string) (string, error)

+ func (s *SecureShell) ExecSilent(command string, args ...string) (string, error)

+ type Shell interface

+ AddCurrentDirToTrustedFile func() error

+ CheckResetFlags func() (bool, error)

+ CheckTrustedDirectory func() error

+ Exec func(command string, args ...string) (string, error)

+ ExecProgress func(message string, command string, args ...string) (string, error)

+ ExecSilent func(command string, args ...string) (string, error)

+ ExecSudo func(message string, command string, args ...string) (string, error)

+ GetProjectRoot func() (string, error)

+ GetSessionToken func() (string, error)

+ InstallHook func(shellName string) error

+ RegisterSecret func(value string)

+ RenderAliases func(aliases map[string]string) string

+ RenderEnvVars func(envVars map[string]string, export bool) string

+ Reset func(quiet ...bool)

+ SetVerbosity func(verbose bool)

+ UnsetAlias func(aliases []string)

+ UnsetEnvs func(envVars []string)

+ WriteResetToken func() (string, error)

+ type Shims struct

+ Chdir func(dir string) error

+ CmdRun func(cmd *exec.Cmd) error

+ CmdStart func(cmd *exec.Cmd) error

+ CmdWait func(cmd *exec.Cmd) error

+ Command func(name string, arg ...string) *exec.Cmd

+ Environ func() []string

+ Executable func() (string, error)

+ ExecuteTemplate func(tmpl *template.Template, data any) error

+ Getenv func(key string) string

+ Getwd func() (string, error)

+ Glob func(pattern string) ([]string, error)

+ Join func(elem ...string) string

+ LookPath func(file string) (string, error)

+ MkdirAll func(path string, perm os.FileMode) error

+ NewScanner func(r io.Reader) *bufio.Scanner

+ NewTemplate func(name string) *template.Template

+ NewWriter func(w io.Writer) *bufio.Writer

+ OpenFile func(name string, flag int, perm os.FileMode) (*os.File, error)

+ Pipe func() (*os.File, *os.File, error)

+ RandRead func(b []byte) (n int, err error)

+ ReadFile func(name string) ([]byte, error)

+ Remove func(name string) error

+ RemoveAll func(path string) error

+ ScannerErr func(scanner *bufio.Scanner) error

+ ScannerScan func(scanner *bufio.Scanner) bool

+ ScannerText func(scanner *bufio.Scanner) string

+ SetStderr func(w io.Writer)

+ SetStdout func(w io.Writer)

+ Setenv func(key, value string) error

+ Stat func(name string) (os.FileInfo, error)

+ Stderr func() io.Writer

+ StderrPipe func(cmd *exec.Cmd) (io.ReadCloser, error)

+ StdinPipe func(cmd *exec.Cmd) (io.WriteCloser, error)

+ Stdout func() io.Writer

+ StdoutPipe func(cmd *exec.Cmd) (io.ReadCloser, error)

+ TemplateExecute func(tmpl *template.Template, wr io.Writer, data any) error

+ TemplateParse func(tmpl *template.Template, text string) (*template.Template, error)

+ UnsetAlias func(aliases []string)

+ UnsetEnvs func(envVars []string)

+ UserHomeDir func() (string, error)

+ WriteFile func(name string, data []byte, perm os.FileMode) error

+ func NewShims() *Shims