localtools

package

Go to main page

Versions in this module

v0

v0.32.1

Jun 17, 2026

v0.32.0

Jun 17, 2026

v0.31.1

Jun 14, 2026

v0.31.0

Jun 14, 2026

v0.30.0

Jun 14, 2026

v0.29.0

Jun 14, 2026

Changes in this version

+ type FsSedResult struct

+ Changed bool

+ NewBytes int

+ NewSHA256 string

+ NewText string

+ OldBytes int

+ OldSHA256 string

+ OldText string

+ Path string

+ Replacements int

+ Written bool

+ func (r FsSedResult) ToolDiff() (string, string, string, bool)

type FsWriteResult

+ NewBytes int

+ NewSHA256 string

+ OldBytes int

+ OldSHA256 string

+ func (r FsWriteResult) ToolDiff() (string, string, string, bool)

v0.28.14

Jun 11, 2026

v0.28.13

Jun 11, 2026

v0.28.12

Jun 10, 2026

v0.28.11

Jun 10, 2026

v0.28.10

Jun 10, 2026

v0.28.9

Jun 9, 2026

v0.28.8

Jun 9, 2026

v0.28.7

Jun 9, 2026

v0.28.6

Jun 9, 2026

v0.28.5

Jun 8, 2026

v0.28.4

Jun 8, 2026

Changes in this version

type CommandRunner

+ func NewOSCommandRunnerWithShell(shell PlatformShell) CommandRunner

type CommandSpec

+ Shell PlatformShell

type LocalExecOption

+ func WithLocalExecShell(shell PlatformShell) LocalExecOption

type LocalExecResult

+ OS string

+ Shell string

+ type PlatformShell struct

+ ArgsPrefix []string

+ Command string

+ DisplayName string

+ Kind ShellKind

+ OS string

+ SyntaxHint string

+ func DetectPlatformShell() PlatformShell

+ func DetectPlatformShellFor(goos string, getenv func(string) string, lookPath func(string) (string, error)) PlatformShell

+ func NewCmdShell(command string) PlatformShell

+ func NewPowerShellShell(command string) PlatformShell

+ func NewShShell(command string) PlatformShell

+ func (s PlatformShell) IsSet() bool

+ func (s PlatformShell) ShellModeDescription() string

+ func (s PlatformShell) Summary() string

+ func (s PlatformShell) WithDefaults() PlatformShell

+ func (s PlatformShell) WrapCommand(command string, args []string) (program string, wrappedArgs []string, script string)

+ type ShellKind string

+ const ShellKindCmd

+ const ShellKindPowerShell

+ const ShellKindSh

v0.28.3

Jun 7, 2026

v0.28.2

Jun 7, 2026

v0.28.1

Jun 6, 2026

v0.28.0

Jun 5, 2026

Changes in this version

+ const DenyMessage

+ const LocalFSToolsName

+ const WebToolsName

+ var ErrMCPListToolsFailed = errors.New("mcp list-tools failed")

+ var ErrMCPOAuthNotAuthenticated = errors.New("mcp oauth not authenticated")

+ var ErrMCPSessionUnavailable = errors.New("mcp session unavailable")

+ var ErrMCPToolCallFailed = errors.New("mcp tool call failed")

+ var ErrOAuthNotAuthenticated = ErrMCPOAuthNotAuthenticated

+ var ErrOutputBudgetExceeded = errors.New("local_shell: command output exceeded the remaining context budget")

+ func IsApprovalPending() bool

+ func NewEchoTools() taskengine.ToolsRepo

+ func NewLocalExecTools(opts ...LocalExecOption) taskengine.ToolsRepo

+ func NewLocalExecToolsWith(runner CommandRunner, opts ...LocalExecOption) taskengine.ToolsRepo

+ func NewLocalFSTools(allowedDir string, db libdb.DBManager) taskengine.ToolsRepo

+ func NewLocalFSToolsWith(allowedDir string, db libdb.DBManager, io FileIO, name string, ...) taskengine.ToolsRepo

+ func NewPrint(tracker libtracker.ActivityTracker) taskengine.ToolsRepo

+ func NewSSHTools(options ...SSHOption) (taskengine.ToolsRepo, error)

+ func NewWebCaller(tracker libtracker.ActivityTracker, options ...WebtoolsOption) taskengine.ToolsRepo

+ func RunOAuthFlow(ctx context.Context, o2cfg *oauth2.Config, oauthCfg *MCPOAuthConfig, ...) (*oauth2.Token, error)

+ type AskApproval func(ctx context.Context, req hitlservice.ApprovalRequest) (bool, error)

+ type CommandRunner interface

+ Run func(ctx context.Context, spec CommandSpec, stdout, stderr io.Writer) (exitCode int, err error)

