Documentation
¶
Overview ¶
Command sbx gives every branch, task or agent its own copy of a project's backing services, and charges nothing for the ones nobody is using. The program lives in internal/app; this root file is only the entry point and the one thing that has to be here.
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
agentbin
Package agentbin finds a linux sbx binary to run inside a sandbox as its agent.
|
Package agentbin finds a linux sbx binary to run inside a sandbox as its agent. |
|
app
sbx gives every branch, task or agent its own copy of a project's backing services, and charges nothing for the ones nobody is using.
|
sbx gives every branch, task or agent its own copy of a project's backing services, and charges nothing for the ones nobody is using. |
|
devcontainer
Package devcontainer reads a devcontainer.json and turns it into a service sbx can run.
|
Package devcontainer reads a devcontainer.json and turns it into a service sbx can run. |
|
execd
Package execd is the daemon that runs inside a sandbox created through the OpenSandbox API.
|
Package execd is the daemon that runs inside a sandbox created through the OpenSandbox API. |
|
execdctl
Package execdctl is the host's side of execd's control endpoints: seal before a snapshot, re-key after a restore.
|
Package execdctl is the host's side of execd's control endpoints: seal before a snapshot, re-key after a restore. |
|
fc
Package fc drives Firecracker: its REST API over a unix socket, the firecracker process that serves it, the pinned binary and guest kernel, and the root filesystem a VM boots from.
|
Package fc drives Firecracker: its REST API over a unix socket, the firecracker process that serves it, the pinned binary and guest kernel, and the root filesystem a VM boots from. |
|
fc/fcfake
Package fcfake is a Firecracker API server that keeps state and never boots anything.
|
Package fcfake is a Firecracker API server that keeps state and never boots anything. |
|
fc/guestinit
Package guestinit is PID 1 inside a Firecracker VM: `sbx fc-init`.
|
Package guestinit is PID 1 inside a Firecracker VM: `sbx fc-init`. |
|
fc/hostcap
Package hostcap answers one question before anything microVM-shaped is attempted: on this machine, which way - if any - can a Firecracker VM be run?
|
Package hostcap answers one question before anything microVM-shaped is attempted: on this machine, which way - if any - can a Firecracker VM be run? |
|
fchost
Package fchost decides where a Firecracker microVM can run from the machine sbx is on, and when that is not this machine, runs one that can.
|
Package fchost decides where a Firecracker microVM can run from the machine sbx is on, and when that is not this machine, runs one that can. |
|
fcvsock
Package fcvsock dials a port inside a Firecracker microVM from the host.
|
Package fcvsock dials a port inside a Firecracker microVM from the host. |
|
features
Package features is the gate in front of anything not yet proven.
|
Package features is the gate in front of anything not yet proven. |
|
history
Package history is the answer to "what happened to this sandbox, and who did it".
|
Package history is the answer to "what happened to this sandbox, and who did it". |
|
hostinfo
Package hostinfo reports what the machine a person is sitting at has.
|
Package hostinfo reports what the machine a person is sitting at has. |
|
jupyter
Package jupyter is the code-interpreter engine behind execd's /code routes: it runs code in Jupyter kernels through a Jupyter Server that the sandbox image provides, and turns what the kernel says into execd's server-sent events.
|
Package jupyter is the code-interpreter engine behind execd's /code routes: it runs code in Jupyter kernels through a Jupyter Server that the sandbox image provides, and turns what the kernel says into execd's server-sent events. |
|
mcp
Package mcp is a Model Context Protocol server over stdio: JSON-RPC 2.0, one message per line, requests in on stdin and answers out on stdout.
|
Package mcp is a Model Context Protocol server over stdio: JSON-RPC 2.0, one message per line, requests in on stdin and answers out on stdout. |
|
osb
Package osb serves OpenSandbox's lifecycle API from inside `sbx serve`.
|
Package osb serves OpenSandbox's lifecycle API from inside `sbx serve`. |
|
osbclient
Package osbclient speaks the OpenSandbox HTTP contract: the lifecycle API (`/v1/sandboxes`) and execd, the per-sandbox agent that runs commands and touches files.
|
Package osbclient speaks the OpenSandbox HTTP contract: the lifecycle API (`/v1/sandboxes`) and execd, the per-sandbox agent that runs commands and touches files. |
|
osbclient/osbtest
Package osbtest is a fake OpenSandbox server - lifecycle API and execd - for tests of anything that speaks the contract.
|
Package osbtest is a fake OpenSandbox server - lifecycle API and execd - for tests of anything that speaks the contract. |
|
procid
Package procid identifies a process across pid reuse.
|
Package procid identifies a process across pid reuse. |
|
selfstat
Package selfstat reads the resource usage of the container this process is in, from its own cgroup - no container runtime and no socket required.
|
Package selfstat reads the resource usage of the container this process is in, from its own cgroup - no container runtime and no socket required. |
|
snapshotpause
Package snapshotpause marks a container as paused by `sbx snapshot`, so the daemon can tell that pause from a freeze.
|
Package snapshotpause marks a container as paused by `sbx snapshot`, so the daemon can tell that pause from a freeze. |
|
update
Package update answers "is there a newer sbx" without ever making anybody wait for it.
|
Package update answers "is there a newer sbx" without ever making anybody wait for it. |
|
wsclient
Package wsclient is the client half of RFC 6455, standard library only.
|
Package wsclient is the client half of RFC 6455, standard library only. |
|
wsclient/wstest
Package wstest is a deliberately literal WebSocket server for tests of clients.
|
Package wstest is a deliberately literal WebSocket server for tests of clients. |
|
wsserver
Package wsserver is the server half of RFC 6455, standard library only.
|
Package wsserver is the server half of RFC 6455, standard library only. |
Click to show internal directories.
Click to hide internal directories.