toolkit

package

Go to main page

Versions in this module

v1

v1.4.0

Mar 27, 2026

v1.3.0

Mar 26, 2026

Changes in this version

type Runtime

+ func (rt *Runtime) OpenFile(rel string, flag int, perm os.FileMode) (io.WriteCloser, error)

v1.2.0

Mar 17, 2026

Changes in this version

type Runtime

+ func (rt *Runtime) AppendFile(rel string, data []byte, perm os.FileMode) error

v1.1.0

Mar 4, 2026

Changes in this version

+ type ProcessInfo struct

+ Hostname string

+ PID int

+ StartedAt time.Time

+ UID string

+ func NewProcessInfo(c clock.Clock) ProcessInfo

type Runtime

+ func (rt *Runtime) Process() *ProcessInfo

type RuntimeOption

+ func WithProcessInfo(p ProcessInfo) RuntimeOption

v1.0.2

Feb 26, 2026

v1.0.1

Feb 24, 2026

v1.0.0

Feb 23, 2026

Changes in this version

+ func IsJailed(j Jailed) bool

+ type EnvCloner = envpkg.EnvCloner

type Hasher

+ func OrDefaultHasher(h Hasher) Hasher

+ type Jailed = jailpkg.Jailed

+ type OsFS = filesystempkg.OsFS

+ func NewOsFS(jail, wd string) (*OsFS, error)

+ type Runtime struct

+ func NewOsRuntime() (*Runtime, error)

+ func NewRuntime(opts ...RuntimeOption) (*Runtime, error)

+ func NewTestRuntime(jail, home, user string, opts ...RuntimeOption) (*Runtime, error)

+ func (rt *Runtime) AbsPath(rel string) (string, error)

+ func (rt *Runtime) AtomicWriteFile(rel string, data []byte, perm os.FileMode) error

+ func (rt *Runtime) Clock() clock.Clock

+ func (rt *Runtime) Clone() *Runtime

+ func (rt *Runtime) Env() Env

+ func (rt *Runtime) Environ() []string

+ func (rt *Runtime) FS() FileSystem

+ func (rt *Runtime) Get(key string) string

+ func (rt *Runtime) GetHome() (string, error)

+ func (rt *Runtime) GetJail() string

+ func (rt *Runtime) GetTempDir() string

+ func (rt *Runtime) GetUser() (string, error)

+ func (rt *Runtime) Getwd() (string, error)

+ func (rt *Runtime) Glob(pattern string) ([]string, error)

+ func (rt *Runtime) Has(key string) bool

+ func (rt *Runtime) Hasher() Hasher

+ func (rt *Runtime) Logger() *slog.Logger

+ func (rt *Runtime) Mkdir(rel string, perm os.FileMode, all bool) error

+ func (rt *Runtime) Name() string

+ func (rt *Runtime) ReadDir(rel string) ([]os.DirEntry, error)

+ func (rt *Runtime) ReadFile(rel string) ([]byte, error)

+ func (rt *Runtime) Rel(basePath, targetPath string) (string, error)

+ func (rt *Runtime) RelativePath(basepath, path string) string

+ func (rt *Runtime) Remove(rel string, all bool) error

+ func (rt *Runtime) Rename(src, dst string) error

+ func (rt *Runtime) ResolvePath(rel string, follow bool) (string, error)

+ func (rt *Runtime) Set(key, value string) error

+ func (rt *Runtime) SetClock(c clock.Clock) error

+ func (rt *Runtime) SetHasher(h Hasher) error

+ func (rt *Runtime) SetHome(home string) error

+ func (rt *Runtime) SetJail(jail string) error

+ func (rt *Runtime) SetLogger(lg *slog.Logger) error

+ func (rt *Runtime) SetStream(s *Stream) error

+ func (rt *Runtime) SetUser(user string) error

+ func (rt *Runtime) Setwd(dir string) error

+ func (rt *Runtime) Stat(rel string, follow bool) (os.FileInfo, error)

+ func (rt *Runtime) Stream() *Stream

+ func (rt *Runtime) Symlink(oldName, newName string) error

