RGBCube/nu_scripts
1
Fork 0
mirror of https://github.com/RGBCube/nu_scripts synced 2025-08-01 06:37:46 +00:00
Code Issues Activity

Refactor of docker completions (#922)

Browse source 
Refactor docker custom completions to reorder `export extern`
declarations and make use of `export alias` to avoid repetition

Also fixes `docker run` needing a mandatory `network` argument which
doesn't exist
This commit is contained in:
OJarrisonn_ 2024-07-27 17:55:40 -03:00 • committed by GitHub
parent 0b487e8380
commit 54546c8bf2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 189 additions and 467 deletions
Download patch file Download diff file Expand all files Collapse all files

656
custom-completions/docker/docker-completions.nu
View file

@ -21,91 +21,22 @@ def "nu-complete local files" [] {
^ls | lines ^ls | lines
} }
# Execute a command in a running container # Log in to a Docker registry
export extern "docker exec" [
container: string@"nu-complete docker containers"
--detach(-d) #Detached mode: run command in the background
--env(-e): string #Set environment variables
--interactive(-i) #Keep STDIN open even if not attached
--privileged #Give extended privileges to the command
--tty(-t) #Allocate a pseudo-TTY
--user(-u): string #Username or UID (format: <name|uid>[:<group|gid>])
--workdir(-w): string #Working directory inside the container
]
# List containers
export extern "docker ps" [
--all(-a) #Show all containers (default shows just running)
--filter: string #Filter output based on conditions provided
--format: string #Pretty-print containers using a Go template
--last(-n): int #Show n last created containers (includes all states) (default -1)
--latest(-l) #Show the latest created container (includes all states)
--no-trunc #Don't truncate output
--quiet(-q) #Only display numeric IDs
--size(-s) #Display total file sizes
]
# Build an image from a Dockerfile
export extern "docker build" [
--add-host: string #Add a custom host-to-IP mapping (host:ip)
--build-arg: string #Set build-time variables
--cache-from: string #Images to consider as cache sources
--cgroup-parent: string #Optional parent cgroup for the container
--compress #Compress the build context using gzip
--file(-f): string@"nu-complete local files" #Name of the Dockerfile (Default is 'PATH/Dockerfile')
--iidfile: string #Write the image ID to the file
--isolation: string #Container isolation technology
--label: string #Set metadata for an image
--network: string #Set the networking mode for the RUN instructions during build (default "default")
--no-cache #Do not use cache when building the image
--platform: string #Set platform if server is multi-platform capable
--progress: string #Set type of progress output (auto, plain, tty). Use plain to show container output
--pull #Always attempt to pull a newer version of the image
--quiet(-q) #Suppress the build output and print image ID on success
--secret: string #Secret file to expose to the build (only if BuildKit enabled): id=mysecret,src=/local/secret
--ssh: string #SSH agent socket or keys to expose to the build (only if BuildKit enabled)
--tag(-t): string #Name and optionally a tag in the 'name:tag' format
--target: string #Set the target build stage to build
--ulimit: string #Ulimit options (default [])
]
# Download an image from a registry
export extern "docker pull" [
image: string@"nu-complete docker images"
--all-tags(-a) #Push all tags of the specified image
--disable-content-trust #Skip image verification (default true)
--plataform: string #Set platform if server is multi-platform capable
--quiet(-q) #Suppress the push output
]
# Upload an image to a registry
export extern "docker push" [
image: string@"nu-complete docker images"
--all-tags(-a) #Push all tags of the specified image
--disable-content-trust #Skip image verification (default true)
--quiet(-q) #Suppress the push output
]
# List images
export extern "docker images" [
--all(-a) #Show all images (default hides intermediate images)
--digests #Show digests
--filter: string #Filter output based on conditions provided
--format: string #Pretty-print images using a Go template
--no-trunc #Don't truncate output
--quiet(-q) #Only show numeric IDs
]
# Log in to a registry
export extern "docker login" [ export extern "docker login" [
server?: string #Docker registry URL
--password(-p): string #Password --password(-p): string #Password
--password-stdin #Take the password from stdin --password-stdin #Take the password from stdin
--username(-u): string #Username --username(-u): string #Username
] ]
# Log out from a Docker registry
export extern "docker logout" [
server?: string #Docker registry URL
]
# Search Docker Hub for images # Search Docker Hub for images
export extern "docker search" [ export extern "docker search" [
term: string term?: string
--filter(-f): string #Filter output based on conditions provided --filter(-f): string #Filter output based on conditions provided
--format: string #Pretty-print search using a Go template --format: string #Pretty-print search using a Go template
--limit: int #Max number of search results --limit: int #Max number of search results
@ -115,285 +46,20 @@ export extern "docker search" [
# Show the docker version information # Show the docker version information
export extern "docker version" [ export extern "docker version" [
--format(-f): string #Format the output using the given Go template --format(-f): string #Format the output using the given Go template
] --kubeconfig: string #Kubernetes config file
# Attach local standard input, output, and error streams to a running container
export extern "docker attach" [
container: string@"nu-complete docker containers"
--detach-keys:string #Override the key sequence for detaching a container
--no-stdin #Do not attach STDIN
--sig-proxy #Proxy all received signals to the process
]
# Create a new image from a container's changes
export extern "docker commit" [
container: string@"nu-complete docker containers"
--author(-a): string #Author (e.g., "John Hannibal Smith <hannibal@a-team.com>"
--change(-c): string #Apply Dockerfile instruction to the created image
--message(-m): string #Commit message
--pause(-p) #Pause container during commit (default true)
]
# Create a new container
export extern "docker create" [
image: string@"nu-complete docker images"
--add-host: string #Add a custom host-to-IP mapping (host:ip)
--annotation: string #Add an annotation to the container (passed through to the OCI runtime) (default map[])
--attach: string #Attach to STDIN, STDOUT or STDERR
--blkio-weight: int #Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
--blkio-weight-device: string #Block IO weight (relative device weight) (default [])
--cap-add: string #Add Linux capabilities
--cap-drop: string #Drop Linux capabilities
--cgroup-parent: string #Optional parent cgroup for the container
--cgroupns: string #Cgroup namespace to use (host|private)
--cidfile: string #Write the container ID to the file
--cpu-period: int #Limit CPU CFS (Completely Fair Scheduler) period
--cpu-quota: int #Limit CPU CFS (Completely Fair Scheduler) quota
--cpu-rt-period: int #Limit CPU real-time period in microseconds
--cpu-rt-runtime: int #Limit CPU real-time runtime in microseconds
--cpu-shares(-c): int #CPU shares (relative weight)
--cpus: int #Number of CPUs
--cpuset-cpus: string #CPUs in which to allow execution (0-3, 0,1)
--cpuset-mems: string #MEMs in which to allow execution (0-3, 0,1)
--detach(-d) #Run container in background and print container ID
--detach-keys: string #Override the key sequence for detaching a container
--device: string #Add a host device to the container
--device-cgroup-rule: string #Add a rule to the cgroup allowed devices list
--device-read-bps: int #Limit read rate (bytes per second) from a device (default [])
--device-read-iops: int #Limit read rate (IO per second) from a device (default [])
--device-write-bps: int #Limit write rate (bytes per second) to a device (default [])
--device-write-iops: int #Limit write rate (IO per second) to a device (default [])
--disable-content-trust #Skip image verification (default true)
--dns: int #Set custom DNS servers
--dns-option: string #Set DNS options
--dns-search: string #Set custom DNS search domains
--domainname: string #Container NIS domain name
--entrypoint: string #Overwrite the default ENTRYPOINT of the image
--env(-e): string #Set environment variables
--env-file: string #Read in a file of environment variables
--expose: string #Expose a port or a range of ports
--gpus: string #GPU devices to add to the container ('all' to pass all GPUs)
--group-add: string #Add additional groups to join
--health-cmd: string #Command to run to check health
--health-interval: duration #Time between running the check (ms|s|m|h) (default 0s)
--health-retries: int #Consecutive failures needed to report unhealthy
--health-start-interval: duration #Time between running the check during the start period (ms|s|m|h) (default 0s)
--health-start-period: duration #Start period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s)
--health-timeout: duration #Maximum time to allow one check to run (ms|s|m|h) (default 0s)
--help #Print usage
--hostname(-h): string #Container host name
--init #Run an init inside the container that forwards signals and reaps processes
--interactive(-i) #Keep STDIN open even if not attached
--ip: string #IPv4 address (e.g., 172.30.100.104)
--ip6: string #IPv6 address (e.g., 2001:db8::33)
--ipc: string #IPC mode to use
--isolation: string #Container isolation technology
--kernel-memory: int #Kernel memory limit
--label(-l): string #Set meta data on a container
--label-file: string #Read in a line delimited file of labels
--link: string #Add link to another container
--link-local-ip: string #Container IPv4/IPv6 link-local addresses
--log-driver: string #Logging driver for the container
--log-opt: string #Log driver options
--mac-address: string #Container MAC address (e.g., 92:d0:c6:0a:29:33)
--memory(-m): int #Memory limit
--memory-reservation: int #Memory soft limit
--memory-swap: int #Swap limit equal to memory plus swap: '-1' to enable unlimited swap
--memory-swappiness: int #Tune container memory swappiness (0 to 100) (default -1)
--mount: string #Attach a filesystem mount to the container
--name: string #Assign a name to the container
--network network #Connect a container to a network
--network-alias: string #Add network-scoped alias for the container
--no-healthcheck #Disable any container-specified HEALTHCHECK
--oom-kill-disable #Disable OOM Killer
--oom-score-adj: int #Tune host's OOM preferences (-1000 to 1000)
--pid: string #PID namespace to use
--pids-limit: int #Tune container pids limit (set -1 for unlimited)
--platform: string #Set platform if server is multi-platform capable
--privileged #Give extended privileges to this container
--publish(-p): string #Publish a container's port(s) to the host
--publish-all(-P) #Publish all exposed ports to random ports
--pull: string@"nu-complete docker pull" #Pull image before running ("always", "missing", "never") (default "missing")
--quiet(-q) #Suppress the pull output
--read-only #Mount the container's root filesystem as read only
--restart: string #Restart policy to apply when a container #exits (default "no")
--rm #Automatically remove the container when it exits
--runtime: string #Runtime to use for this container
--security-opt: string #Security Options
--shm-size: int #Size of /dev/shm
--sig-proxy #Proxy received signals to the process (default true)
--stop-signal: string #Signal to stop the container
--stop-timeout: int #Timeout (in seconds) to stop a container
--storage-opt: string #Storage driver options for the container
--sysctl: string #Sysctl options (default map[])
--tmpfs: string #Mount a tmpfs directory
--tty(-t) #Allocate a pseudo-TTY
--ulimit: int #Ulimit options (default [])
--user(-u): string #Username or UID (format: <name|uid>[:<group|gid>])
--userns: string #User namespace to use
--uts: string #UTS namespace to use
--volume(-v): string #Bind mount a volume
--volume-driver: string #Optional volume driver for the container
--volumes-from: string #Mount volumes from the specified container(s)
--workdir(-w): string #Working directory inside the container
] ]
# Inspect changes to files or directories on a container's filesystem # Inspect changes to files or directories on a container's filesystem
export extern "docker events" [ export extern "docker system events" [
--filter(-f): string #Filter output based on conditions provided --filter(-f): string #Filter output based on conditions provided
--format: string #Pretty-print images using a Go template --format: string #Pretty-print images using a Go template
--since: string #Show all events created since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes) --since: string #Show all events created since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
--until: string #Stream events until this timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes) --until: string #Stream events until this timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
] ]
# Show the history of an images
export extern "docker history" [
image: string@"nu-complete docker images"
--format: string #Pretty-print images using a Go template
--no-trunc #Don't truncate output
--quiet(-q) #Only show numeric IDs
]
# Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE
export extern "docker image tag" [
source: string@"nu-complete docker images"
target: string@"nu-complete docker images"
]
# Export a container's filesystem as a tar archive
export extern "docker export" [
container: string@"nu-complete docker containers"
--output(-o): string #Write to a file, instead of STDOUT
]
# Display detailed information on one or more containers
export extern "docker inspect" [
container: string@"nu-complete docker containers"
--format(-f):string #Format the output using the given Go template
--size(-s) #Display total file sizes
--type:string #Return JSON for specified type
]
# Kill one or more running containers
export extern "docker kill" [
container: string@"nu-complete docker containers"
--signal(-s):string #Signal to send to the container
]
# Fetch the logs of a container
export extern "docker logs" [
container: string@"nu-complete docker containers"
--details #Show extra details provided to logs
--follow(-f) #Follow log output
--since: string #Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
--tail(-n): string #Number of lines to show from the end of the logs
--timestamps(-t) #Show timestamps
--until: string #Show logs before a timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
]
# List containers
export extern "docker container ls" [
--all(-a) #Show all containers (default shows just running)
--filter: string #Filter output based on conditions provided
--format: string #Pretty-print containers using a Go template
--last(-n): int #Show n last created containers (includes all states) (default -1)
--latest(-l) #Show the latest created container (includes all states)
--no-trunc #Don't truncate output
--quiet(-q) #Only display numeric IDs
--size(-s) #Display total file sizes
]
# List port mappings or a specific mapping for the container
export extern "docker port" [
container: string@"nu-complete docker containers"
]
# Remove all stopped containers
export extern "docker container prune" [
--filter: string #Provide filter values (e.g. 'until=24h')
--force(-f) #Do not prompt for confirmation
]
# Rename a container
export extern "docker rename" [
container: string@"nu-complete docker containers"
name: string
]
# Restart one or more containers
export extern "docker restart" [
container: string@"nu-complete docker containers"
--time(-t): int #Seconds to wait for stop before killing the container
--signal(-s): string #Signal to stop the container
]
# Remove one or more containers
export extern "docker rm" [
container: string@"nu-complete docker containers"
--force(-f) #Force the removal of a running container (uses SIGKILL)
--link(-l) #Remove the specified link
--volumes(-v) #Remove the volumes associated with the container
]
# Remove one or more images
export extern "docker rmi" [
image: string@"nu-complete docker images"
--force(-f) #Force removal of the image
--no-prune #Do not delete untagged parents
]
# Save one or more images to a tar archive (streamed to STDOUT by default)
export extern "docker save" [
image: string@"nu-complete docker images"
--output(-o): string #Write to a file, instead of STDOUT
]
# Start one or more stopped containers
export extern "docker start" [
container: string@"nu-complete docker containers"
--attach(-a) #Attach STDOUT/STDERR and forward signals
--interactive(-i) #Attach container's STDIN
--detach-keys: string #Override the key sequence for detaching a container
]
# Display a live stream of container(s) resource usage statistics
export extern "docker stats" [
container: string@"nu-complete docker containers"
--all(-a) #Show all containers (default shows just running)
--format: string #Pretty-print images using a Go template
--no-stream #Disable streaming stats and only pull the first result
--no-trunc #Do not truncate output
]
# Stop one or more running containers
export extern "docker stop" [
container: string@"nu-complete docker containers"
--time(-t): int #Seconds to wait for stop before killing the container
--signal(-s): int #Signal to stop the container
]
# Update configuration of one or more containers
export extern "docker update" [
container: string@"nu-complete docker containers"
--blkio-weight: int #Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
--cpu-period: int #Limit CPU CFS (Completely Fair Scheduler) period
--cpu-quota: int #Limit CPU CFS (Completely Fair Scheduler) quota
--cpu-rt-period: int #Limit CPU real-time period in microseconds
--cpu-rt-runtime: int #Limit CPU real-time runtime in microseconds
--cpu-shares(-c): int #CPU shares (relative weight)
--cpus: float #Number of CPUs
--cpuset-cpus: string #CPUs in which to allow execution (0-3, 0,1)
--cpuset-mems: string #MEMs in which to allow execution (0-3, 0,1)
--memory(-m): binary #Memory limit
--memory-reservation: binary #Memory soft limit
--memory-swap: binary #Swap limit equal to memory plus swap: '-1' to enable unlimited swap
--pids-limit: int #Tune container pids limit (set -1 for unlimited)
--restart: string #Restart policy to apply when a container #exits (default "no")
]
# Attach local standard input, output, and error streams to a running container # Attach local standard input, output, and error streams to a running container
export extern "docker container attach" [ export extern "docker container attach" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
--detach-keys:string #Override the key sequence for detaching a container --detach-keys:string #Override the key sequence for detaching a container
--no-stdin #Do not attach STDIN --no-stdin #Do not attach STDIN
--sig-proxy #Proxy all received signals to the process --sig-proxy #Proxy all received signals to the process
@ -401,7 +67,7 @@ export extern "docker container attach" [
# Create a new image from a container's changes # Create a new image from a container's changes
export extern "docker container commit" [ export extern "docker container commit" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
--author(-a): string #Author (e.g., "John Hannibal Smith <hannibal@a-team.com>" --author(-a): string #Author (e.g., "John Hannibal Smith <hannibal@a-team.com>"
--change(-c): string #Apply Dockerfile instruction to the created image --change(-c): string #Apply Dockerfile instruction to the created image
--message(-m): string #Commit message --message(-m): string #Commit message
@ -410,7 +76,9 @@ export extern "docker container commit" [
# Create a new container # Create a new container
export extern "docker container create" [ export extern "docker container create" [
image: string@"nu-complete docker images" image?: string@"nu-complete docker images" #The image to create the container from
command?: string #Command to run inside the container
...args: string
--add-host: string #Add a custom host-to-IP mapping (host:ip) --add-host: string #Add a custom host-to-IP mapping (host:ip)
--annotation: string #Add an annotation to the container (passed through to the OCI runtime) (default map[]) --annotation: string #Add an annotation to the container (passed through to the OCI runtime) (default map[])
--attach: string #Attach to STDIN, STDOUT or STDERR --attach: string #Attach to STDIN, STDOUT or STDERR
@ -476,7 +144,7 @@ export extern "docker container create" [
--memory-swappiness: int #Tune container memory swappiness (0 to 100) (default -1) --memory-swappiness: int #Tune container memory swappiness (0 to 100) (default -1)
--mount: string #Attach a filesystem mount to the container --mount: string #Attach a filesystem mount to the container
--name: string #Assign a name to the container --name: string #Assign a name to the container
--network network #Connect a container to a network --network #Connect a container to a network
--network-alias: string #Add network-scoped alias for the container --network-alias: string #Add network-scoped alias for the container
--no-healthcheck #Disable any container-specified HEALTHCHECK --no-healthcheck #Disable any container-specified HEALTHCHECK
--oom-kill-disable #Disable OOM Killer --oom-kill-disable #Disable OOM Killer
@ -514,13 +182,12 @@ export extern "docker container create" [
# Inspect changes to files or directories on a container's filesystem # Inspect changes to files or directories on a container's filesystem
export extern "docker container diff" [ export extern "docker container diff" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
] ]
# Run a command in a running container # Run a command in a running container
export extern "docker container exec" [ export extern "docker container exec" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
--detach(-d) #Detached mode: run command in the background --detach(-d) #Detached mode: run command in the background
--env(-e): string #Set environment variables --env(-e): string #Set environment variables
--interactive(-i) #Keep STDIN open even if not attached --interactive(-i) #Keep STDIN open even if not attached
@ -532,13 +199,13 @@ export extern "docker container exec" [
# Export a container's filesystem as a tar archive # Export a container's filesystem as a tar archive
export extern "docker container export" [ export extern "docker container export" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
--output(-o): string #Write to a file, instead of STDOUT --output(-o): string #Write to a file, instead of STDOUT
] ]
# Display detailed information on one or more containers # Display detailed information on one or more containers
export extern "docker container inspect" [ export extern "docker container inspect" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
--format(-f):string #Format the output using the given Go template --format(-f):string #Format the output using the given Go template
--size(-s) #Display total file sizes --size(-s) #Display total file sizes
--type:string #Return JSON for specified type --type:string #Return JSON for specified type
@ -546,13 +213,13 @@ export extern "docker container inspect" [
# Kill one or more running containers # Kill one or more running containers
export extern "docker container kill" [ export extern "docker container kill" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
--signal(-s):string #Signal to send to the container --signal(-s):string #Signal to send to the container
] ]
# Fetch the logs of a container # Fetch the logs of a container
export extern "docker container logs" [ export extern "docker container logs" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
--details #Show extra details provided to logs --details #Show extra details provided to logs
--follow(-f) #Follow log output --follow(-f) #Follow log output
--since: string #Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes) --since: string #Show logs since timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
@ -561,37 +228,57 @@ export extern "docker container logs" [
--until: string #Show logs before a timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes) --until: string #Show logs before a timestamp (e.g. 2013-01-02T13:23:37) or relative (e.g. 42m for 42 minutes)
] ]
# List containers
export extern "docker container ls" [
--all(-a) #Show all containers (default shows just running)
--filter: string #Filter output based on conditions provided
--format: string #Pretty-print containers using a Go template
--last(-n): int #Show n last created containers (includes all states) (default -1)
--latest(-l) #Show the latest created container (includes all states)
--no-trunc #Don't truncate output
--quiet(-q) #Only display numeric IDs
--size(-s) #Display total file sizes
]
# Pause all processes within one or more containers # Pause all processes within one or more containers
export extern "docker container pause" [ export extern "docker container pause" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
]
# Remove all stopped containers
export extern "docker container prune" [
--filter: string #Provide filter values (e.g. 'until=24h')
--force(-f) #Do not prompt for confirmation
] ]
# List port mappings or a specific mapping for the container # List port mappings or a specific mapping for the container
export extern "docker container port" [ export extern "docker container port" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
] ]
# Rename a container # Rename a container
export extern "docker container rename" [ export extern "docker container rename" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
name: string name?: string
] ]
# Restart one or more containers # Restart one or more containers
export extern "docker container restart" [ export extern "docker container restart" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
--time(-t): int #Seconds to wait for stop before killing the container --time(-t): int #Seconds to wait for stop before killing the container
--signal(-s): string #Signal to stop the container --signal(-s): string #Signal to stop the container
] ]
# Remove one or more containers # Remove one or more containers
export extern "docker container rm" [ export extern "docker container rm" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
] ]
# Run a command in a new container # Run a command in a new container
export extern "docker container run" [ export extern "docker container run" [
image: string@"nu-complete docker run" image?: string@"nu-complete docker run" #The image to create the container from
command?: string #Command to run inside the container
...args: string
--add-host: string #Add a custom host-to-IP mapping (host:ip) --add-host: string #Add a custom host-to-IP mapping (host:ip)
--annotation: string #Add an annotation to the container (passed through to the OCI runtime) (default map[]) --annotation: string #Add an annotation to the container (passed through to the OCI runtime) (default map[])
--attach: string #Attach to STDIN, STDOUT or STDERR --attach: string #Attach to STDIN, STDOUT or STDERR
@ -695,7 +382,7 @@ export extern "docker container run" [
# Start one or more stopped containers # Start one or more stopped containers
export extern "docker container start" [ export extern "docker container start" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
--attach(-a) #Attach STDOUT/STDERR and forward signals --attach(-a) #Attach STDOUT/STDERR and forward signals
--interactive(-i) #Attach container's STDIN --interactive(-i) #Attach container's STDIN
--detach-keys: string #Override the key sequence for detaching a container --detach-keys: string #Override the key sequence for detaching a container
@ -703,7 +390,7 @@ export extern "docker container start" [
# Display a live stream of container(s) resource usage statistics # Display a live stream of container(s) resource usage statistics
export extern "docker container stats" [ export extern "docker container stats" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
--all(-a) #Show all containers (default shows just running) --all(-a) #Show all containers (default shows just running)
--format: string #Pretty-print images using a Go template --format: string #Pretty-print images using a Go template
--no-stream #Disable streaming stats and only pull the first result --no-stream #Disable streaming stats and only pull the first result
@ -712,24 +399,24 @@ export extern "docker container stats" [
# Stop one or more running containers # Stop one or more running containers
export extern "docker container stop" [ export extern "docker container stop" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
--time(-t): int #Seconds to wait for stop before killing the container --time(-t): int #Seconds to wait for stop before killing the container
--signal(-s): int #Signal to stop the container --signal(-s): int #Signal to stop the container
] ]
# Display the running processes of a container # Display the running processes of a container
export extern "docker container top" [ export extern "docker container top" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
] ]
# Unpause all processes within one or more containers # Unpause all processes within one or more containers
export extern "docker container unpause" [ export extern "docker container unpause" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
] ]
# Update configuration of one or more containers # Update configuration of one or more containers
export extern "docker container update" [ export extern "docker container update" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
--blkio-weight: int #Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) --blkio-weight: int #Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
--cpu-period: int #Limit CPU CFS (Completely Fair Scheduler) period --cpu-period: int #Limit CPU CFS (Completely Fair Scheduler) period
--cpu-quota: int #Limit CPU CFS (Completely Fair Scheduler) quota --cpu-quota: int #Limit CPU CFS (Completely Fair Scheduler) quota
@ -748,111 +435,78 @@ export extern "docker container update" [
# Block until one or more containers stop, then print their exit codes # Block until one or more containers stop, then print their exit codes
export extern "docker container wait" [ export extern "docker container wait" [
container: string@"nu-complete docker containers" container?: string@"nu-complete docker containers"
] ]
# Create and run a new container from an image # Build an image from a Dockerfile
export extern "docker run" [ export extern "docker image build" [
image: string@"nu-complete docker run"
--add-host: string #Add a custom host-to-IP mapping (host:ip) --add-host: string #Add a custom host-to-IP mapping (host:ip)
--annotation: string #Add an annotation to the container (passed through to the OCI runtime) (default map[]) --build-arg: string #Set build-time variables
--attach: string #Attach to STDIN, STDOUT or STDERR --cache-from: string #Images to consider as cache sources
--blkio-weight: int #Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
--blkio-weight-device: string #Block IO weight (relative device weight) (default [])
--cap-add: string #Add Linux capabilities
--cap-drop: string #Drop Linux capabilities
--cgroup-parent: string #Optional parent cgroup for the container --cgroup-parent: string #Optional parent cgroup for the container
--cgroupns: string #Cgroup namespace to use (host|private) --compress #Compress the build context using gzip
--cidfile: string #Write the container ID to the file --file(-f): string@"nu-complete local files" #Name of the Dockerfile (Default is 'PATH/Dockerfile')
--cpu-period: int #Limit CPU CFS (Completely Fair Scheduler) period --iidfile: string #Write the image ID to the file
--cpu-quota: int #Limit CPU CFS (Completely Fair Scheduler) quota
--cpu-rt-period: int #Limit CPU real-time period in microseconds
--cpu-rt-runtime: int #Limit CPU real-time runtime in microseconds
--cpu-shares(-c): int #CPU shares (relative weight)
--cpus: int #Number of CPUs
--cpuset-cpus: string #CPUs in which to allow execution (0-3, 0,1)
--cpuset-mems: string #MEMs in which to allow execution (0-3, 0,1)
--detach(-d) #Run container in background and print container ID
--detach-keys: string #Override the key sequence for detaching a container
--device: string #Add a host device to the container
--device-cgroup-rule: string #Add a rule to the cgroup allowed devices int
--device-read-bps: int #Limit read rate (bytes per second) from a device (default [])
--device-read-iops: int #Limit read rate (IO per second) from a device (default [])
--device-write-bps: int #Limit write rate (bytes per second) to a device (default [])
--device-write-iops: int #Limit write rate (IO per second) to a device (default [])
--disable-content-trust #Skip image verification (default true)
--dns: int #Set custom DNS servers
--dns-option: string #Set DNS options
--dns-search: string #Set custom DNS search domains
--domainname: string #Container NIS domain name
--entrypoint: string #Overwrite the default ENTRYPOINT of the image
--env(-e): string #Set environment variables
--env-file: string #Read in a file of environment variables
--expose: string #Expose a port or a range of ports
--gpus: string #GPU devices to add to the container ('all' to pass all GPUs)
--group-add: string #Add additional groups to join
--health-cmd: string #Command to run to check health
--health-interval: duration #Time between running the check (ms|s|m|h) (default 0s)
--health-retries: int #Consecutive failures needed to report unhealthy
--health-start-interval: duration #Time between running the check during the start period (ms|s|m|h) (default 0s)
--health-start-period: duration #Start period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s)
--health-timeout: duration #Maximum time to allow one check to run (ms|s|m|h) (default 0s)
--help #Print usage
--hostname(-h): string #Container host name
--init #Run an init inside the container that forwards signals and reaps processes
--interactive(-i) #Keep STDIN open even if not attached
--ip: string #IPv4 address (e.g., 172.30.100.104)
--ip6: string #IPv6 address (e.g., 2001:db8::33)
--ipc: string #IPC mode to use
--isolation: string #Container isolation technology --isolation: string #Container isolation technology
--kernel-memory: int #Kernel memory limit --label: string #Set metadata for an image
--label(-l): string #Set meta data on a container --network: string #Set the networking mode for the RUN instructions during build (default "default")
--label-file: string #Read in a line delimited file of labels --no-cache #Do not use cache when building the image
--link: string #Add link to another container
--link-local-ip: string #Container IPv4/IPv6 link-local addresses
--log-driver: string #Logging driver for the container
--log-opt: string #Log driver options
--mac-address: string #Container MAC address (e.g., 92:d0:c6:0a:29:33)
--memory(-m): int #Memory limit
--memory-reservation: int #Memory soft limit
--memory-swap: int #Swap limit equal to memory plus swap: '-1' to enable unlimited swap
--memory-swappiness: int #Tune container memory swappiness (0 to 100) (default -1)
--mount: string #Attach a filesystem mount to the container
--name: string #Assign a name to the container
--network: string #Connect a container to a network
--network-alias: string #Add network-scoped alias for the container
--no-healthcheck #Disable any container-specified HEALTHCHECK
--oom-kill-disable #Disable OOM Killer
--oom-score-adj: int #Tune host's OOM preferences (-1000 to 1000)
--pid: string #PID namespace to use
--pids-limit: int #Tune container pids limit (set -1 for unlimited)
--platform: string #Set platform if server is multi-platform capable --platform: string #Set platform if server is multi-platform capable
--privileged #Give extended privileges to this container --progress: string #Set type of progress output (auto, plain, tty). Use plain to show container output
--publish(-p): string #Publish a container's port(s) to the host --pull #Always attempt to pull a newer version of the image
--publish-all(-P) #Publish all exposed ports to random ports --quiet(-q) #Suppress the build output and print image ID on success
--pull: string@"nu-complete docker pull" #Pull image before running ("always", "missing", "never") (default "missing") --secret: string #Secret file to expose to the build (only if BuildKit enabled): id=mysecret,src=/local/secret
--quiet(-q) #Suppress the pull output --ssh: string #SSH agent socket or keys to expose to the build (only if BuildKit enabled)
--read-only #Mount the container's root filesystem as read only --tag(-t): string #Name and optionally a tag in the 'name:tag' format
--restart: string #Restart policy to apply when a container #exits (default "no") --target: string #Set the target build stage to build
--rm #Automatically remove the container when it exits --ulimit: string #Ulimit options (default [])
--runtime: string #Runtime to use for this container ]
--security-opt: string #Security Options
--shm-size: int #Size of /dev/shm # Show the history of an images
--sig-proxy #Proxy received signals to the process (default true) export extern "docker image history" [
--stop-signal: string #Signal to stop the container image?: string@"nu-complete docker images"
--stop-timeout: int #Timeout (in seconds) to stop a container --format: string #Pretty-print images using a Go template
--storage-opt: string #Storage driver options for the container --no-trunc #Don't truncate output
--sysctl: string #Sysctl options (default map[]) --quiet(-q) #Only show numeric IDs
--tmpfs: string #Mount a tmpfs directory ]
--tty(-t) #Allocate a pseudo-TTY
--ulimit: int #Ulimit options (default []) # Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE
--user(-u): string #Username or UID (format: <name|uid>[:<group|gid>]) export extern "docker image tag" [
--userns: string #User namespace to use source?: string@"nu-complete docker images"
--uts: string #UTS namespace to use target?: string@"nu-complete docker images"
--volume(-v): string #Bind mount a volume ]
--volume-driver: string #Optional volume driver for the container
--volumes-from: string #Mount volumes from the specified container(s) # List images
--workdir(-w): string #Working directory inside the container export extern "docker image ls" [
--all(-a) #Show all images (default hides intermediate images)
--digests #Show digests
--filter: string #Filter output based on conditions provided
--format: string #Pretty-print images using a Go template
--no-trunc #Don't truncate output
--quiet(-q) #Only show numeric IDs
]
# Download an image from a registry
export extern "docker image pull" [
image?: string@"nu-complete docker images"
--all-tags(-a) #Push all tags of the specified image
--disable-content-trust #Skip image verification (default true)
--plataform: string #Set platform if server is multi-platform capable
--quiet(-q) #Suppress the push output
]
# Upload an image to a registry
export extern "docker image push" [
image?: string@"nu-complete docker images"
--all-tags(-a) #Push all tags of the specified image
--disable-content-trust #Skip image verification (default true)
--quiet(-q) #Suppress the push output
]
# Save one or more images to a tar archive (streamed to STDOUT by default)
export extern "docker image save" [
image?: string@"nu-complete docker images"
--output(-o): string #Write to a file, instead of STDOUT
] ]
# Extended build capabilities with BuildKit # Extended build capabilities with BuildKit
@ -874,3 +528,71 @@ export extern "docker" [
--tlsverify #Use TLS and verify the remote --tlsverify #Use TLS and verify the remote
--version(-v) #Print version information and quit --version(-v) #Print version information and quit
] ]
# Attach local standard input, output, and error streams to a running container
export alias "docker attach" = docker container attach
# Create a new image from a container's changes
export alias "docker commit" = docker container commit
export alias "docker cp" = docker container cp
# Create a new container
export alias "docker create" = docker container create
# Inspect changes to files or directories on a container's filesystem
export alias "docker diff" = docker container diff
# Execute a command in a running container
export alias "docker exec" = docker container exec
# Export a container's filesystem as a tar archive
export alias "docker export" = docker container export
# Display detailed information on one or more containers
export alias "docker inspect" = docker container inspect
# Kill one or more running containers
export alias "docker kill" = docker container kill
# Fetch the logs of a container
export alias "docker logs" = docker container logs
# Pause all processes within one or more containers
export alias "docker pause" = docker container pause
# List port mappings or a specific mapping for the container
export alias "docker port" = docker container port
# Rename a container
export alias "docker rename" = docker container rename
# Restart one or more containers
export alias "docker restart" = docker container restart
# List containers
export alias "docker ps" = docker container ls
# Remove one or more containers
export alias "docker rm" = docker container rm
# Run a command in a new container
export alias "docker run" = docker container run
# Start one or more stopped containers
export alias "docker start" = docker container start
# Display a live stream of container(s) resource usage statistics
export alias "docker stats" = docker container stats
# Stop one or more running containers
export alias "docker stop" = docker container stop
# Display the running processes of a container
export alias "docker top" = docker container top
# Unpause all processes within one or more containers
export alias "docker unpause" = docker container unpause
# Update configuration of one or more containers
export alias "docker update" = docker container update
# Block until one or more containers stop, then print their exit codes
export alias "docker wait" = docker container wait
# Build an image from a Dockerfile
export alias "docker build" = docker image build
# Show the history of an image
export alias "docker history" = docker image history
# Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE
export alias "docker tag" = docker image tag
# List images
export alias "docker images" = docker image ls
# Remove one or more images
export alias "docker rmi" = docker image rm
# Download an image from a registry
export alias "docker pull" = docker image pull
# Upload an image to a registry
export alias "docker push" = docker image push
# Save one or more images to a tar archive (streamed to STDOUT by default)
export alias "docker save" = docker image save
# Inspect changes to files or directories on a container's filesystem
export alias "docker events" = docker system events