docs: distinguish sandbox template and agent updates

The template cache description omitted the default registry refresh, and users had no guidance for updating installed agents. Correct the cache behavior and explain generic agent updates and their persistence boundary.
This commit is contained in:
David Karlsson committed 2026-09-16 13:04:05 +00:00
1 parent 0e2fd03379
commit 75d1ee3122
1 file changed
+16 -3
@@ -174,9 +174,22 @@ use `shell` (which drops you into a Bash shell with no agent).
### Template caching
Template images are cached locally. The first use pulls from the registry;
subsequent sandboxes reuse the cache. Cached images persist across sandbox
creation and deletion, and are cleared when you run `sbx reset`.
When creating a sandbox, `sbx` checks the registry for the template image by
default and downloads missing or updated layers. If the pull fails and the
image is cached locally, it can use the cached image. Cached images persist
across sandbox creation and deletion, and are cleared when you run `sbx reset`.
### Updating agents
Agent templates include an agent version, which can differ from the agent's
latest release. Updating the `sbx` CLI or pulling an updated template doesn't
update agents inside existing sandboxes.
To update an installed agent, run its documented update command inside the
sandbox, either from a sandbox shell or with `sbx exec`. Restart the agent
session to use the updated version. The update persists across sandbox stops
and starts, but is deleted when you remove the sandbox. To reuse the updated
agent in other sandboxes, [save a template](#saving-a-sandbox-as-a-template).
## Saving a sandbox as a template