boxxkite-sandbox 0.2.3__tar.gz

boxxkite_sandbox-0.2.3/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 boxxkite contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

boxxkite_sandbox-0.2.3/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: boxxkite-sandbox
+Version: 0.2.3
+Summary: A self-hostable, Kubernetes-native sandbox for agent code execution — pod-per-session isolation plus a complete bash/python/file tool surface.
+Author: boxxkite contributors
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/EvAlssment/boxxkite
+Project-URL: Repository, https://github.com/EvAlssment/boxxkite
+Project-URL: Issues, https://github.com/EvAlssment/boxxkite/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Topic :: Security
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: kubernetes_asyncio>=29.0.0
+Requires-Dist: aiohttp<4,>=3.10
+Requires-Dist: typer<1,>=0.12
+Requires-Dist: cryptography>=42
+Requires-Dist: tomli-w<2,>=1.0
+Provides-Extra: langchain
+Requires-Dist: langchain-core<2,>=1.0; extra == "langchain"
+Provides-Extra: llamaindex
+Requires-Dist: llama-index-core<1,>=0.11; extra == "llamaindex"
+Provides-Extra: openai-agents
+Requires-Dist: openai-agents<1,>=0.18; extra == "openai-agents"
+Provides-Extra: dev
+Requires-Dist: boxxkite-sandbox[langchain,llamaindex,openai-agents]; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.24; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: pip-audit>=2.7; extra == "dev"
+Dynamic: license-file
+
+# boxxkite-sandbox
+
+**The missing batteries-included, self-hostable sandbox for agent code execution.**
+
+Most "agent sandbox" projects give you raw isolation — a pod, a VM, a
+container — and leave you to build the tool surface an LLM agent needs on
+top of it. boxxkite is the other half: a complete `bash`/`python`/file/
+search/process tool surface (15 framework-agnostic tools — LangChain,
+LangGraph, CrewAI, AutoGen, LlamaIndex, or plain OpenAI-style function
+calling) running inside real Kubernetes pod isolation, hardened with
+non-root execution, dropped Linux capabilities, a read-only root
+filesystem, default-deny network egress, and secret-scrubbed command
+output.
+
+**Who this is for:** teams *building their own agent products* that need
+isolated, multi-tenant code execution at scale — one Kubernetes pod per
+session, many sessions, many tenants. If you just want your own coding
+assistant to run shell commands on your own machine, this is the wrong
+layer.
+
+## Install
+
+```bash
+pip install boxxkite-sandbox
+```
+
+Note the PyPI name is `boxxkite-sandbox`, not `boxxkite` (already taken) —
+the import path is unaffected: `import boxxkite`.
+
+## Quickstart
+
+```bash
+git clone https://github.com/EvAlssment/boxxkite.git boxxkite && cd boxxkite
+pip install -e .
+boxxkite up
+boxxkite exec "python3 -c 'print(1 + 1)'"
+```
+
+```python
+from uuid import uuid4
+from boxxkite import SandboxManager
+from boxxkite.tools import create_sandbox_tool_specs
+
+manager = SandboxManager()
+session_id = str(uuid4())
+await manager.create_session(organization_id=uuid4(), session_id=session_id)
+
+specs = create_sandbox_tool_specs(sandbox_manager=manager, session_id=session_id)
+bash_tool = next(s for s in specs if s.name == "bash_tool")
+result = await bash_tool.handler(command="echo hello from boxxkite")
+```
+
+`boxxkite.tools.adapters` converts the same tool specs for LangChain,
+LlamaIndex, the OpenAI Agents SDK, or plain OpenAI/Anthropic/Gemini/Mistral
+function-calling schemas — see the full integration table and every other
+runtime mode (real Kubernetes, docker-compose, the `boxxkite` CLI) in the
+[full README](https://github.com/EvAlssment/boxxkite#readme).
+
+## Security
+
+boxxkite executes arbitrary, agent-generated code — its security posture is
+layered defense in depth (non-root, dropped capabilities, read-only
+filesystem, per-exec network isolation, no credential injection into
+`/exec`). See [SECURITY.md](https://github.com/EvAlssment/boxxkite/blob/main/SECURITY.md)
+for the full model and known follow-ups before deploying this beyond local dev.
+
+## License
+
+[Apache 2.0](https://github.com/EvAlssment/boxxkite/blob/main/LICENSE) —
+permissive with an explicit patent grant, no restriction on self-hosting or competing hosted use.
+
+## Links
+
+[GitHub](https://github.com/EvAlssment/boxxkite) ·
+[Full README](https://github.com/EvAlssment/boxxkite#readme) ·
+[Docs](https://github.com/EvAlssment/boxxkite/tree/main/docs) ·
+[Issues](https://github.com/EvAlssment/boxxkite/issues)

boxxkite_sandbox-0.2.3/PYPI_README.md

@@ -0,0 +1,77 @@
+# boxxkite-sandbox
+
+**The missing batteries-included, self-hostable sandbox for agent code execution.**
+
+Most "agent sandbox" projects give you raw isolation — a pod, a VM, a
+container — and leave you to build the tool surface an LLM agent needs on
+top of it. boxxkite is the other half: a complete `bash`/`python`/file/
+search/process tool surface (15 framework-agnostic tools — LangChain,
+LangGraph, CrewAI, AutoGen, LlamaIndex, or plain OpenAI-style function
+calling) running inside real Kubernetes pod isolation, hardened with
+non-root execution, dropped Linux capabilities, a read-only root
+filesystem, default-deny network egress, and secret-scrubbed command
+output.
+
+**Who this is for:** teams *building their own agent products* that need
+isolated, multi-tenant code execution at scale — one Kubernetes pod per
+session, many sessions, many tenants. If you just want your own coding
+assistant to run shell commands on your own machine, this is the wrong
+layer.
+
+## Install
+
+```bash
+pip install boxxkite-sandbox
+```
+
+Note the PyPI name is `boxxkite-sandbox`, not `boxxkite` (already taken) —
+the import path is unaffected: `import boxxkite`.
+
+## Quickstart
+
+```bash
+git clone https://github.com/EvAlssment/boxxkite.git boxxkite && cd boxxkite
+pip install -e .
+boxxkite up
+boxxkite exec "python3 -c 'print(1 + 1)'"
+```
+
+```python
+from uuid import uuid4
+from boxxkite import SandboxManager
+from boxxkite.tools import create_sandbox_tool_specs
+
+manager = SandboxManager()
+session_id = str(uuid4())
+await manager.create_session(organization_id=uuid4(), session_id=session_id)
+
+specs = create_sandbox_tool_specs(sandbox_manager=manager, session_id=session_id)
+bash_tool = next(s for s in specs if s.name == "bash_tool")
+result = await bash_tool.handler(command="echo hello from boxxkite")
+```
+
+`boxxkite.tools.adapters` converts the same tool specs for LangChain,
+LlamaIndex, the OpenAI Agents SDK, or plain OpenAI/Anthropic/Gemini/Mistral
+function-calling schemas — see the full integration table and every other
+runtime mode (real Kubernetes, docker-compose, the `boxxkite` CLI) in the
+[full README](https://github.com/EvAlssment/boxxkite#readme).
+
+## Security
+
+boxxkite executes arbitrary, agent-generated code — its security posture is
+layered defense in depth (non-root, dropped capabilities, read-only
+filesystem, per-exec network isolation, no credential injection into
+`/exec`). See [SECURITY.md](https://github.com/EvAlssment/boxxkite/blob/main/SECURITY.md)
+for the full model and known follow-ups before deploying this beyond local dev.
+
+## License
+
+[Apache 2.0](https://github.com/EvAlssment/boxxkite/blob/main/LICENSE) —
+permissive with an explicit patent grant, no restriction on self-hosting or competing hosted use.
+
+## Links
+
+[GitHub](https://github.com/EvAlssment/boxxkite) ·
+[Full README](https://github.com/EvAlssment/boxxkite#readme) ·
+[Docs](https://github.com/EvAlssment/boxxkite/tree/main/docs) ·
+[Issues](https://github.com/EvAlssment/boxxkite/issues)

boxxkite_sandbox-0.2.3/README.md

@@ -0,0 +1,255 @@
+<p align="center">
+  <img src="assets/logo.svg" alt="boxxkite" width="72" height="72">
+</p>
+
+<h1 align="center">boxxkite</h1>
+
+<p align="center">
+  <a href="LICENSE"><img alt="License: Apache 2.0" src="https://img.shields.io/badge/license-Apache%202.0-blue"></a>
+  <a href="https://github.com/EvAlssment/boxxkite/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/EvAlssment/boxxkite/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="https://pypi.org/project/boxxkite-sandbox/"><img alt="PyPI" src="https://img.shields.io/pypi/v/boxxkite-sandbox?label=PyPI"></a>
+  <a href="https://www.npmjs.com/package/boxxkite-client"><img alt="npm" src="https://img.shields.io/npm/v/boxxkite-client?label=npm"></a>
+  <a href="https://pkg.go.dev/github.com/EvAlssment/boxxkite/sdk-go"><img alt="Go Reference" src="https://pkg.go.dev/badge/github.com/EvAlssment/boxxkite/sdk-go.svg"></a>
+  <a href="https://crates.io/crates/boxxkite-client"><img alt="crates.io" src="https://img.shields.io/crates/v/boxxkite-client.svg"></a>
+</p>
+
+<p align="center">
+  <a href="https://boxxkite-site.vercel.app">Website</a> ·
+  <a href="#quickstart">Quickstart</a> ·
+  <a href="https://boxxkite-site.vercel.app/developers">Docs</a> ·
+  <a href="#self-hosting">Self-hosting</a> ·
+  <a href="#security">Security</a> ·
+  <a href="examples/">Examples</a>
+</p>
+
+<p align="center">
+  <a href="https://boxxkite-site.vercel.app" title="Watch the boxxkite demo">
+    <img src="assets/boxxkite-platform-poster.jpg" alt="boxxkite platform overview — click to watch the demo" width="800">
+  </a>
+</p>
+<p align="center">
+  <a href="https://boxxkite-site.vercel.app">▶ Watch the demo</a>
+</p>
+
+**The missing batteries-included, self-hostable sandbox for agent code execution.**
+
+Most "agent sandbox" projects give you raw isolation — a pod, a VM, a container —
+and leave you to build the tool surface an LLM agent actually needs on top of it.
+boxxkite is the other half: a complete `bash`/`python`/file/search/process tool
+surface running inside real Kubernetes pod isolation, self-hostable end to end.
+Point your agent framework at it and you have a real sandbox in minutes, on
+infrastructure you control.
+
+- **15 framework-agnostic tools** (plus an opt-in 8-tool git set) — LangChain,
+  LangGraph, LlamaIndex, CrewAI, AutoGen, the OpenAI Agents SDK, or plain
+  function calling, with no required dependency on any of them
+- **One Kubernetes pod per session** — non-root, all capabilities dropped,
+  read-only root filesystem, network egress denied by default
+- **A hosted-API control-plane you run yourself** — accounts, API keys,
+  fair-use limits, and client SDKs in four languages, if you want a real
+  multi-tenant API in front of the sandbox instead of embedding it directly
+- **CLI, MCP server, Helm chart, and a one-click Render deploy** for the
+  control-plane — see [Self-hosting](#self-hosting)
+- **Nothing held back.** Every piece here — runtime, control-plane, all four
+  SDKs, the MCP server — is Apache-2.0-licensed and self-hostable; there's no
+  separate closed hosted-only tier
+
+**Who this is for:** teams *building their own agent products* that need
+isolated, multi-tenant code execution at scale. It's **not** a single-user
+local dev-session sandbox like the built-in `bash` tool in an IDE or CLI
+coding agent — if you just want your own assistant to run shell commands on
+your machine, boxxkite is the wrong layer.
+
+## Start Here
+
+If you are new to the repo, use this decision tree:
+
+1. **I just want to try the sandbox locally**  
+   Use `boxxkite up` from the Quickstart below. This is the fastest path and
+   does not require Kubernetes.
+2. **I want the real Kubernetes deployment on my laptop**  
+   Use [`deploy/local-kind/README.md`](deploy/local-kind/README.md). It
+   explains the kind-based flow, the Apple Silicon limitation, and the
+   `kubectl proxy` step.
+3. **I want the hosted API / multi-tenant control-plane**  
+   Use the control-plane section below, then the
+   [`examples/hosted_control_plane/`](examples/hosted_control_plane/) guide.
+
+For contributors, the important mental model is: the root package gives you
+the sandbox runtime, while `control-plane/`, the SDKs, and `mcp-server/` are
+separate packages with their own installs and tests.
+
+## Quickstart
+
+Clone the repo, create a virtualenv, install the root package, then start
+the local stack:
+
+```bash
+git clone https://github.com/EvAlssment/boxxkite.git boxxkite && cd boxxkite
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+boxxkite up                # builds + starts sandbox, sidecar, and local MinIO
+boxxkite exec "python3 -c 'print(1 + 1)'"
+```
+
+> The PyPI name is `boxxkite-sandbox`, not `boxxkite` (already taken). Install
+> it with `pip install -e ".[dev]"` from the repo root; the import path
+> (`import boxxkite`) and the `boxxkite` CLI command are unaffected.
+
+If `boxxkite up` succeeds, the quickest smoke test is:
+
+```bash
+boxxkite exec "python3 -c 'print(1 + 1)'"
+boxxkite files ls /
+```
+
+That confirms the sandbox, the sidecar, and the CLI are talking to each other
+correctly.
+
+```python
+from uuid import uuid4
+from boxxkite import SandboxManager
+from boxxkite.tools import create_sandbox_tool_specs
+
+manager = SandboxManager()
+session_id = str(uuid4())
+await manager.create_session(organization_id=uuid4(), session_id=session_id)
+
+specs = create_sandbox_tool_specs(sandbox_manager=manager, session_id=session_id)
+bash_tool = next(s for s in specs if s.name == "bash_tool")
+result = await bash_tool.handler(command="echo hello from boxxkite")
+```
+
+Framework adapters (`boxxkite.tools.adapters`) convert the same tool specs for
+LangChain, LlamaIndex, the OpenAI Agents SDK, or plain OpenAI/Anthropic/
+Gemini/Mistral function-calling schemas — see the
+[full integration guide](https://boxxkite-site.vercel.app/developers/guides/quickstart)
+and [`examples/`](examples/) for a runnable version of every framework.
+
+## Self-hosting
+
+Everything in this repo — including the `control-plane/` hosted multi-tenant
+API — is something you deploy yourself:
+
+- **Real Kubernetes** — two steps. First lay down the cluster prerequisites
+  (RBAC, NetworkPolicy, pod-security admission policy, ServiceAccount,
+  Config/Secret scaffolding) by applying `deploy/rbac.yaml`/
+  `network-policy.yaml`/`pod-security-policy.yaml`, or
+  `helm install boxxkite deploy/helm/boxxkite`. This chart does **not** deploy
+  the control-plane itself (it has no Deployment/Service) — the per-session
+  sandbox pods are created programmatically by the control-plane at runtime.
+  Then deploy the `control-plane/` API separately (see the Render button
+  below or the [developer docs](https://boxxkite-site.vercel.app/developers)).
+  A local `kind` cluster works too: `./deploy/local-kind/setup.sh`.
+- **One-click Render deploy** for the control-plane API —
+  [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/EvAlssment/boxxkite)
+  (still needs a real Kubernetes cluster for actual sandbox execution).
+- **docker-compose**, for local iteration without a cluster — see the
+  Quickstart above.
+
+> docker-compose mode shares a PID namespace with the sandbox container and
+> execs into it via `nsenter`, the same mechanism the Kubernetes runtime
+> uses — it no longer needs (or mounts) the host's Docker socket. See
+> [SECURITY.md](SECURITY.md) for the current list of disclosed limitations.
+
+Full walkthroughs for every path above (Kubernetes, Helm, Render, the
+`boxxkite` CLI's hosted mode, secrets, webhooks, MCP, and every SDK) live on
+the [developer docs site](https://boxxkite-site.vercel.app/developers).
+
+### Run the control-plane locally
+
+The `control-plane/` multi-tenant API is a **separate service** from the
+`boxxkite up` SDK path — it is *not* part of `deploy/docker-compose.yml`, and you
+run it on its own. To bring it up against a throwaway SQLite database (no
+Postgres required) for API exploration:
+
+```bash
+cd control-plane
+uv venv                              # create .venv
+uv pip install -e '../[dev]'         # install the boxxkite runtime (sibling pkg)
+uv pip install -e '.[dev]'           # install the control-plane itself
+ENVIRONMENT=development DATABASE_URL=sqlite+aiosqlite:///./cp.db \
+  uv run uvicorn control_plane.main:app --port 8099
+```
+
+Then check it's up:
+
+- `http://localhost:8099/health` — liveness (process is up)
+- `http://localhost:8099/health/ready` — readiness (round-trips a DB query)
+- `http://localhost:8099/docs` — interactive OpenAPI docs
+
+This gets you the API surface (accounts, API keys, session bookkeeping), but
+**actually executing sandbox pods still needs a real Kubernetes cluster** — the
+control-plane creates per-session pods programmatically at runtime (a local
+`kind` cluster via `deploy/local-kind/setup.sh` works). Against SQLite with no
+cluster you can exercise the HTTP/auth surface, not real code execution.
+
+## What's in this repo
+
+One repo, several independently-versioned pieces, kept together deliberately
+(see [CONTRIBUTING.md](CONTRIBUTING.md)):
+
+| Piece | What it is |
+|---|---|
+| `src/boxxkite/` (`boxxkite-sandbox` on PyPI) | The core: `SandboxManager`, `WarmPoolManager`, and the 15+ tool `boxxkite.tools` surface. Embed this directly against your own cluster. |
+| `sidecar/` | The FastAPI service that runs in every sandbox pod — filesystem I/O, command exec via `nsenter`, storage sync. |
+| `control-plane/` | Optional hosted-API layer in front of `SandboxManager` — accounts, API keys, fair-use limits. |
+| `sdk-python/`, `sdk-js/`, `sdk-go/`, `sdk-rust/` | Thin HTTP clients for *your own* running control-plane. |
+| `mcp-server/` (`boxxkite-mcp`) | Wraps the Python SDK as an MCP tool source for Claude Code, Claude Desktop, Codex, or Cursor. |
+| `handoff-cli/` (`boxxkite-handoff`) | Moves an in-progress local Claude Code/Codex CLI/opencode session into a fresh sandbox, full conversation history included — see [docs/handoff-adapters.md](docs/handoff-adapters.md). Not yet published. |
+| `bastion/` | Standalone SSH server bridging into a session's human-takeover WebSocket. |
+| `deploy/` | Kubernetes manifests, Helm chart, Dockerfiles, docker-compose, Render Blueprint. |
+| `examples/` | Runnable cookbook — LangGraph, LangChain, raw HTTP, OpenAI/Gemini/Mistral function calling, and more. |
+
+## Security
+
+boxxkite executes arbitrary, agent-generated code — its security posture is
+layered defense in depth: a per-pod shared-secret sidecar auth token, a
+fresh empty network namespace on every `exec` call, non-root execution with
+every Linux capability dropped, and a read-only root filesystem. No single
+one of these is meant to stand alone.
+
+See [SECURITY.md](SECURITY.md) for the full model, known limitations, and
+how to report a vulnerability privately — this project runs arbitrary code,
+so a sandbox-escape report deserves a fast, private path, not a public
+issue. The [security model guide](https://boxxkite-site.vercel.app/developers/guides/security-model)
+covers the same ground with runnable examples.
+
+## Published packages and images
+
+| Package | Registry |
+|---|---|
+| `boxxkite-sandbox` | [PyPI](https://pypi.org/project/boxxkite-sandbox/) |
+| `boxxkite-client` (Python) | [PyPI](https://pypi.org/project/boxxkite-client/) |
+| `boxxkite-client` (JS/TS) | [npm](https://www.npmjs.com/package/boxxkite-client) |
+| `boxxkite-mcp` | [PyPI](https://pypi.org/project/boxxkite-mcp/) |
+| `boxxkite-client` (Go) | [pkg.go.dev](https://pkg.go.dev/github.com/EvAlssment/boxxkite/sdk-go) |
+| `boxxkite-client` (Rust) | [crates.io](https://crates.io/crates/boxxkite-client) |
+
+Container images are published to GHCR (`ghcr.io/evalssment/…`):
+
+| Image | Architectures |
+|---|---|
+| `boxxkite-sandbox` | **linux/amd64 only** |
+| `boxxkite-sandbox-minimal` | linux/amd64, linux/arm64 |
+| `boxxkite-sidecar` | linux/amd64, linux/arm64 |
+| `boxxkite-control-plane` | linux/amd64, linux/arm64 |
+
+> **`boxxkite-sandbox` is amd64-only.** Its Dockerfile deliberately hard-fails on
+> arm64 because the pinned Chrome-for-Testing release has no `linux/arm64` build
+> (`deploy/sandbox.Dockerfile`). **arm64 / Apple-Silicon users should use
+> `boxxkite-sandbox-minimal`** (multi-arch, no Chrome/LibreOffice/pandoc stack),
+> or build/run the full image under `linux/amd64` emulation — `docker-compose.yml`
+> already forces `platform: linux/amd64` for exactly this reason. The other three
+> images are multi-arch.
+
+## License
+
+[Apache 2.0](LICENSE) — permissive, with an explicit patent grant. Use, modify, self-host, or build a
+competing hosted service on top of boxxkite; there's no restriction.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) — we use the Developer Certificate of
+Origin (`git commit -s`), not a CLA.