tool

Documentation

Overview

Package tool implements the 4 built-in tools for piglet: read, write, edit, bash. grep, find, and ls have moved to extensions/filetools and are bundled in pack-code. All tools register through the ext API, same as external extensions.

Index

• func FormatSize(bytes int64) string
• func RegisterBuiltins(app *ext.App, bash BashConfig, tools ToolConfig)
• func UndoSnapshots() (map[string][]byte, error)
• type BashConfig
• type ToolConfig

Functions

func FormatSize

func FormatSize(bytes int64) string

func RegisterBuiltins

func RegisterBuiltins(app *ext.App, bash BashConfig, tools ToolConfig)

RegisterBuiltins registers the 4 built-in tools via the extension API.

func UndoSnapshots

func UndoSnapshots() (map[string][]byte, error)

UndoSnapshots returns all undo snapshots as path→content pairs.

Types

type BashConfig

type BashConfig struct {
	DefaultTimeout int // seconds, default 30
	MaxTimeout     int // seconds, default 300
	MaxStdout      int // bytes, default 100000
	MaxStderr      int // bytes, default 50000
}

BashConfig holds configurable limits for the bash tool. Zero values use defaults.

type ToolConfig

type ToolConfig struct {
	ReadLimit int // max lines per read; 0 = default (2000)
}

ToolConfig holds configurable defaults for built-in tools.