+ func (rt *Runtime) Unset(key string)

+ func (rt *Runtime) Validate() error

+ func (rt *Runtime) WriteFile(rel string, data []byte, perm os.FileMode) error

+ type RuntimeOption func(*Runtime) error

+ func WithRuntimeClock(c clock.Clock) RuntimeOption

+ func WithRuntimeEnv(env Env) RuntimeOption

+ func WithRuntimeFileSystem(fs FileSystem) RuntimeOption

+ func WithRuntimeHasher(h Hasher) RuntimeOption

+ func WithRuntimeJail(jail string) RuntimeOption

+ func WithRuntimeLogger(lg *slog.Logger) RuntimeOption

+ func WithRuntimeStream(s *Stream) RuntimeOption

type Stream

+ func OrDefaultStream(s *Stream) *Stream

v0

v0.4.0

Dec 8, 2025

Changes in this version

+ func GetTempDir(ctx context.Context) string

v0.3.0

Dec 7, 2025

Changes in this version

+ func Glob(ctx context.Context, pattern string) ([]string, error)

type FileSystem

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

type OsEnv

+ func (o *OsEnv) Glob(pattern string) ([]string, error)

type TestEnv

+ func (m *TestEnv) Glob(pattern string) ([]string, error)

v0.2.1

Nov 16, 2025

v0.2.0

Nov 10, 2025

v0.1.2

Nov 10, 2025

Changes in this version

+ var DefaultEditor = "nano"

+ var ErrEscapeAttempt = errors.New("path escape attempt: operation would access path outside jail")

+ var ErrNoEnvKey = errors.New("env key missing")

+ func AbsPath(ctx context.Context, rel string) string

+ func AtomicWriteFile(ctx context.Context, rel string, data []byte, perm os.FileMode) error

+ func CreateTestStdio(content string) (*os.File, func())

+ func DumpEnv(ctx context.Context) string

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

+ func EnsureInJail(jail, p string) string

+ func EnsureInJailFor(jail, p string) string

+ func ExpandEnv(ctx context.Context, s string) string

+ func ExpandPath(ctx context.Context, p string) (string, error)

+ func GetDefault(env Env, key, other string) string

+ func IsInJail(jail, rel string) bool

+ func IsInteractiveTerminal(f *os.File) bool

+ func Mkdir(ctx context.Context, rel string, perm os.FileMode, all bool) error

+ func ReadDir(ctx context.Context, rel string) ([]os.DirEntry, error)

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

+ func RelativePath(ctx context.Context, basepath, path string) string

+ func Remove(ctx context.Context, rel string, all bool) error

+ func RemoveJailPrefix(jail, path string) string

+ func Rename(ctx context.Context, src, dst string) error

+ func ResolvePath(ctx context.Context, rel string, follow bool) (string, error)

+ func Stat(ctx context.Context, rel string, followSymlinks bool) (os.FileInfo, error)

+ func StdinHasData(f *os.File) bool

+ func Symlink(ctx context.Context, oldname, newname string) error

+ func UserCachePath(ctx context.Context) (string, error)

+ func UserConfigPath(ctx context.Context) (string, error)

+ func UserDataPath(ctx context.Context) (string, error)

+ func UserStatePath(ctx context.Context) (string, error)

+ func WithEnv(ctx context.Context, env Env) context.Context

+ func WithHasher(ctx context.Context, h Hasher) context.Context

+ func WithStream(ctx context.Context, s *Stream) context.Context

+ func WriteFile(ctx context.Context, rel string, data []byte, perm os.FileMode) error

+ type Env interface

+ Environ func() []string

+ Get func(key string) string

+ GetHome func() (string, error)

+ GetTempDir func() string

+ GetUser func() (string, error)

+ Getwd func() (string, error)

+ Has func(key string) bool

+ Name func() string

+ ResolvePath func(rel string, follow bool) (string, error)

+ Set func(key, value string) error

+ SetHome func(home string) error

+ SetUser func(user string) error

+ Setwd func(dir string)

+ Unset func(key string)

+ func EnvFromContext(ctx context.Context) Env

