# isol8

> Secure code execution engine for AI agents. Run untrusted code in Docker containers with strict resource limits, network controls, and output sanitization.

## Docs

- [Agent in a Box](https://isol8.notdhruv.com/agent-in-a-box.md): Run a full coding agent — pi — inside an isol8 sandbox. Give an LLM a filesystem, tools, and controlled network access in a single execute() call.
- [Architecture](https://isol8.notdhruv.com/architecture.md): How isol8 is structured internally: engines, server sessions, runtime adapters, container pools, and security/data pipelines.
- [How to CLI](https://isol8.notdhruv.com/cli.md): Detailed command-line guide for isol8 with flag-by-flag behavior for run, setup, build, serve, config, and cleanup commands.
- [Configuration reference](https://isol8.notdhruv.com/configuration.md): Detailed reference for isol8.config.json, merge behavior, defaults, and operational guidance for each section.
- [Execution guide](https://isol8.notdhruv.com/execution.md): Run code via CLI, Library, or API: modes, streaming, file I/O, and resource limits.
- [FAQ](https://isol8.notdhruv.com/faq.md): Detailed answers to common isol8 questions across execution modes, sessions, networking, runtimes, limits, remote API, and config behavior.
- [File Systems](https://isol8.notdhruv.com/file-systems.md): Understand how isol8 manages file systems, including read-only root environments and memory-backed tmpfs mounts.
- [AI agent code execution](https://isol8.notdhruv.com/guides/ai-agents.md): Build AI agents that generate and run code safely with isol8 using stateless and stateful execution patterns.
- [Benchmarking isol8](https://isol8.notdhruv.com/guides/benchmarking.md): Run and interpret isol8 benchmarks locally and on GitHub Actions runners.
- [CI and automated testing](https://isol8.notdhruv.com/guides/ci-testing.md): Run untrusted test suites, syntax checks, linting, and build validation safely in isolated containers.
- [Data processing](https://isol8.notdhruv.com/guides/data-processing.md): Process untrusted datasets safely with isol8 using stdin transforms, file pipelines, package installs, and persistent sessions.
- [Debugging isol8 workflows](https://isol8.notdhruv.com/guides/debugging.md): Debug execution behavior with engine logs, persisted containers, network traces, and reproducible step-by-step isolation.
- [Education and online judges](https://isol8.notdhruv.com/guides/education.md): Build secure coding classrooms, playgrounds, and auto-graders with isol8 using deterministic limits, verdict pipelines, and multi-language execution.
- [Self-Hosted Lambda Alternative](https://isol8.notdhruv.com/guides/lambda-alternative.md): Use isol8 as a high-performance, secure, and low-cost alternative to AWS Lambda for executing untrusted code.
- [Multi-runtime workflows](https://isol8.notdhruv.com/guides/multi-runtime.md): Design Python, Node, Bun, Deno, and Bash pipelines with explicit runtime boundaries, safe handoffs, and predictable session behavior.
- [One-shot coding agents](https://isol8.notdhruv.com/guides/one-shot-coding-agents.md): Build your own Stripe Minions — unattended coding agents that clone a repo, implement a task, verify the result, and open a PR — with no human in the loop.
- [Persistent execution guide](https://isol8.notdhruv.com/guides/persistent-execution.md): How to run persistent containers and interact with them repeatedly via Library, CLI, and API.
- [Web scraping with network controls](https://isol8.notdhruv.com/guides/web-scraping.md): Run scraping and API-fetch workloads safely using filtered networking, hostname policy rules, and secret-aware execution.
- [Overview](https://isol8.notdhruv.com/index.md): What isol8 includes: secure execution, pooling, network controls, persistence, remote server/client, and observability.
- [Library reference](https://isol8.notdhruv.com/library.md): Detailed TypeScript API guide for DockerIsol8 and RemoteIsol8, with option-by-option descriptions and lifecycle behavior.
- [Maxions](https://isol8.notdhruv.com/maxions.md): A reference implementation of unattended, one-shot AI coding agents built on isol8 — demonstrating what you can ship with isol8 as your execution layer.
- [Observability and audit](https://isol8.notdhruv.com/observability.md): Detailed observability guide for isol8: debug logging, audit records, resource telemetry, and network-level execution insights.
- [Option mapping (CLI, config, API, library)](https://isol8.notdhruv.com/option-mapping.md): Complete mapping of isol8 values across CLI flags, isol8.config.json, API payloads, and TypeScript options.
- [Packages & Images](https://isol8.notdhruv.com/packages.md): How to manage dependencies: on-the-fly installation and custom Docker images.
- [Performance tuning](https://isol8.notdhruv.com/performance.md): Tune isol8 for latency and throughput: pool strategy, pool sizing, concurrency controls, streaming behavior, and package install cost.
- [Data and persistence](https://isol8.notdhruv.com/persistence.md): Detailed guide to persistent execution, state sharing, file movement, session lifecycle, and when to choose ephemeral vs persistent mode.
- [Quickstart](https://isol8.notdhruv.com/quickstart.md): Install isol8, build runtime images, run your first secure execution, and understand what to check at each step.
- [Remote server and client](https://isol8.notdhruv.com/remote.md): Run isol8 as an HTTP service with auth, sessions, streaming, file APIs, and RemoteIsol8 integration patterns.
- [Remote Code URLs](https://isol8.notdhruv.com/remote-code.md): Fetch and execute source code from URLs with SSRF controls, hash verification, and strict policy configuration.
- [Runtime reference](https://isol8.notdhruv.com/runtimes.md): Supported runtimes, extension mapping, module behavior, and package-install semantics for Python, Node, Bun, Deno, Bash, and Agent.
- [Safety for Humans](https://isol8.notdhruv.com/safety-for-humans.md): A non-technical guide to why you need isol8 for your AI agents.
- [Security model and network controls](https://isol8.notdhruv.com/security.md): Understand isol8 hardening layers: network modes, filtered egress policy, seccomp, process and filesystem guards, and secret masking behavior.
- [Revoke API key](https://isol8.notdhruv.com/server/delete-auth-keys.md): Revoke a DB-backed API key by ID, permanently disabling it.
- [Delete session](https://isol8.notdhruv.com/server/delete-session.md): Stop and remove a persistent session container by ID.
- [List API keys](https://isol8.notdhruv.com/server/get-auth-keys.md): List all DB-backed API keys, optionally filtered by tenant.
- [Execute stream (WebSocket)](https://isol8.notdhruv.com/server/get-execute-ws.md): Stream execution output over a persistent WebSocket connection with bidirectional messaging.
- [Download file](https://isol8.notdhruv.com/server/get-file.md): Download base64-encoded file content from an active persistent session.
- [Health](https://isol8.notdhruv.com/server/get-health.md): Health check endpoint for isol8 server status and version.
- [List sessions](https://isol8.notdhruv.com/server/get-sessions.md): Return all active persistent sessions with their status and last-accessed timestamp.
- [Server overview](https://isol8.notdhruv.com/server/overview.md): Run isol8 as an authenticated HTTP execution service with concurrency control, persistent sessions, file APIs, streaming, and auto-pruning.
- [Create API key](https://isol8.notdhruv.com/server/post-auth-keys.md): Create a new DB-backed API key with optional tenant scoping and TTL.
- [Login (exchange for token)](https://isol8.notdhruv.com/server/post-auth-login.md): Exchange the master key for a short-lived API token.
- [Remote cleanup](https://isol8.notdhruv.com/server/post-cleanup.md): Trigger authenticated cleanup of sessions, containers, and optional images.
- [Execute](https://isol8.notdhruv.com/server/post-execute.md): Run code and return buffered execution results.
- [Execute stream](https://isol8.notdhruv.com/server/post-execute-stream.md): Run code and stream output as Server-Sent Events.
- [Upload file](https://isol8.notdhruv.com/server/post-file.md): Upload base64-encoded file content into an active persistent session.
- [Routes index](https://isol8.notdhruv.com/server/routes.md): Server route catalog for health, execute, streaming, file transfer, session lifecycle, and auth management endpoints.
- [Setup scripts](https://isol8.notdhruv.com/setup-scripts.md): Run shell commands before every execution — at image build time or per request — to install tools, configure git, clone repos, or prepare any environment state.
- [Troubleshooting](https://isol8.notdhruv.com/troubleshooting.md): Detailed, code-backed diagnosis for setup failures, runtime errors, networking policy issues, session lifecycle bugs, and remote API problems.
- [Benchmarks](https://isol8.notdhruv.com/tti-benchmarks.md): All local isol8 benchmark suites: cold spawn, warm pool, detailed phase breakdown, and ComputeSDK-style TTI.

## OpenAPI Specs

- [openapi](https://isol8.notdhruv.com/api-reference/openapi.json)