From ea26cce50adc03c0010fd1bd29e2cf80876c7ecb Mon Sep 17 00:00:00 2001 From: Dmitry Kovba Date: Wed, 29 Oct 2025 09:04:24 -0700 Subject: [PATCH] Update documentation (#805) Updates documentation according to the currently supported commands and displayed help strings. --- docs/command-reference.md | 770 +++++++++++++++++++++----------------- 1 file changed, 418 insertions(+), 352 deletions(-) diff --git a/docs/command-reference.md b/docs/command-reference.md index e8f13349..cb87589e 100644 --- a/docs/command-reference.md +++ b/docs/command-reference.md @@ -11,68 +11,75 @@ Runs a container from an image. If a command is provided, it will execute inside **Usage** ```bash -container run [OPTIONS] IMAGE [COMMAND] [ARG...] +container run [] [ ...] ``` -**Options** +**Arguments** + +* ``: Image name +* ``: Container init process arguments + +**Process Options** + +* `-e, --env `: Set environment variables (format: key=value) +* `--env-file `: Read in a file of environment variables (key=value format, ignores # comments and blank lines) +* `--gid `: Set the group ID for the process +* `-i, --interactive`: Keep the standard input open even if not attached +* `-t, --tty`: Open a TTY with the process +* `-u, --user `: Set the user for the process (format: name|uid[:gid]) +* `--uid `: Set the user ID for the process +* `-w, --workdir, --cwd `: Set the initial working directory inside the container + +**Resource Options** + +* `-c, --cpus `: Number of CPUs to allocate to the container +* `-m, --memory `: Amount of memory (1MiByte granularity), with optional K, M, G, T, or P suffix + +**Management Options** + +* `-a, --arch `: Set arch if image can target multiple architectures (default: arm64) +* `--cidfile `: Write the container ID to the path provided +* `-d, --detach`: Run the container and detach from the process +* `--dns `: DNS nameserver IP address +* `--dns-domain `: Default DNS domain +* `--dns-option