container_run
Run a container from an image in a single call, with options for detaching, ports, volumes, and environment variables to control execution and capture output.
Instructions
Run a container from an image (create and start in one call, like docker run).
Use container_create to prepare a container without starting it, or container_exec to run
a command in a container that already exists. With detach=False the call blocks until the
container exits and returns its output, so long-running images need detach=True. Created
containers are stamped with provenance labels.
args:
image - The image to run
command - The command to run in the container
name - Name to assign to the container
detach - Run in the background and return container info
environment - Environment variables to set
ports - Port mappings, e.g. {'2222/tcp': 3333}
volumes - Volumes to mount
network - Name of the network to attach
hostname - Optional hostname for the container
user - Username or UID to run as
working_dir - Working directory inside the container
entrypoint - Entrypoint to override the image default
restart_policy - Restart policy, e.g. {'Name': 'on-failure', 'MaximumRetryCount': 3}
labels - Labels to set on the container
remove - Remove the container when it exits (only with detach=False)
auto_remove - Enable auto-removal of the container on daemon side
privileged - Give extended privileges to the container
tty - Allocate a pseudo-TTY
stdin_open - Keep STDIN open
mem_limit - Memory limit
cpu_count - Number of CPUs
extra_kwargs - Additional keyword arguments forwarded to ContainerCollection.run (call
docs_lookup(section="containers") for the full accepted set)
returns: dict | str - Container attrs when detach=True, otherwise stdout/stderr as a string
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tty | No | ||
| name | No | ||
| user | No | ||
| image | Yes | ||
| ports | No | ||
| detach | No | ||
| labels | No | ||
| remove | No | ||
| command | No | ||
| network | No | ||
| volumes | No | ||
| hostname | No | ||
| cpu_count | No | ||
| mem_limit | No | ||
| entrypoint | No | ||
| privileged | No | ||
| stdin_open | No | ||
| auto_remove | No | ||
| environment | No | ||
| working_dir | No | ||
| extra_kwargs | No | ||
| restart_policy | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |