openai · OpenAI Platform Docs
Shell
Teaches how to implement and manage a terminal environment for models using either local execution or OpenAI-hosted containers via the Responses API, including container reuse and network policy configuration.
Derived skill
Files assembled from official documentation
Viewing SKILL.md
Shell
Teaches how to implement and manage a terminal environment for models using either local execution or OpenAI-hosted containers via the Responses API, including container reuse and network policy configuration.
When To Use
Use when you need to enable a model to execute terminal commands, manage persistent container environments across multiple API requests, or configure network access for hosted shell runtimes.
Reference Files
| File | Contains | Use For |
|---|---|---|
SKILL.md | Entry point: scope, routing table, and workflow. | Start here. |
docs/shell-workflow-guide.md | A guide explaining how to use the shell tool for local and hosted execution within a terminal environment via the Responses API. | Questions about a guide explaining how to use the shell tool for local and hosted execution within a terminal environment via the Res... |
examples/shell-openai-shell-tool.javascript | A JavaScript code example demonstrating how to use the OpenAI Shell tool within a client request to execute commands in a containerized environment. | Exact payloads, commands, or snippets shown in A JavaScript code example demonstrating how to use the OpenAI Shell tool within a client request to execute commands... |
examples/shell-openai-shell-tool-python-execution.python | A Python script demonstrating how to use the OpenAI shell tool to execute system commands within a containerized environment. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to use the OpenAI shell tool to execute system commands within a containerized envi... |
examples/shell-openai-shell-container-create.javascript | A JavaScript example demonstrating how to create a new analysis container using the OpenAI Shell API. | Exact payloads, commands, or snippets shown in A JavaScript example demonstrating how to create a new analysis container using the OpenAI Shell API. |
examples/shell-openai-shell-container-create.python | A Python script demonstrating how to create a new shell container using the OpenAI client. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to create a new shell container using the OpenAI client. |
examples/shell-openai-shell-tool-javascript-container-execution.javascript | A JavaScript example demonstrating how to use the OpenAI shell tool to execute commands within a specified container environment. | Exact payloads, commands, or snippets shown in A JavaScript example demonstrating how to use the OpenAI shell tool to execute commands within a specified container... |
examples/shell-openai-shell-tool-python-container-execution.python | A Python script demonstrating how to use the OpenAI shell tool to execute commands within a specified container environment. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to use the OpenAI shell tool to execute commands within a specified container envir... |
examples/shell-openai-platform-shell-container-create.javascript | A JavaScript example demonstrating how to create a container with specific skills using the OpenAI client. | Exact payloads, commands, or snippets shown in A JavaScript example demonstrating how to create a container with specific skills using the OpenAI client. |
examples/shell-openai-platform-shell-python-container-creation.python | A Python script demonstrating how to create a container with specific skill references using the OpenAI platform shell client. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to create a container with specific skill references using the OpenAI platform shel... |
examples/shell-openai-shell-tool-2.javascript | A JavaScript code example demonstrating how to use the OpenAI Shell tool with a containerized environment and network allowlist. | Exact payloads, commands, or snippets shown in A JavaScript code example demonstrating how to use the OpenAI Shell tool with a containerized environment and network... |
examples/shell-openai-shell-tool.python | A Python script demonstrating how to use the OpenAI shell tool with a containerized environment and domain allowlisting. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to use the OpenAI shell tool with a containerized environment and domain allowlisting. |
examples/shell-openai-platform-docs-shell-javascript-inline-skill-container-creat.javascript | A JavaScript example demonstrating how to create an inline skill container using the OpenAI client to process local files. | Exact payloads, commands, or snippets shown in A JavaScript example demonstrating how to create an inline skill container using the OpenAI client to process local f... |
examples/shell-openai-platform-shell-python-inline-skill-container-creation.python | A Python script demonstrating how to create an inline skill container by encoding a ZIP file and a CSV file into base64 for the OpenAI Shell tool. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to create an inline skill container by encoding a ZIP file and a CSV file into base... |
examples/shell-openai-platform-docs-shell-javascript-container-delete.javascript | A JavaScript code example demonstrating how to use the OpenAI client to delete a specific container via the shell tool. | Exact payloads, commands, or snippets shown in A JavaScript code example demonstrating how to use the OpenAI client to delete a specific container via the shell tool. |
examples/shell-openai-platform-docs-shell-python-container-deletion.python | A Python script demonstrating how to use the OpenAI client to delete a specific container via the shell interface. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to use the OpenAI client to delete a specific container via the shell interface. |
examples/shell-openai-shell-tool-3.javascript | A JavaScript code example demonstrating how to use the OpenAI shell tool within a client request to execute commands in a containerized environment. | Exact payloads, commands, or snippets shown in A JavaScript code example demonstrating how to use the OpenAI shell tool within a client request to execute commands... |
examples/shell-openai-shell-tool-2.python | A Python script demonstrating how to use the OpenAI Shell tool to execute curl commands within a containerized environment. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to use the OpenAI Shell tool to execute curl commands within a containerized enviro... |
examples/shell-openai-shell-tool-4.javascript | A JavaScript code example demonstrating how to use the OpenAI Shell tool within a responses creation request. | Exact payloads, commands, or snippets shown in A JavaScript code example demonstrating how to use the OpenAI Shell tool within a responses creation request. |
examples/shell-openai-shell-tool-3.python | A Python script demonstrating how to use the OpenAI shell tool to execute commands within a containerized environment. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to use the OpenAI shell tool to execute commands within a containerized environment. |
What This Skill Covers
- The shell tool gives models the ability to work inside a complete terminal environment. We support shell for local execution and for hosted execution through...
- Main sections:
Hosted shell quickstart,Hosted runtime details,Reuse a container across requests,1. Create a container,2. Reference the container in Responses.
Workflow
- Open the most relevant file under
docs/for the exact documented workflow and wording. - Open
schemas/files for exact structured contracts. - Open
examples/files for concrete requests, commands, snippets, and manifests. - Do not add behavior or configuration that is not present in the attached source files.
Canonical source: https://developers.openai.com/api/docs/guides/tools-shell.md