3.4 KiB
title, description, topics, tags, content
| title | description | topics | tags | content | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Use pre-built sandboxes from the OpenShell Community catalog or contribute your own. |
|
|
|
Community Sandboxes
Use pre-built sandboxes from the OpenShell Community catalog, or contribute your own.
What Are Community Sandboxes
Community sandboxes are ready-to-use environments published in the OpenShell Community repository. Each sandbox bundles a Dockerfile, policy, optional skills, and startup scripts into a single package that you can launch with one command.
Current Catalog
The following community sandboxes are available in the catalog.
| Sandbox | Description |
|---|---|
base |
Foundational image with system tools and dev environment |
openclaw |
Open agent manipulation and control |
sdg |
Synthetic data generation workflows |
simulation |
General-purpose simulation sandboxes |
Use a Community Sandbox
Launch a community sandbox by name with the --from flag:
$ openshell sandbox create --from openclaw
When you pass --from with a community sandbox name, the CLI:
- Resolves the name against the OpenShell Community repository.
- Pulls the Dockerfile, policy, skills, and any startup scripts.
- Builds the container image locally.
- Creates the sandbox with the bundled configuration applied.
You end up with a running sandbox whose image, policy, and tooling are all preconfigured by the community package.
Other Sources
The --from flag also accepts:
-
Local directory paths: Point to a directory on disk that contains a Dockerfile and optional policy/skills:
$ openshell sandbox create --from ./my-sandbox-dir -
Container image references: Use an existing container image directly:
$ openshell sandbox create --from my-registry.example.com/my-image:latest
Contribute a Community Sandbox
Each community sandbox is a directory under sandboxes/ in the
OpenShell Community repository.
At minimum, a sandbox directory must contain:
Dockerfile: Defines the container imageREADME.md: Describes the sandbox and how to use it
Optional files:
policy.yaml: Default policy applied when the sandbox launchesskills/: Agent skill definitions bundled with the sandbox- Startup scripts: Any scripts the Dockerfile or entrypoint invokes
To contribute, fork the repository, add your sandbox directory, and open a pull request. Refer to the repository's CONTRIBUTING.md for submission guidelines.
:::{note} The community catalog is designed to grow. If you have built a sandbox that supports a particular workflow (data processing, simulation, code review, or anything else), consider contributing it back so others can use it. :::
Next Steps
Explore related topics:
- To supply API keys or tokens, refer to {doc}
providers. - To customize the sandbox policy, refer to {doc}
policies.