chore: import upstream snapshot with attribution

2026-07-13 13:39:33 +08:00
commit e0e362d700
1949 changed files with 375388 additions and 0 deletions
@@ -0,0 +1,55 @@
+---
+title: Codex CLI
+description: Use the official @openai/codex npm package to call OpenAI/Codex-like models in OpenSandbox.
+---
+
+# Codex/OpenAI CLI Example
+
+Use the official `@openai/codex` npm package to call OpenAI/Codex-like models in OpenSandbox.
+
+## Start OpenSandbox server [local]
+
+Pre-pull the code-interpreter image (includes Node.js):
+
+```shell
+docker pull sandbox-registry.cn-zhangjiakou.cr.aliyuncs.com/opensandbox/code-interpreter:v1.1.0
+
+# use docker hub
+# docker pull opensandbox/code-interpreter:v1.1.0
+```
+
+Start the local OpenSandbox server, logs will be visible in the terminal:
+
+```shell
+uv pip install opensandbox-server
+opensandbox-server init-config ~/.sandbox.toml --example docker
+opensandbox-server
+```
+
+## Create and Access the Codex Sandbox
+
+```shell
+# Install OpenSandbox package
+uv pip install opensandbox
+
+# Run the example (requires SANDBOX_DOMAIN / SANDBOX_API_KEY / OPENAI_API_KEY)
+uv run python examples/codex-cli/main.py
+```
+
+The script installs the Codex CLI (`npm install -g @openai/codex@latest`) at runtime (Node.js is already in the code-interpreter image), then executes a simple request `codex exec "Compute 1+1 and return JSON with keys result and reasoning." --skip-git-repo-check`. Auth is passed via `OPENAI_API_KEY`; you can override endpoint/model with `OPENAI_BASE_URL` / `OPENAI_MODEL`.
+
+## Environment Variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `SANDBOX_DOMAIN` | `localhost:8080` | Sandbox service address |
+| `SANDBOX_API_KEY` | _(optional for local)_ | API key if your server requires authentication |
+| `SANDBOX_IMAGE` | `sandbox-registry.cn-zhangjiakou.cr.aliyuncs.com/opensandbox/code-interpreter:v1.1.0` | Sandbox image to use |
+| `OPENAI_API_KEY` | _(required)_ | Your OpenAI API key |
+| `OPENAI_BASE_URL` | `https://api.openai.com/v1` | OpenAI API endpoint |
+| `OPENAI_MODEL` | `gpt-4o-mini` | Model to use |
+
+## References
+
+- [@openai/codex](https://www.npmjs.com/package/@openai/codex) - Official OpenAI Codex CLI
+- [Source code on GitHub](https://github.com/opensandbox-group/OpenSandbox/tree/main/examples/codex-cli)