satl run

Create and run a new container from an image

$ satl run [OPTIONS] <IMAGE> [COMMAND]...

Arguments

Argument	Description
<IMAGE>	Image to run
[COMMAND]...	Command and arguments to run in the container

Options

Option	Description
-d, --detach	Run the container in the background and print its ID
--name <NAME>	Assign a name to the container
-p, --publish <LIST>	Publish a container's port(s) to the host: [ip:][hostPort:]containerPort[/protocol]. The ip is accepted but not honored yet (a warning is printed).
-v, --volume <LIST>	Bind mount a volume: [source:]target[:ro|:rw]. The source is a host path or a volume name; an omitted source creates an anonymous volume.
--tmpfs <MOUNT>	Mount a tmpfs directory: /path[:options].
-e, --env <KEY=VALUE>	Set environment variables
--env-file <FILE>	Read environment variables from a file
-w, --workdir <DIR>	Working directory inside the container
-u, --user <USER>	Username or UID
--hostname <NAME>	Container host name
-m, --memory <BYTES>	Memory limit, with an optional binary unit suffix: 512m, 1g, 2.5g, or a plain byte count. Enforced through rctl(8).
--cpus <DECIMAL>	Number of CPUs; fractions allowed (0.5, 1.25). Enforced through rctl(8).
--restart <POLICY>	Restart policy to apply when a container exits: no, on-failure[:max] or always.
--platform <PLATFORM>	Set platform if the image is multi-platform capable
--rm	Automatically remove the container when it exits
-l, --label <KEY=VALUE>	Set metadata on the container
--entrypoint <COMMAND>	Overwrite the default entrypoint of the image
--pull <PULL>	Pull image before running Values: always — Always pull before creating; missing — Pull only when the daemon says the image is missing (default); never — Never pull; a missing image is an error Default: missing
-i, --interactive	Keep STDIN open even if not attached
-t, --tty	Allocate a pseudo-TTY (not supported yet)

Global options

Accepted by every satl command.

Option	Description
--host <URL>	Daemon socket to connect to (docker-style URL) Default: unix:///var/run/satl.sock Environment: DOCKER_HOST
-h, --help	Print help
-V, --version	Print version

---

Generated from satl 0.1.0 by make gen. Change it in the SatL source or in overlay/cli.yml, never here.