-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathdoc.go
More file actions
26 lines (26 loc) · 1.19 KB
/
Copy pathdoc.go
File metadata and controls
26 lines (26 loc) · 1.19 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// Package gbash provides the primary embedding API for the gbash sandbox.
//
// The root package is the intended entry point for most callers. It exposes
// the runtime, session, execution request/result types, and the opinionated
// configuration helpers that cover the common embedding cases:
//
// - create an isolated in-memory sandbox with [New]
// - mount a real host directory into the sandbox with [WithWorkspace]
// - enable allowlisted HTTP access for curl with [WithHTTPAccess] or
// [WithNetwork]
// - customize the registry, policy, or filesystem with explicit options when
// you need lower-level control
//
// Most embedders should only import the root package. Advanced integrations may
// also import the supported extension packages:
//
// - commands for custom command authorship and registry customization
// - fs for custom filesystem backends and factories
// - network for sandbox HTTP client customization
// - policy for sandbox policy implementations
// - trace for structured execution event consumption when callers opt in to
// tracing on the runtime
//
// Packages under internal/ and other undocumented subpackages are not public
// API.
package gbash