Documentation Index
Fetch the complete documentation index at: https://docs.mistle.dev/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Sandbox profiles define the execution environment an agent starts with. Use a sandbox profile to control:- the base image or sandbox provider settings
- installed tools and runtimes
- setup scripts
- allowed integrations and connection behavior
- environment configuration required for agent work
Draft And Published Versions
Sandbox profile changes are made as drafts. Publishing a profile version makes that configuration available for new sessions. Published versions are immutable from the point of view of future sessions. To change the environment, edit the draft and publish a new version.Publish A Working Profile
A usable profile usually needs more than a name and base image. Before publishing, configure the pieces the agent will need at runtime:- Create or edit a sandbox profile draft.
- Select the integrations the profile should expose to sessions.
- Add repository or workspace configuration when the agent should work in source code.
- Write and test the setup script.
- Choose whether sessions from this profile should use persistent sandboxes.
- Publish the profile version.
- Wait for the snapshot to become ready.
- Start a session from the published profile.
Setup Scripts
Setup scripts prepare the sandbox environment for the profile. They can install tools, configure agent settings, or prepare dependencies that future sessions need. Setup scripts are important because they make an agent’s starting environment explicit and repeatable. Without a setup script, each session depends on whatever the base image already contains and whatever setup the agent discovers during the task. That can waste time and make failures hard to reproduce. Use setup scripts to:- install required tools and runtimes
- configure package managers, CLIs, and agent settings
- prepare repository-specific dependencies
- warm dependency caches
- run smoke checks that prove the environment is ready
Experiment With Setup Scripts
Setup script changes are made on draft profile versions. Published versions are read-only. To experiment with a setup script:- Open the sandbox profile.
- Edit the draft version.
- Update the Setup script field.
- Use Setup script behavior to confirm where repositories are cloned and which tools are available.
- Select Test setup script to run the script in a temporary sandbox.
- Inspect the test output, adjust the script, and test again.
- Publish the profile version when the script is reliable.
Snapshots
When a profile version is published, Mistle can prepare a snapshot for that version. The snapshot captures the prepared environment so new sessions can start from the profile-specific image instead of rebuilding from the shared base image every time. Read Snapshots for the snapshot lifecycle.Persistent Sandboxes
Draft profile versions can opt into persistent sandboxes when organization persistence is enabled. Use persistent sandboxes when sessions from a profile should retain selected workspace state across compute stops, resumes, or provider expiry. This is experimental and should be used deliberately. Read Persistent Sandboxes for setup steps, limits, and how persistence differs from snapshots.Next Steps
- Read Snapshots to understand prepared profile images.
- Read Persistent Sandboxes to understand experimental per-session state persistence.
- Read Sessions to see how users start work from a profile.
- Read Self-Hosted Configuration for deployment-level sandbox settings.