+ func NewOSCommandRunner() CommandRunner

+ type CommandSpec struct

+ Args []string

+ Command string

+ Cwd string

+ Stdin string

+ Timeout time.Duration

+ UseShell bool

+ type EchoTools struct

+ func (e *EchoTools) Exec(ctx context.Context, startTime time.Time, input any, debug bool, ...) (any, taskengine.DataType, error)

+ func (e *EchoTools) GetSchemasForSupportedTools(ctx context.Context) (map[string]*openapi3.T, error)

+ func (e *EchoTools) GetToolsForToolsByName(ctx context.Context, name string) ([]taskengine.Tool, error)

+ func (e *EchoTools) Supports(ctx context.Context) ([]string, error)

+ type FileIO interface

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

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

+ func NewOSFileIO() FileIO

+ type FsWriteResult struct

+ NewText string

+ OldText string

+ Path string

+ Written bool

+ type HITLWrapper struct

+ func NewHITLWrapper(inner taskengine.ToolsRepo, ask AskApproval, ...) *HITLWrapper

+ func (h *HITLWrapper) Exec(ctx context.Context, startTime time.Time, input any, debug bool, ...) (any, taskengine.DataType, error)

+ func (h *HITLWrapper) GetSchemasForSupportedTools(ctx context.Context) (map[string]*openapi3.T, error)

+ func (h *HITLWrapper) GetToolsForToolsByName(ctx context.Context, name string) ([]taskengine.Tool, error)

+ func (h *HITLWrapper) Supports(ctx context.Context) ([]string, error)

+ type HostKeyVerifier struct

+ func NewHostKeyVerifier(knownHostsFile string, strict bool) (*HostKeyVerifier, error)

+ func (v *HostKeyVerifier) AddKnownHost(host, key string)

+ func (v *HostKeyVerifier) VerifyHostKey(hostname string, remote net.Addr, key ssh.PublicKey) error

+ type LocalExecOption func(*LocalExecTools)

+ func WithLocalExecAllowedCommands(commands []string) LocalExecOption

+ func WithLocalExecAllowedDir(dir string) LocalExecOption

+ func WithLocalExecDeniedCommands(commands []string) LocalExecOption

+ func WithLocalExecTimeout(d time.Duration) LocalExecOption

+ type LocalExecResult struct

+ Command string

+ DurationSeconds float64

+ Error string

+ ExitCode int

+ Stderr string

+ Stdout string

+ Success bool

+ type LocalExecTools struct

+ func (h *LocalExecTools) Exec(ctx context.Context, startTime time.Time, input any, debug bool, ...) (any, taskengine.DataType, error)

+ func (h *LocalExecTools) GetSchemasForSupportedTools(ctx context.Context) (map[string]*openapi3.T, error)

+ func (h *LocalExecTools) GetToolsForToolsByName(ctx context.Context, name string) ([]taskengine.Tool, error)

+ func (h *LocalExecTools) Supports(ctx context.Context) ([]string, error)

+ type LocalFSTools struct

+ func (h *LocalFSTools) Exec(ctx context.Context, startTime time.Time, input any, debug bool, ...) (any, taskengine.DataType, error)

+ func (h *LocalFSTools) GetSchemasForSupportedTools(ctx context.Context) (map[string]*openapi3.T, error)

+ func (h *LocalFSTools) GetToolsForToolsByName(ctx context.Context, name string) ([]taskengine.Tool, error)

+ func (h *LocalFSTools) Supports(ctx context.Context) ([]string, error)

+ type MCPAuthConfig struct

+ APIKeyFromEnv string

+ Token string

+ Type MCPAuthType

+ func (a *MCPAuthConfig) ResolveToken() string

+ type MCPAuthType string

+ const MCPAuthBearer

+ const MCPAuthNone

+ const MCPAuthOAuth

+ type MCPOAuthConfig struct

+ CallbackPort int

+ ClientID string

+ ClientName string

+ ClientSecret string

+ OpenBrowser func(url string) error

+ Scopes []string

+ TokenStore mcpoauth.TokenStore

+ func (c *MCPOAuthConfig) ResolveCallbackPort() int

+ func (c *MCPOAuthConfig) ResolveClientName() string

+ type MCPServerConfig struct

+ Args []string

+ Auth *MCPAuthConfig

+ Command string

+ ConnectTimeout time.Duration

+ MCPSessionID string

+ Name string

+ OAuth *MCPOAuthConfig

+ OnSessionID func(string)

+ Tracker libtracker.ActivityTracker

+ Transport MCPTransport

+ URL string

+ type MCPSessionPool struct

+ func NewMCPSessionPool(cfg MCPServerConfig) *MCPSessionPool

+ func (p *MCPSessionPool) CallTool(ctx context.Context, toolName string, args map[string]any) (any, error)

