Skip to content

docs: document OMNIGENT_CONTAINER_RUNTIME env var for tool sandbox #385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
omnigent-ci wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: document OMNIGENT_CONTAINER_RUNTIME env var for tool sandbox #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
515effb
chore(api): sync openapi.json from omnigent@8a598ed (#356)
omnigent-ci[bot] Jul 22, 2026
ae14edd
docs: document OMNIGENT_CONTAINER_RUNTIME env var for tool sandbox
omnigent-ci[bot] Jul 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions app/docs/build/tools/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,25 @@ tools:
The JSON Schema under `parameters` is optional. If you omit it, Omnigent
auto-generates the schema from the function's type annotations and signature.

### Sandboxed execution

Run Python tools inside a container by adding a `sandbox` block under `tools`.
Set `container_image` to the image to run in; `container_runtime` selects the
container CLI and is either `docker` (the default) or `podman`:

```
tools:
sandbox:
container_image: python:3.12-slim
container_runtime: podman # optional; defaults to docker (or OMNIGENT_CONTAINER_RUNTIME)
```

You can also set the runtime globally with the `OMNIGENT_CONTAINER_RUNTIME`
environment variable (accepted values: `docker`, `podman`). The per-agent
`container_runtime` key takes precedence over the environment variable, so a
spec can always override the global default. When neither is set, the runtime
falls back to `docker`.

## Sub-agent tools

Declare agents as tools so a supervisor agent can delegate work to them. You can define a
Expand Down
Loading