Files
OpenShell/docs/sandboxes/community-sandboxes.md
Miyoung ChoiandKirit93 c420109a6a docs: add dedicated gateway docs, network policy tutorial, and license page (#294)
* Added gateway and tutorial

* add new content and polish, add license terms

* small fix

* tiny fix

* polish bit more

* change warning to important

* fix support matrix

* small fix

* add a note about example script

* fix link

* fix link

* improve

* fix links

* unclutter sandbax index more

* improve titles

* tiny style fix

* style guide on inferences, release notes link to gh

* polish

* nit

* switch version to 0.0.3

* incorporate feedback

---------

Co-authored-by: Kirit93 <kthadaka@nvidia.com>
2026-03-14 09:53:01 -07:00

3.6 KiB

title, description, topics, tags, content
title description topics tags content
page nav
Community Sandboxes Community Sandboxes
Use pre-built sandboxes from the OpenShell Community catalog or contribute your own.
Generative AI
Cybersecurity
Community
Sandbox
Container Image
Open Source
type difficulty audience
concept technical_beginner
engineer
data_scientist

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:

  1. Resolves the name against the OpenShell Community repository.
  2. Pulls the Dockerfile, policy, skills, and any startup scripts.
  3. Builds the container image locally.
  4. 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 the following files:

  • Dockerfile that defines the container image.
  • README.md that describes the sandbox and how to use it.

You can also include the following optional files:

  • policy.yaml that defines the default policy applied when the sandbox launches.
  • skills/ that contains agent skill definitions bundled with the sandbox.
  • Startup scripts that are 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:

  • Need to supply API keys or tokens? Set up {doc}manage-providers for credential management.
  • Want to customize the sandbox policy? Write custom rules in {doc}policies.