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

tools

package

Go to main page

Versions in this module

v0

v0.12.0

Aug 18, 2026

v0.11.0

Aug 10, 2026

v0.10.0

Aug 9, 2026

v0.9.0

Jul 26, 2026

v0.8.0

Jul 25, 2026

Changes in this version

+ const DefaultMaxBytes

+ const DefaultMaxLines

+ func ApplyEditsToNormalizedContent(content string, edits []Edit, path string) (base, updated string, err error)

+ func DetectLineEnding(content string) string

+ func DetectSupportedImageMimeType(data []byte) string

+ func FormatSize(bytes int) string

+ func FuzzyFindText(content, oldText string) (start, end int, found bool)

+ func GenerateDiffString(oldContent, newContent string) (diff string, firstChangedLine int)

+ func GenerateUnifiedPatch(path, oldContent, newContent string, contextLines int) string

+ func NewBashTool(opts BashToolOptions) pi.RegisteredTool

+ func NewEditTool(opts EditToolOptions) pi.RegisteredTool

+ func NewReadTool(opts ReadToolOptions) pi.RegisteredTool

+ func NewWriteTool(opts WriteToolOptions) pi.RegisteredTool

+ func NormalizeForFuzzyMatch(text string) string

+ func NormalizeToLF(text string) string

+ func NormalizeToolPath(path string) string

+ func ResolveReadToolPath(ctx context.Context, env ExecutionEnv, path string) (string, error)

+ func ResolveToolPath(ctx context.Context, env ExecutionEnv, path string) (string, error)

+ func RestoreLineEndings(text, ending string) string

+ func StripBOM(content string) (bomOut, text string)

+ type BashExecution struct

+ Command string

+ Cwd string

+ Env map[string]string

+ InheritEnv bool

+ type BashToolOptions struct

+ CommandPrefix string

+ Env ExecutionEnv

+ Prepare func(ctx context.Context, exec *BashExecution) error

+ type Edit struct

+ NewText string

+ OldText string

+ type EditToolOptions struct

+ Env ExecutionEnv

+ type ExecResult struct

+ Cancelled bool

+ ExitCode int

+ TimedOut bool

+ type ExecSpec struct

+ Command string

+ Dir string

+ Env map[string]string

+ InheritEnv bool

+ OnChunk func(chunk []byte)

+ Timeout time.Duration

+ type ExecutionEnv interface

+ AbsolutePath func(ctx context.Context, path string) (string, error)

+ AppendFile func(ctx context.Context, path string, data []byte) error

+ CanonicalPath func(ctx context.Context, path string) (string, error)

+ CreateTemp func(ctx context.Context, prefix, suffix string) (string, error)

+ Cwd func() string

+ Exec func(ctx context.Context, spec ExecSpec) (*ExecResult, error)

+ Exists func(ctx context.Context, path string) (bool, error)

+ FileInfo func(ctx context.Context, path string) (FileInfo, error)

+ ReadFile func(ctx context.Context, path string) ([]byte, error)

+ WriteFile func(ctx context.Context, path string, data []byte) error

+ type FileInfo struct

+ Kind FileKind

+ Size int64

+ type FileKind string

+ const FileKindDir

+ const FileKindFile

+ const FileKindSymlink

+ type OSEnv struct

+ func NewOSEnv(cwd string) (*OSEnv, error)

+ func (e *OSEnv) AbsolutePath(ctx context.Context, path string) (string, error)

+ func (e *OSEnv) AppendFile(ctx context.Context, path string, data []byte) error

+ func (e *OSEnv) CanonicalPath(ctx context.Context, path string) (string, error)

+ func (e *OSEnv) CreateTemp(ctx context.Context, prefix, suffix string) (string, error)

+ func (e *OSEnv) Cwd() string

+ func (e *OSEnv) Exec(ctx context.Context, spec ExecSpec) (*ExecResult, error)

+ func (e *OSEnv) Exists(ctx context.Context, path string) (bool, error)

+ func (e *OSEnv) FileInfo(ctx context.Context, path string) (FileInfo, error)

+ func (e *OSEnv) ReadFile(ctx context.Context, path string) ([]byte, error)

+ func (e *OSEnv) WriteFile(ctx context.Context, path string, data []byte) error

+ type ReadImageProcessor func(ctx context.Context, data []byte, mimeType string, autoResize bool) (ReadImageProcessorResult, error)

+ type ReadImageProcessorResult struct

+ Data []byte

+ Hints []string

+ Message string

+ MimeType string

+ OK bool

+ type ReadToolOptions struct

+ AutoResizeImages *bool

+ Env ExecutionEnv

+ ImageProcessor ReadImageProcessor

+ type ShellCapture struct

+ Cancelled bool

+ ExitCode int

+ FullOutputPath string

+ LastLineBytes int

+ Output string

+ TimedOut bool

+ Truncation TruncationResult

+ func ExecuteShellWithCapture(ctx context.Context, env ExecutionEnv, command string, ...) (*ShellCapture, error)

+ type ShellCaptureOptions struct

+ Dir string

+ Env map[string]string

+ InheritEnv bool

+ OnChunk func(chunk []byte, progress func() ShellProgress)

+ Timeout time.Duration

+ type ShellProgress struct

+ FullOutputPath string

+ Output string

+ Truncation TruncationResult

+ type TruncationOptions struct

+ MaxBytes int

+ MaxLines int

+ type TruncationResult struct

+ Content string

+ FirstLineExceedsLimit bool

+ LastLinePartial bool

+ MaxBytes int

+ MaxLines int

+ OutputBytes int

+ OutputLines int

+ TotalBytes int

+ TotalLines int

+ Truncated bool

+ TruncatedBy string

+ func TruncateHead(content string, opts TruncationOptions) TruncationResult

+ func TruncateTail(content string, opts TruncationOptions) TruncationResult

+ type WriteToolOptions struct

+ Env ExecutionEnv