+ type FileSystem interface

+ AtomicWriteFile func(rel string, data []byte, perm os.FileMode) error

+ Mkdir func(rel string, perm os.FileMode, all bool) error

+ ReadDir func(rel string) ([]os.DirEntry, error)

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

+ Remove func(rel string, all bool) error

+ Rename func(src, dst string) error

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

+ Symlink func(oldname, newname string) error

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

+ type Hasher interface

+ Hash func(data []byte) string

+ var DefaultHasher Hasher = &MD5Hasher{}

+ func HasherFromContext(ctx context.Context) Hasher

+ type MD5Hasher struct

+ func (m *MD5Hasher) Hash(data []byte) string

+ type OsEnv struct

+ func (o *OsEnv) AtomicWriteFile(rel string, data []byte, perm os.FileMode) error

+ func (o *OsEnv) Environ() []string

+ func (o *OsEnv) ExpandPath(p string) string

+ func (o *OsEnv) Get(key string) string

+ func (o *OsEnv) GetHome() (string, error)

+ func (o *OsEnv) GetTempDir() string

+ func (o *OsEnv) GetUser() (string, error)

+ func (o *OsEnv) Getwd() (string, error)

+ func (o *OsEnv) Has(key string) bool

+ func (o *OsEnv) Mkdir(path string, perm os.FileMode, all bool) error

+ func (o *OsEnv) Name() string

+ func (o *OsEnv) ReadDir(rel string) ([]os.DirEntry, error)

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

+ func (o *OsEnv) Remove(path string, all bool) error

+ func (o *OsEnv) Rename(src, dst string) error

+ func (o *OsEnv) ResolvePath(rel string, follow bool) (string, error)

+ func (o *OsEnv) Set(key string, value string) error

+ func (o *OsEnv) SetHome(home string) error

+ func (o *OsEnv) SetUser(username string) error

+ func (o *OsEnv) Setwd(dir string)

+ func (o *OsEnv) Stat(name string, follow bool) (os.FileInfo, error)

+ func (o *OsEnv) Symlink(oldname string, newname string) error

+ func (o *OsEnv) Unset(key string)

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

+ type Stream struct

+ Err io.Writer

+ In io.Reader

+ IsPiped bool

+ IsTTY bool

+ Out io.Writer

+ func DefaultStream() *Stream

+ func StreamFromContext(ctx context.Context) *Stream

+ type TestEnv struct

+ func NewTestEnv(jail, home, username string) *TestEnv

+ func (m *TestEnv) AtomicWriteFile(rel string, data []byte, perm os.FileMode) error

+ func (m *TestEnv) Clone() *TestEnv

+ func (m *TestEnv) Environ() []string

+ func (m *TestEnv) ExpandPath(p string) string

+ func (m *TestEnv) GetHome() (string, error)

+ func (m *TestEnv) GetJail() string

+ func (m *TestEnv) GetTempDir() string

+ func (m *TestEnv) GetUser() (string, error)

+ func (m *TestEnv) Getwd() (string, error)

+ func (m *TestEnv) Has(key string) bool

+ func (m *TestEnv) Mkdir(rel string, perm os.FileMode, all bool) error

+ func (m *TestEnv) ReadDir(name string) ([]os.DirEntry, error)

+ func (m *TestEnv) ReadFile(rel string) ([]byte, error)

+ func (m *TestEnv) Remove(rel string, all bool) error

+ func (m *TestEnv) Rename(src string, dst string) error

+ func (m *TestEnv) ResolvePath(rel string, follow bool) (string, error)

+ func (m *TestEnv) Set(key string, value string) error

+ func (m *TestEnv) SetHome(rel string) error

+ func (m *TestEnv) SetUser(username string) error

+ func (m *TestEnv) Setwd(dir string)

+ func (m *TestEnv) Stat(rel string, followSymlinks bool) (os.FileInfo, error)

+ func (m *TestEnv) Unset(key string)

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

+ func (m TestEnv) Get(key string) string

+ func (o *TestEnv) Name() string

+ func (o *TestEnv) Symlink(oldname string, newname string) error

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