+ func (p *MCPSessionPool) Close() error

+ func (p *MCPSessionPool) Connect(ctx context.Context) error

+ func (p *MCPSessionPool) ListTools(ctx context.Context) ([]*mcp.Tool, error)

+ func (p *MCPSessionPool) Reconnect(ctx context.Context) error

+ func (p *MCPSessionPool) Session(ctx context.Context) (*mcp.ClientSession, error)

+ type MCPTransport string

+ const MCPTransportHTTP

+ const MCPTransportSSE

+ const MCPTransportStdio

+ type MockToolsRepo struct

+ Calls []ToolsCallRecord

+ DefaultResponse ToolsResponse

+ ErrorSequence []error

+ ResponseMap map[string]ToolsResponse

+ func NewMockToolsRegistry() *MockToolsRepo

+ func (m *MockToolsRepo) CallCount() int

+ func (m *MockToolsRepo) Exec(ctx context.Context, startingTime time.Time, input any, ...) (int, any, taskengine.DataType, string, error)

+ func (m *MockToolsRepo) LastCall() *ToolsCallRecord

+ func (m *MockToolsRepo) Reset()

+ func (m *MockToolsRepo) Supports(ctx context.Context) ([]string, error)

+ func (m *MockToolsRepo) WithErrorSequence(errors ...error) *MockToolsRepo

+ func (m *MockToolsRepo) WithResponse(toolsType string, response ToolsResponse) *MockToolsRepo

+ type Print struct

+ func (h *Print) Exec(ctx context.Context, startTime time.Time, input any, debug bool, ...) (any, taskengine.DataType, error)

+ func (h *Print) GetSchemasForSupportedTools(ctx context.Context) (map[string]*openapi3.T, error)

+ func (h *Print) GetToolsForToolsByName(ctx context.Context, name string) ([]taskengine.Tool, error)

+ func (h *Print) Supports(ctx context.Context) ([]string, error)

+ type SSHClientCache struct

+ func NewSSHClientCache() *SSHClientCache

+ func (c *SSHClientCache) Clear()

+ func (c *SSHClientCache) Get(key string) (*ssh.Client, bool)

+ func (c *SSHClientCache) IsAlive(key string) bool

+ func (c *SSHClientCache) Put(key string, client *ssh.Client, config *ssh.ClientConfig)

+ func (c *SSHClientCache) Remove(key string)

+ type SSHConfig struct

+ Host string

+ HostKey string

+ Password string

+ Port int

+ PrivateKey string

+ PrivateKeyFile string

+ StrictHostKey bool

+ Timeout time.Duration

+ User string

+ type SSHOption func(*SSHTools) error

+ func WithClientCache() SSHOption

+ func WithCustomHostKeyCallback(callback ssh.HostKeyCallback) SSHOption

+ func WithDefaultPort(port int) SSHOption

+ func WithDefaultTimeout(timeout time.Duration) SSHOption

+ func WithKnownHostsFile(path string) SSHOption

+ func WithStrictHostKey() SSHOption

+ type SSHResult struct

+ Command string

+ Duration float64

+ Error string

+ ExitCode int

+ Host string

+ HostKey string

+ Stderr string

+ Stdout string

+ Success bool

+ type SSHTools struct

+ func (h *SSHTools) Close() error

+ func (h *SSHTools) Exec(ctx context.Context, startTime time.Time, input any, debug bool, ...) (any, taskengine.DataType, error)

+ func (h *SSHTools) GetSchemasForSupportedTools(ctx context.Context) (map[string]*openapi3.T, error)

+ func (h *SSHTools) GetToolsForToolsByName(ctx context.Context, name string) ([]taskengine.Tool, error)

+ func (h *SSHTools) Supports(ctx context.Context) ([]string, error)

+ type ToolsCallRecord struct

+ Args taskengine.ToolsCall

+ Input any

+ InputType taskengine.DataType

+ Transition string

+ type ToolsResponse struct

+ Output any

+ OutputType taskengine.DataType

+ Status int

+ Transition string

+ type WebCaller struct

+ func (h *WebCaller) Exec(ctx context.Context, _ time.Time, input any, _ bool, ...) (any, taskengine.DataType, error)

+ func (h *WebCaller) GetSchemasForSupportedTools(_ context.Context) (map[string]*openapi3.T, error)

+ func (h *WebCaller) GetToolsForToolsByName(_ context.Context, name string) ([]taskengine.Tool, error)

+ func (h *WebCaller) Supports(_ context.Context) ([]string, error)

+ type WebtoolsOption func(*WebCaller)

+ func WithDefaultHeader(key, value string) WebtoolsOption

+ func WithHTTPClient(client *http.Client) WebtoolsOption

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL