Help us shape the future of Go! Take the 2026 Go Developer Survey

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

shelltool

package

Go to main page

Versions in this module

v0

v0.2.1

Oct 27, 2026

v0.2.0

Oct 20, 2026

v0.1.1

Oct 13, 2026

Changes in this version

type LocalConfig

+ Description string

+ Name string

type PolicyConfig

+ Custom func(ShellRequest) (allowed bool, reason string, ok bool)

v0.1.0

Sep 1, 2026

Changes in this version

+ func DefaultShellEnvironmentInstructions(snapshot ShellEnvironmentSnapshot) string

+ type EnvironmentProvider struct

+ func NewEnvironmentProvider(executor Executor, config EnvironmentProviderConfig) *EnvironmentProvider

+ func (p *EnvironmentProvider) CurrentSnapshot() (ShellEnvironmentSnapshot, bool)

+ func (p *EnvironmentProvider) Invoked(ctx context.Context, invoked agent.InvokedContext) error

+ func (p *EnvironmentProvider) Invoking(ctx context.Context, invoking agent.InvokingContext) ([]*message.Message, []agent.Option, error)

+ func (p *EnvironmentProvider) Refresh(ctx context.Context) (ShellEnvironmentSnapshot, error)

+ type EnvironmentProviderConfig struct

+ InstructionsFormatter func(ShellEnvironmentSnapshot) string

+ OverrideFamily *ShellFamily

+ ProbeTimeout *time.Duration

+ ProbeTools []string

+ SourceID string

+ type Executor interface

+ Initialize func(context.Context) error

+ Run func(context.Context, string) (Result, error)

+ type Local struct

+ func NewLocal(opts LocalConfig) (*Local, error)

+ func (t *Local) ApprovalRequired() bool

+ func (t *Local) Call(ctx context.Context, args string) (any, error)

+ func (t *Local) Close() error

+ func (t *Local) Description() string

+ func (t *Local) Initialize(ctx context.Context) error

+ func (t *Local) Name() string

+ func (t *Local) ReturnSchema() any

+ func (t *Local) Run(ctx context.Context, command string) (Result, error)

+ func (t *Local) Schema() any

+ type LocalConfig struct

+ AcknowledgeUnsafe bool

+ CleanEnvironment bool

+ ConfineWorkingDirectory *bool

+ Environment map[string]*string

+ MaxOutputBytes int

+ Mode Mode

+ Policy *Policy

+ Shell string

+ ShellArgv []string

+ Timeout *time.Duration

+ WorkingDirectory string

+ type Mode int

+ const ModePersistent

+ const ModeStateless

+ type Policy struct

+ func NewPolicy(cfg PolicyConfig) (*Policy, error)

+ func (p *Policy) Evaluate(request ShellRequest) (allowed bool, reason string)

+ type PolicyConfig struct

+ AllowList []string

+ DenyList []string

+ type Result struct

+ Duration time.Duration

+ ExitCode int

+ Stderr string

+ Stdout string

+ TimedOut bool

+ Truncated bool

+ func (r Result) FormatForModel() string

+ type ShellEnvironmentSnapshot struct

+ Family ShellFamily

+ OSDescription string

+ ShellVersion string

+ ToolVersions map[string]ToolVersion

+ WorkingDirectory string

+ type ShellFamily int

+ const ShellFamilyPOSIX

+ const ShellFamilyPowerShell

+ const ShellFamilyUnknown

+ func (f ShellFamily) String() string

+ type ShellRequest struct

+ Command string

+ WorkingDirectory string

+ type ToolVersion struct

+ Found bool

+ Version string