@enjoys/context-engine 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +213 -0
- package/data/commands/air.json +59 -0
- package/data/commands/ansible.json +24 -0
- package/data/commands/apachectl.json +87 -0
- package/data/commands/apt-get.json +81 -0
- package/data/commands/apt.json +91 -0
- package/data/commands/awk.json +26 -0
- package/data/commands/aws-vault.json +140 -0
- package/data/commands/aws.json +229 -0
- package/data/commands/az.json +36 -0
- package/data/commands/bazel.json +103 -0
- package/data/commands/brew.json +140 -0
- package/data/commands/bun.json +230 -0
- package/data/commands/caddy.json +194 -0
- package/data/commands/cargo.json +1048 -0
- package/data/commands/cat.json +18 -0
- package/data/commands/cd.json +48 -0
- package/data/commands/certbot.json +148 -0
- package/data/commands/chmod.json +97 -0
- package/data/commands/choco.json +134 -0
- package/data/commands/chown.json +59 -0
- package/data/commands/clickhouse-client.json +74 -0
- package/data/commands/cloudflare.json +226 -0
- package/data/commands/cmake.json +110 -0
- package/data/commands/cockroach.json +92 -0
- package/data/commands/conda.json +94 -0
- package/data/commands/consul.json +125 -0
- package/data/commands/cp.json +86 -0
- package/data/commands/curl.json +44 -0
- package/data/commands/cypress.json +100 -0
- package/data/commands/deno.json +29 -0
- package/data/commands/django-admin.json +86 -0
- package/data/commands/dnf.json +137 -0
- package/data/commands/docker.json +1100 -0
- package/data/commands/doctl.json +156 -0
- package/data/commands/eslint.json +69 -0
- package/data/commands/find.json +44 -0
- package/data/commands/firebase.json +97 -0
- package/data/commands/flask.json +79 -0
- package/data/commands/flyctl.json +148 -0
- package/data/commands/gcloud.json +227 -0
- package/data/commands/gh.json +39 -0
- package/data/commands/git.json +527 -0
- package/data/commands/glab.json +116 -0
- package/data/commands/go.json +161 -0
- package/data/commands/gofmt.json +51 -0
- package/data/commands/golangci-lint.json +89 -0
- package/data/commands/gradle.json +44 -0
- package/data/commands/grep.json +47 -0
- package/data/commands/gunicorn.json +83 -0
- package/data/commands/helm.json +1104 -0
- package/data/commands/hg.json +92 -0
- package/data/commands/httpd.json +147 -0
- package/data/commands/influx.json +119 -0
- package/data/commands/iptables.json +86 -0
- package/data/commands/java.json +31 -0
- package/data/commands/jest.json +82 -0
- package/data/commands/journalctl.json +88 -0
- package/data/commands/just.json +93 -0
- package/data/commands/k6.json +84 -0
- package/data/commands/kubectl.json +1277 -0
- package/data/commands/linode-cli.json +117 -0
- package/data/commands/locust.json +83 -0
- package/data/commands/ls.json +115 -0
- package/data/commands/make.json +86 -0
- package/data/commands/mocha.json +75 -0
- package/data/commands/mongosh.json +73 -0
- package/data/commands/mv.json +68 -0
- package/data/commands/mvn.json +45 -0
- package/data/commands/mysql.json +81 -0
- package/data/commands/nest.json +69 -0
- package/data/commands/netlify.json +92 -0
- package/data/commands/next.json +71 -0
- package/data/commands/nft.json +105 -0
- package/data/commands/nginx.json +146 -0
- package/data/commands/nmap.json +92 -0
- package/data/commands/node.json +43 -0
- package/data/commands/nomad.json +139 -0
- package/data/commands/npm.json +1265 -0
- package/data/commands/npx.json +58 -0
- package/data/commands/nx.json +82 -0
- package/data/commands/openssl.json +288 -0
- package/data/commands/packer.json +92 -0
- package/data/commands/pacman.json +82 -0
- package/data/commands/pg_dump.json +83 -0
- package/data/commands/pg_restore.json +74 -0
- package/data/commands/pip.json +95 -0
- package/data/commands/pipenv.json +79 -0
- package/data/commands/pipx.json +53 -0
- package/data/commands/playwright.json +97 -0
- package/data/commands/pnpm.json +29 -0
- package/data/commands/poetry.json +96 -0
- package/data/commands/prettier.json +71 -0
- package/data/commands/ps.json +31 -0
- package/data/commands/psql.json +124 -0
- package/data/commands/pulumi.json +130 -0
- package/data/commands/pytest.json +92 -0
- package/data/commands/python.json +30 -0
- package/data/commands/railway.json +91 -0
- package/data/commands/redis-cli.json +148 -0
- package/data/commands/render.json +72 -0
- package/data/commands/rm.json +79 -0
- package/data/commands/rsync.json +36 -0
- package/data/commands/rust.json +35 -0
- package/data/commands/rustup.json +103 -0
- package/data/commands/scp.json +60 -0
- package/data/commands/sed.json +28 -0
- package/data/commands/sqlite3.json +68 -0
- package/data/commands/ssh-keygen.json +112 -0
- package/data/commands/ssh.json +37 -0
- package/data/commands/sudo.json +147 -0
- package/data/commands/supabase.json +108 -0
- package/data/commands/svn.json +75 -0
- package/data/commands/systemctl.json +31 -0
- package/data/commands/tar.json +35 -0
- package/data/commands/tcpdump.json +77 -0
- package/data/commands/terraform.json +824 -0
- package/data/commands/terragrunt.json +83 -0
- package/data/commands/tsc.json +85 -0
- package/data/commands/turbo.json +72 -0
- package/data/commands/ufw.json +76 -0
- package/data/commands/unzip.json +59 -0
- package/data/commands/uvicorn.json +73 -0
- package/data/commands/vault.json +144 -0
- package/data/commands/vercel.json +98 -0
- package/data/commands/vite.json +63 -0
- package/data/commands/vitest.json +88 -0
- package/data/commands/wasm-pack.json +90 -0
- package/data/commands/wget.json +38 -0
- package/data/commands/winget.json +131 -0
- package/data/commands/wireshark.json +81 -0
- package/data/commands/yarn.json +28 -0
- package/data/commands/yum.json +98 -0
- package/data/commands/zip.json +59 -0
- package/index.d.ts +131 -0
- package/index.js +189 -0
- package/index.mjs +21 -0
- package/package.json +64 -0
|
@@ -0,0 +1,1100 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "docker",
|
|
3
|
+
"description": "Container platform for building, shipping, and running distributed applications",
|
|
4
|
+
"category": "containers",
|
|
5
|
+
"platforms": ["linux", "macos", "windows"],
|
|
6
|
+
"shells": ["bash", "zsh", "fish", "powershell"],
|
|
7
|
+
"subcommands": [
|
|
8
|
+
{
|
|
9
|
+
"name": "build",
|
|
10
|
+
"description": "Build an image from a Dockerfile",
|
|
11
|
+
"args": [{ "name": "<path|url>", "type": "path", "required": true, "description": "Build context path or URL" }],
|
|
12
|
+
"options": [
|
|
13
|
+
{ "name": "--tag", "short": "-t", "description": "Name and optionally tag (name:tag)", "type": "string" },
|
|
14
|
+
{ "name": "--file", "short": "-f", "description": "Path to Dockerfile", "type": "path" },
|
|
15
|
+
{ "name": "--build-arg", "description": "Set build-time variable (KEY=VALUE)", "type": "string" },
|
|
16
|
+
{ "name": "--target", "description": "Set the target build stage", "type": "string" },
|
|
17
|
+
{ "name": "--no-cache", "description": "Do not use cache when building the image" },
|
|
18
|
+
{ "name": "--pull", "description": "Always attempt to pull a newer version of the base image" },
|
|
19
|
+
{ "name": "--platform", "description": "Set target platform (e.g. linux/amd64)", "type": "string" },
|
|
20
|
+
{ "name": "--progress", "description": "Set type of progress output (auto|plain|tty)", "type": "string" },
|
|
21
|
+
{ "name": "--secret", "description": "Secret to expose to the build (id=mysecret,src=./secret)", "type": "string" },
|
|
22
|
+
{ "name": "--ssh", "description": "SSH agent socket or keys to expose to the build", "type": "string" },
|
|
23
|
+
{ "name": "--cache-from", "description": "Images to consider as cache sources", "type": "string" },
|
|
24
|
+
{ "name": "--cache-to", "description": "Cache export destinations", "type": "string" },
|
|
25
|
+
{ "name": "--label", "description": "Set metadata for an image (key=value)", "type": "string" },
|
|
26
|
+
{ "name": "--network", "description": "Set the networking mode for RUN instructions", "type": "string" },
|
|
27
|
+
{ "name": "--output", "short": "-o", "description": "Output destination (e.g. type=local,dest=path)", "type": "string" },
|
|
28
|
+
{ "name": "--quiet", "short": "-q", "description": "Suppress build output and print image ID on success" },
|
|
29
|
+
{ "name": "--rm", "description": "Remove intermediate containers after build (default true)" },
|
|
30
|
+
{ "name": "--squash", "description": "Squash newly built layers into a single layer" },
|
|
31
|
+
{ "name": "--compress", "description": "Compress the build context using gzip" },
|
|
32
|
+
{ "name": "--memory", "short": "-m", "description": "Memory limit for the build", "type": "string" },
|
|
33
|
+
{ "name": "--shm-size", "description": "Size of /dev/shm", "type": "string" },
|
|
34
|
+
{ "name": "--ulimit", "description": "Ulimit options", "type": "string" },
|
|
35
|
+
{ "name": "--add-host", "description": "Add a custom host-to-IP mapping (host:ip)", "type": "string" },
|
|
36
|
+
{ "name": "--iidfile", "description": "Write the image ID to the file", "type": "path" }
|
|
37
|
+
],
|
|
38
|
+
"examples": [
|
|
39
|
+
"docker build -t myapp .",
|
|
40
|
+
"docker build -t myapp:latest -f Dockerfile.prod .",
|
|
41
|
+
"docker build --build-arg NODE_ENV=production -t myapp .",
|
|
42
|
+
"docker build --no-cache -t myapp .",
|
|
43
|
+
"docker build --target builder -t myapp:builder .",
|
|
44
|
+
"docker build --platform linux/amd64,linux/arm64 -t myapp .",
|
|
45
|
+
"docker build --secret id=npmrc,src=.npmrc -t myapp ."
|
|
46
|
+
]
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
"name": "run",
|
|
50
|
+
"description": "Create and run a new container from an image",
|
|
51
|
+
"args": [
|
|
52
|
+
{ "name": "<image>", "type": "string", "required": true, "description": "Image to run" },
|
|
53
|
+
{ "name": "<command>", "type": "string", "required": false, "description": "Command to execute in container" }
|
|
54
|
+
],
|
|
55
|
+
"options": [
|
|
56
|
+
{ "name": "--name", "description": "Assign a name to the container", "type": "string" },
|
|
57
|
+
{ "name": "--detach", "short": "-d", "description": "Run container in background" },
|
|
58
|
+
{ "name": "--interactive", "short": "-i", "description": "Keep STDIN open even if not attached" },
|
|
59
|
+
{ "name": "--tty", "short": "-t", "description": "Allocate a pseudo-TTY" },
|
|
60
|
+
{ "name": "--rm", "description": "Automatically remove the container when it exits" },
|
|
61
|
+
{ "name": "--publish", "short": "-p", "description": "Publish port(s) (host:container)", "type": "string" },
|
|
62
|
+
{ "name": "--publish-all", "short": "-P", "description": "Publish all exposed ports to random ports" },
|
|
63
|
+
{ "name": "--volume", "short": "-v", "description": "Bind mount a volume (host:container[:opts])", "type": "string" },
|
|
64
|
+
{ "name": "--mount", "description": "Attach a filesystem mount (type=bind,source=...,target=...)", "type": "string" },
|
|
65
|
+
{ "name": "--env", "short": "-e", "description": "Set environment variable (KEY=VALUE)", "type": "string" },
|
|
66
|
+
{ "name": "--env-file", "description": "Read in a file of environment variables", "type": "path" },
|
|
67
|
+
{ "name": "--network", "description": "Connect to a network", "type": "string" },
|
|
68
|
+
{ "name": "--network-alias", "description": "Add network-scoped alias for the container", "type": "string" },
|
|
69
|
+
{ "name": "--hostname", "short": "-h", "description": "Container hostname", "type": "string" },
|
|
70
|
+
{ "name": "--workdir", "short": "-w", "description": "Working directory inside the container", "type": "string" },
|
|
71
|
+
{ "name": "--user", "short": "-u", "description": "Username or UID (format: <name|uid>[:<group|gid>])", "type": "string" },
|
|
72
|
+
{ "name": "--entrypoint", "description": "Override the default entrypoint", "type": "string" },
|
|
73
|
+
{ "name": "--restart", "description": "Restart policy (no|on-failure[:max]|always|unless-stopped)", "type": "string" },
|
|
74
|
+
{ "name": "--platform", "description": "Set platform (e.g. linux/amd64)", "type": "string" },
|
|
75
|
+
{ "name": "--cpus", "description": "Number of CPUs", "type": "string" },
|
|
76
|
+
{ "name": "--memory", "short": "-m", "description": "Memory limit (e.g. 512m, 1g)", "type": "string" },
|
|
77
|
+
{ "name": "--memory-swap", "description": "Swap limit equal to memory plus swap", "type": "string" },
|
|
78
|
+
{ "name": "--gpus", "description": "GPU devices to add (all or device=ID)", "type": "string" },
|
|
79
|
+
{ "name": "--shm-size", "description": "Size of /dev/shm (e.g. 2g)", "type": "string" },
|
|
80
|
+
{ "name": "--cap-add", "description": "Add Linux capabilities", "type": "string" },
|
|
81
|
+
{ "name": "--cap-drop", "description": "Drop Linux capabilities", "type": "string" },
|
|
82
|
+
{ "name": "--privileged", "description": "Give extended privileges to the container" },
|
|
83
|
+
{ "name": "--security-opt", "description": "Security options", "type": "string" },
|
|
84
|
+
{ "name": "--read-only", "description": "Mount the container's root filesystem as read only" },
|
|
85
|
+
{ "name": "--tmpfs", "description": "Mount a tmpfs directory", "type": "string" },
|
|
86
|
+
{ "name": "--device", "description": "Add a host device to the container", "type": "string" },
|
|
87
|
+
{ "name": "--dns", "description": "Set custom DNS servers", "type": "string" },
|
|
88
|
+
{ "name": "--add-host", "description": "Add a custom host-to-IP mapping (host:ip)", "type": "string" },
|
|
89
|
+
{ "name": "--label", "short": "-l", "description": "Set metadata on a container (key=value)", "type": "string" },
|
|
90
|
+
{ "name": "--log-driver", "description": "Logging driver for the container", "type": "string" },
|
|
91
|
+
{ "name": "--log-opt", "description": "Log driver options", "type": "string" },
|
|
92
|
+
{ "name": "--pid", "description": "PID namespace to use", "type": "string" },
|
|
93
|
+
{ "name": "--ipc", "description": "IPC namespace to use", "type": "string" },
|
|
94
|
+
{ "name": "--init", "description": "Run an init process inside the container to forward signals" },
|
|
95
|
+
{ "name": "--sig-proxy", "description": "Proxy received signals to the process (default true)" },
|
|
96
|
+
{ "name": "--stop-signal", "description": "Signal to stop the container", "type": "string" },
|
|
97
|
+
{ "name": "--stop-timeout", "description": "Timeout (seconds) to stop a container", "type": "number" },
|
|
98
|
+
{ "name": "--health-cmd", "description": "Command to run to check health", "type": "string" },
|
|
99
|
+
{ "name": "--health-interval", "description": "Time between running the check", "type": "string" },
|
|
100
|
+
{ "name": "--health-retries", "description": "Consecutive failures needed to report unhealthy", "type": "number" },
|
|
101
|
+
{ "name": "--health-timeout", "description": "Maximum time for one check to run", "type": "string" },
|
|
102
|
+
{ "name": "--no-healthcheck", "description": "Disable any container-specified HEALTHCHECK" },
|
|
103
|
+
{ "name": "--ulimit", "description": "Ulimit options", "type": "string" },
|
|
104
|
+
{ "name": "--isolation", "description": "Container isolation technology", "type": "string" },
|
|
105
|
+
{ "name": "--link", "description": "Add link to another container", "type": "string" }
|
|
106
|
+
],
|
|
107
|
+
"examples": [
|
|
108
|
+
"docker run -d -p 8080:80 nginx",
|
|
109
|
+
"docker run -it --rm ubuntu bash",
|
|
110
|
+
"docker run -d --name myapp -p 3000:3000 -e NODE_ENV=production myapp:latest",
|
|
111
|
+
"docker run -v $(pwd):/app -w /app node:18 npm install",
|
|
112
|
+
"docker run --rm -v /var/run/docker.sock:/var/run/docker.sock docker",
|
|
113
|
+
"docker run -d --restart unless-stopped --name redis -p 6379:6379 redis:alpine",
|
|
114
|
+
"docker run --gpus all -it tensorflow/tensorflow:latest-gpu bash",
|
|
115
|
+
"docker run -d --memory 512m --cpus 1.5 --name limited myapp",
|
|
116
|
+
"docker run -d --network my-net --network-alias db postgres:15",
|
|
117
|
+
"docker run --env-file .env -p 8080:8080 myapp"
|
|
118
|
+
]
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"name": "ps",
|
|
122
|
+
"description": "List containers",
|
|
123
|
+
"args": [],
|
|
124
|
+
"options": [
|
|
125
|
+
{ "name": "--all", "short": "-a", "description": "Show all containers (default shows just running)" },
|
|
126
|
+
{ "name": "--filter", "short": "-f", "description": "Filter output (e.g. status=running, name=foo)", "type": "string" },
|
|
127
|
+
{ "name": "--format", "description": "Format output using Go template", "type": "string" },
|
|
128
|
+
{ "name": "--last", "short": "-n", "description": "Show n last created containers", "type": "number" },
|
|
129
|
+
{ "name": "--latest", "short": "-l", "description": "Show the latest created container" },
|
|
130
|
+
{ "name": "--no-trunc", "description": "Don't truncate output" },
|
|
131
|
+
{ "name": "--quiet", "short": "-q", "description": "Only display container IDs" },
|
|
132
|
+
{ "name": "--size", "short": "-s", "description": "Display total file sizes" }
|
|
133
|
+
],
|
|
134
|
+
"examples": [
|
|
135
|
+
"docker ps",
|
|
136
|
+
"docker ps -a",
|
|
137
|
+
"docker ps -q",
|
|
138
|
+
"docker ps --filter status=exited",
|
|
139
|
+
"docker ps --format '{{.Names}}\\t{{.Status}}'",
|
|
140
|
+
"docker ps -a --filter name=myapp",
|
|
141
|
+
"docker ps -s"
|
|
142
|
+
]
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"name": "images",
|
|
146
|
+
"description": "List images",
|
|
147
|
+
"args": [{ "name": "<repository>", "type": "string", "required": false, "description": "Repository name to filter" }],
|
|
148
|
+
"options": [
|
|
149
|
+
{ "name": "--all", "short": "-a", "description": "Show all images (including intermediate)" },
|
|
150
|
+
{ "name": "--filter", "short": "-f", "description": "Filter output (e.g. dangling=true)", "type": "string" },
|
|
151
|
+
{ "name": "--format", "description": "Format output using Go template", "type": "string" },
|
|
152
|
+
{ "name": "--no-trunc", "description": "Don't truncate output" },
|
|
153
|
+
{ "name": "--quiet", "short": "-q", "description": "Only show image IDs" },
|
|
154
|
+
{ "name": "--digests", "description": "Show digests" }
|
|
155
|
+
],
|
|
156
|
+
"examples": [
|
|
157
|
+
"docker images",
|
|
158
|
+
"docker images -a",
|
|
159
|
+
"docker images -q",
|
|
160
|
+
"docker images --filter dangling=true",
|
|
161
|
+
"docker images --format '{{.Repository}}:{{.Tag}} {{.Size}}'",
|
|
162
|
+
"docker images node"
|
|
163
|
+
]
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
"name": "pull",
|
|
167
|
+
"description": "Download an image from a registry",
|
|
168
|
+
"args": [{ "name": "<image>", "type": "string", "required": true, "description": "Image name (name[:tag|@digest])" }],
|
|
169
|
+
"options": [
|
|
170
|
+
{ "name": "--all-tags", "short": "-a", "description": "Download all tagged images in the repository" },
|
|
171
|
+
{ "name": "--platform", "description": "Set platform (e.g. linux/amd64)", "type": "string" },
|
|
172
|
+
{ "name": "--quiet", "short": "-q", "description": "Suppress verbose output" },
|
|
173
|
+
{ "name": "--disable-content-trust", "description": "Skip image verification" }
|
|
174
|
+
],
|
|
175
|
+
"examples": [
|
|
176
|
+
"docker pull ubuntu",
|
|
177
|
+
"docker pull nginx:alpine",
|
|
178
|
+
"docker pull node:18-slim",
|
|
179
|
+
"docker pull --platform linux/arm64 ubuntu",
|
|
180
|
+
"docker pull ghcr.io/owner/image:tag",
|
|
181
|
+
"docker pull myregistry.io:5000/myimage:latest"
|
|
182
|
+
]
|
|
183
|
+
},
|
|
184
|
+
{
|
|
185
|
+
"name": "push",
|
|
186
|
+
"description": "Upload an image to a registry",
|
|
187
|
+
"args": [{ "name": "<image>", "type": "string", "required": true, "description": "Image name (name[:tag])" }],
|
|
188
|
+
"options": [
|
|
189
|
+
{ "name": "--all-tags", "short": "-a", "description": "Push all tags of an image" },
|
|
190
|
+
{ "name": "--quiet", "short": "-q", "description": "Suppress verbose output" },
|
|
191
|
+
{ "name": "--disable-content-trust", "description": "Skip image signing" }
|
|
192
|
+
],
|
|
193
|
+
"examples": [
|
|
194
|
+
"docker push myregistry.io/myapp:latest",
|
|
195
|
+
"docker push myregistry.io/myapp --all-tags",
|
|
196
|
+
"docker push ghcr.io/owner/image:v1.0.0"
|
|
197
|
+
]
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
"name": "exec",
|
|
201
|
+
"description": "Execute a command in a running container",
|
|
202
|
+
"args": [
|
|
203
|
+
{ "name": "<container>", "type": "string", "required": true, "description": "Container name or ID" },
|
|
204
|
+
{ "name": "<command>", "type": "string", "required": true, "description": "Command to execute" }
|
|
205
|
+
],
|
|
206
|
+
"options": [
|
|
207
|
+
{ "name": "--interactive", "short": "-i", "description": "Keep STDIN open" },
|
|
208
|
+
{ "name": "--tty", "short": "-t", "description": "Allocate a pseudo-TTY" },
|
|
209
|
+
{ "name": "--detach", "short": "-d", "description": "Run command in the background" },
|
|
210
|
+
{ "name": "--env", "short": "-e", "description": "Set environment variables", "type": "string" },
|
|
211
|
+
{ "name": "--env-file", "description": "Read in a file of environment variables", "type": "path" },
|
|
212
|
+
{ "name": "--user", "short": "-u", "description": "Username or UID", "type": "string" },
|
|
213
|
+
{ "name": "--workdir", "short": "-w", "description": "Working directory inside the container", "type": "string" },
|
|
214
|
+
{ "name": "--privileged", "description": "Give extended privileges to the command" }
|
|
215
|
+
],
|
|
216
|
+
"examples": [
|
|
217
|
+
"docker exec -it mycontainer bash",
|
|
218
|
+
"docker exec -it mycontainer sh",
|
|
219
|
+
"docker exec mycontainer ls /app",
|
|
220
|
+
"docker exec -e MY_VAR=value mycontainer env",
|
|
221
|
+
"docker exec -u root mycontainer apt-get update",
|
|
222
|
+
"docker exec -w /app mycontainer cat config.json",
|
|
223
|
+
"docker exec -d mycontainer touch /tmp/flag"
|
|
224
|
+
]
|
|
225
|
+
},
|
|
226
|
+
{
|
|
227
|
+
"name": "stop",
|
|
228
|
+
"description": "Stop one or more running containers",
|
|
229
|
+
"args": [{ "name": "<container>", "type": "string", "required": true, "description": "Container name(s) or ID(s)" }],
|
|
230
|
+
"options": [
|
|
231
|
+
{ "name": "--signal", "short": "-s", "description": "Signal to send to the container", "type": "string" },
|
|
232
|
+
{ "name": "--time", "short": "-t", "description": "Seconds to wait before killing the container", "type": "number" }
|
|
233
|
+
],
|
|
234
|
+
"examples": [
|
|
235
|
+
"docker stop mycontainer",
|
|
236
|
+
"docker stop -t 30 mycontainer",
|
|
237
|
+
"docker stop $(docker ps -q)",
|
|
238
|
+
"docker stop container1 container2"
|
|
239
|
+
]
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
"name": "start",
|
|
243
|
+
"description": "Start one or more stopped containers",
|
|
244
|
+
"args": [{ "name": "<container>", "type": "string", "required": true, "description": "Container name(s) or ID(s)" }],
|
|
245
|
+
"options": [
|
|
246
|
+
{ "name": "--attach", "short": "-a", "description": "Attach STDOUT/STDERR and forward signals" },
|
|
247
|
+
{ "name": "--interactive", "short": "-i", "description": "Attach container's STDIN" }
|
|
248
|
+
],
|
|
249
|
+
"examples": [
|
|
250
|
+
"docker start mycontainer",
|
|
251
|
+
"docker start -a mycontainer",
|
|
252
|
+
"docker start container1 container2"
|
|
253
|
+
]
|
|
254
|
+
},
|
|
255
|
+
{
|
|
256
|
+
"name": "restart",
|
|
257
|
+
"description": "Restart one or more containers",
|
|
258
|
+
"args": [{ "name": "<container>", "type": "string", "required": true, "description": "Container name(s) or ID(s)" }],
|
|
259
|
+
"options": [
|
|
260
|
+
{ "name": "--signal", "short": "-s", "description": "Signal to send to the container", "type": "string" },
|
|
261
|
+
{ "name": "--time", "short": "-t", "description": "Seconds to wait before killing the container", "type": "number" }
|
|
262
|
+
],
|
|
263
|
+
"examples": [
|
|
264
|
+
"docker restart mycontainer",
|
|
265
|
+
"docker restart -t 10 mycontainer",
|
|
266
|
+
"docker restart container1 container2"
|
|
267
|
+
]
|
|
268
|
+
},
|
|
269
|
+
{
|
|
270
|
+
"name": "rm",
|
|
271
|
+
"description": "Remove one or more containers",
|
|
272
|
+
"args": [{ "name": "<container>", "type": "string", "required": true, "description": "Container name(s) or ID(s)" }],
|
|
273
|
+
"options": [
|
|
274
|
+
{ "name": "--force", "short": "-f", "description": "Force removal of a running container (uses SIGKILL)" },
|
|
275
|
+
{ "name": "--volumes", "short": "-v", "description": "Remove anonymous volumes associated with the container" },
|
|
276
|
+
{ "name": "--link", "short": "-l", "description": "Remove the specified link" }
|
|
277
|
+
],
|
|
278
|
+
"examples": [
|
|
279
|
+
"docker rm mycontainer",
|
|
280
|
+
"docker rm -f mycontainer",
|
|
281
|
+
"docker rm -v mycontainer",
|
|
282
|
+
"docker rm $(docker ps -aq --filter status=exited)",
|
|
283
|
+
"docker rm container1 container2"
|
|
284
|
+
]
|
|
285
|
+
},
|
|
286
|
+
{
|
|
287
|
+
"name": "rmi",
|
|
288
|
+
"description": "Remove one or more images",
|
|
289
|
+
"args": [{ "name": "<image>", "type": "string", "required": true, "description": "Image name(s) or ID(s)" }],
|
|
290
|
+
"options": [
|
|
291
|
+
{ "name": "--force", "short": "-f", "description": "Force removal of the image" },
|
|
292
|
+
{ "name": "--no-prune", "description": "Do not delete untagged parent images" }
|
|
293
|
+
],
|
|
294
|
+
"examples": [
|
|
295
|
+
"docker rmi myimage",
|
|
296
|
+
"docker rmi myimage:v1.0",
|
|
297
|
+
"docker rmi -f myimage",
|
|
298
|
+
"docker rmi $(docker images -q --filter dangling=true)",
|
|
299
|
+
"docker rmi image1 image2 image3"
|
|
300
|
+
]
|
|
301
|
+
},
|
|
302
|
+
{
|
|
303
|
+
"name": "logs",
|
|
304
|
+
"description": "Fetch the logs of a container",
|
|
305
|
+
"args": [{ "name": "<container>", "type": "string", "required": true, "description": "Container name or ID" }],
|
|
306
|
+
"options": [
|
|
307
|
+
{ "name": "--follow", "short": "-f", "description": "Follow log output (stream)" },
|
|
308
|
+
{ "name": "--tail", "short": "-n", "description": "Number of lines to show from end of logs", "type": "string" },
|
|
309
|
+
{ "name": "--since", "description": "Show logs since timestamp or relative (e.g. 10m, 2h)", "type": "string" },
|
|
310
|
+
{ "name": "--until", "description": "Show logs before a timestamp or relative", "type": "string" },
|
|
311
|
+
{ "name": "--timestamps", "short": "-t", "description": "Show timestamps" },
|
|
312
|
+
{ "name": "--details", "description": "Show extra details provided to logs" }
|
|
313
|
+
],
|
|
314
|
+
"examples": [
|
|
315
|
+
"docker logs mycontainer",
|
|
316
|
+
"docker logs -f mycontainer",
|
|
317
|
+
"docker logs --tail 100 mycontainer",
|
|
318
|
+
"docker logs --since 10m mycontainer",
|
|
319
|
+
"docker logs -f --tail 50 mycontainer",
|
|
320
|
+
"docker logs -t mycontainer",
|
|
321
|
+
"docker logs --since 2024-01-01T00:00:00 mycontainer"
|
|
322
|
+
]
|
|
323
|
+
},
|
|
324
|
+
{
|
|
325
|
+
"name": "inspect",
|
|
326
|
+
"description": "Return low-level information on Docker objects",
|
|
327
|
+
"args": [{ "name": "<object>", "type": "string", "required": true, "description": "Container/image/network/volume name or ID" }],
|
|
328
|
+
"options": [
|
|
329
|
+
{ "name": "--format", "short": "-f", "description": "Format output using Go template", "type": "string" },
|
|
330
|
+
{ "name": "--type", "description": "Return JSON for specified type (container|image|network|volume)", "type": "string" },
|
|
331
|
+
{ "name": "--size", "short": "-s", "description": "Display total file sizes if the type is container" }
|
|
332
|
+
],
|
|
333
|
+
"examples": [
|
|
334
|
+
"docker inspect mycontainer",
|
|
335
|
+
"docker inspect --format '{{.State.Status}}' mycontainer",
|
|
336
|
+
"docker inspect --format '{{.NetworkSettings.IPAddress}}' mycontainer",
|
|
337
|
+
"docker inspect --format '{{json .Config.Env}}' mycontainer",
|
|
338
|
+
"docker inspect --format '{{.Config.Image}}' mycontainer",
|
|
339
|
+
"docker inspect myimage:latest",
|
|
340
|
+
"docker inspect --type network bridge"
|
|
341
|
+
]
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
"name": "network ls",
|
|
345
|
+
"description": "List networks",
|
|
346
|
+
"args": [],
|
|
347
|
+
"options": [
|
|
348
|
+
{ "name": "--filter", "short": "-f", "description": "Filter output (e.g. driver=bridge)", "type": "string" },
|
|
349
|
+
{ "name": "--format", "description": "Format output using Go template", "type": "string" },
|
|
350
|
+
{ "name": "--no-trunc", "description": "Do not truncate output" },
|
|
351
|
+
{ "name": "--quiet", "short": "-q", "description": "Only display network IDs" }
|
|
352
|
+
],
|
|
353
|
+
"examples": [
|
|
354
|
+
"docker network ls",
|
|
355
|
+
"docker network ls --filter driver=bridge",
|
|
356
|
+
"docker network ls --format '{{.Name}}\\t{{.Driver}}'",
|
|
357
|
+
"docker network ls -q"
|
|
358
|
+
]
|
|
359
|
+
},
|
|
360
|
+
{
|
|
361
|
+
"name": "network create",
|
|
362
|
+
"description": "Create a network",
|
|
363
|
+
"args": [{ "name": "<name>", "type": "string", "required": true, "description": "Network name" }],
|
|
364
|
+
"options": [
|
|
365
|
+
{ "name": "--driver", "short": "-d", "description": "Driver to manage the network (bridge|overlay|macvlan|none)", "type": "string" },
|
|
366
|
+
{ "name": "--subnet", "description": "Subnet in CIDR format", "type": "string" },
|
|
367
|
+
{ "name": "--gateway", "description": "IPv4 or IPv6 gateway for the subnet", "type": "string" },
|
|
368
|
+
{ "name": "--ip-range", "description": "Allocate container IP from a sub-range", "type": "string" },
|
|
369
|
+
{ "name": "--ipv6", "description": "Enable IPv6 networking" },
|
|
370
|
+
{ "name": "--internal", "description": "Restrict external access to the network" },
|
|
371
|
+
{ "name": "--attachable", "description": "Enable manual container attachment" },
|
|
372
|
+
{ "name": "--label", "description": "Set metadata on a network", "type": "string" },
|
|
373
|
+
{ "name": "--opt", "short": "-o", "description": "Set driver-specific options", "type": "string" }
|
|
374
|
+
],
|
|
375
|
+
"examples": [
|
|
376
|
+
"docker network create my-network",
|
|
377
|
+
"docker network create --driver bridge my-bridge",
|
|
378
|
+
"docker network create --subnet 172.20.0.0/16 --gateway 172.20.0.1 my-net",
|
|
379
|
+
"docker network create --internal secure-net"
|
|
380
|
+
]
|
|
381
|
+
},
|
|
382
|
+
{
|
|
383
|
+
"name": "network rm",
|
|
384
|
+
"description": "Remove one or more networks",
|
|
385
|
+
"args": [{ "name": "<network>", "type": "string", "required": true, "description": "Network name(s) or ID(s)" }],
|
|
386
|
+
"options": [
|
|
387
|
+
{ "name": "--force", "short": "-f", "description": "Do not error if the network does not exist" }
|
|
388
|
+
],
|
|
389
|
+
"examples": [
|
|
390
|
+
"docker network rm my-network",
|
|
391
|
+
"docker network rm net1 net2"
|
|
392
|
+
]
|
|
393
|
+
},
|
|
394
|
+
{
|
|
395
|
+
"name": "network connect",
|
|
396
|
+
"description": "Connect a container to a network",
|
|
397
|
+
"args": [
|
|
398
|
+
{ "name": "<network>", "type": "string", "required": true, "description": "Network name or ID" },
|
|
399
|
+
{ "name": "<container>", "type": "string", "required": true, "description": "Container name or ID" }
|
|
400
|
+
],
|
|
401
|
+
"options": [
|
|
402
|
+
{ "name": "--alias", "description": "Add network-scoped alias for the container", "type": "string" },
|
|
403
|
+
{ "name": "--ip", "description": "IPv4 address", "type": "string" },
|
|
404
|
+
{ "name": "--ip6", "description": "IPv6 address", "type": "string" },
|
|
405
|
+
{ "name": "--link", "description": "Add link to another container", "type": "string" }
|
|
406
|
+
],
|
|
407
|
+
"examples": [
|
|
408
|
+
"docker network connect my-network mycontainer",
|
|
409
|
+
"docker network connect --alias db my-network postgres-container",
|
|
410
|
+
"docker network connect --ip 172.20.0.5 my-network mycontainer"
|
|
411
|
+
]
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
"name": "network disconnect",
|
|
415
|
+
"description": "Disconnect a container from a network",
|
|
416
|
+
"args": [
|
|
417
|
+
{ "name": "<network>", "type": "string", "required": true, "description": "Network name or ID" },
|
|
418
|
+
{ "name": "<container>", "type": "string", "required": true, "description": "Container name or ID" }
|
|
419
|
+
],
|
|
420
|
+
"options": [
|
|
421
|
+
{ "name": "--force", "short": "-f", "description": "Force the container to disconnect" }
|
|
422
|
+
],
|
|
423
|
+
"examples": [
|
|
424
|
+
"docker network disconnect my-network mycontainer",
|
|
425
|
+
"docker network disconnect -f my-network mycontainer"
|
|
426
|
+
]
|
|
427
|
+
},
|
|
428
|
+
{
|
|
429
|
+
"name": "volume ls",
|
|
430
|
+
"description": "List volumes",
|
|
431
|
+
"args": [],
|
|
432
|
+
"options": [
|
|
433
|
+
{ "name": "--filter", "short": "-f", "description": "Filter output (e.g. dangling=true, driver=local)", "type": "string" },
|
|
434
|
+
{ "name": "--format", "description": "Format output using Go template", "type": "string" },
|
|
435
|
+
{ "name": "--quiet", "short": "-q", "description": "Only display volume names" }
|
|
436
|
+
],
|
|
437
|
+
"examples": [
|
|
438
|
+
"docker volume ls",
|
|
439
|
+
"docker volume ls --filter dangling=true",
|
|
440
|
+
"docker volume ls --format '{{.Name}}\\t{{.Driver}}'",
|
|
441
|
+
"docker volume ls -q"
|
|
442
|
+
]
|
|
443
|
+
},
|
|
444
|
+
{
|
|
445
|
+
"name": "volume create",
|
|
446
|
+
"description": "Create a volume",
|
|
447
|
+
"args": [{ "name": "<name>", "type": "string", "required": false, "description": "Volume name" }],
|
|
448
|
+
"options": [
|
|
449
|
+
{ "name": "--driver", "short": "-d", "description": "Volume driver name", "type": "string" },
|
|
450
|
+
{ "name": "--label", "description": "Set metadata for a volume", "type": "string" },
|
|
451
|
+
{ "name": "--opt", "short": "-o", "description": "Set driver-specific options", "type": "string" }
|
|
452
|
+
],
|
|
453
|
+
"examples": [
|
|
454
|
+
"docker volume create my-volume",
|
|
455
|
+
"docker volume create --driver local my-volume",
|
|
456
|
+
"docker volume create --label project=myapp data-vol"
|
|
457
|
+
]
|
|
458
|
+
},
|
|
459
|
+
{
|
|
460
|
+
"name": "volume rm",
|
|
461
|
+
"description": "Remove one or more volumes",
|
|
462
|
+
"args": [{ "name": "<volume>", "type": "string", "required": true, "description": "Volume name(s)" }],
|
|
463
|
+
"options": [
|
|
464
|
+
{ "name": "--force", "short": "-f", "description": "Force removal of volume (even if in use)" }
|
|
465
|
+
],
|
|
466
|
+
"examples": [
|
|
467
|
+
"docker volume rm my-volume",
|
|
468
|
+
"docker volume rm -f my-volume",
|
|
469
|
+
"docker volume rm vol1 vol2"
|
|
470
|
+
]
|
|
471
|
+
},
|
|
472
|
+
{
|
|
473
|
+
"name": "volume inspect",
|
|
474
|
+
"description": "Display detailed information on one or more volumes",
|
|
475
|
+
"args": [{ "name": "<volume>", "type": "string", "required": true, "description": "Volume name(s)" }],
|
|
476
|
+
"options": [
|
|
477
|
+
{ "name": "--format", "short": "-f", "description": "Format output using a Go template", "type": "string" }
|
|
478
|
+
],
|
|
479
|
+
"examples": [
|
|
480
|
+
"docker volume inspect my-volume",
|
|
481
|
+
"docker volume inspect --format '{{.Mountpoint}}' my-volume"
|
|
482
|
+
]
|
|
483
|
+
},
|
|
484
|
+
{
|
|
485
|
+
"name": "compose up",
|
|
486
|
+
"description": "Create and start containers defined in compose file",
|
|
487
|
+
"args": [{ "name": "<service>", "type": "string", "required": false, "description": "Service name(s) to start" }],
|
|
488
|
+
"options": [
|
|
489
|
+
{ "name": "--detach", "short": "-d", "description": "Run in background" },
|
|
490
|
+
{ "name": "--build", "description": "Build images before starting containers" },
|
|
491
|
+
{ "name": "--force-recreate", "description": "Recreate containers even if unchanged" },
|
|
492
|
+
{ "name": "--no-recreate", "description": "Do not recreate existing containers" },
|
|
493
|
+
{ "name": "--no-build", "description": "Don't build an image, even if it's missing" },
|
|
494
|
+
{ "name": "--no-deps", "description": "Don't start linked services" },
|
|
495
|
+
{ "name": "--remove-orphans", "description": "Remove containers for services not defined in compose file" },
|
|
496
|
+
{ "name": "--scale", "description": "Scale SERVICE to NUM instances (service=num)", "type": "string" },
|
|
497
|
+
{ "name": "--timeout", "short": "-t", "description": "Shutdown timeout in seconds", "type": "number" },
|
|
498
|
+
{ "name": "--wait", "description": "Wait for services to be running/healthy" },
|
|
499
|
+
{ "name": "--wait-timeout", "description": "Maximum duration to wait for project to be running/healthy", "type": "number" },
|
|
500
|
+
{ "name": "--pull", "description": "Pull image before running (always|missing|never)", "type": "string" },
|
|
501
|
+
{ "name": "--abort-on-container-exit", "description": "Stop all containers if any container stops" },
|
|
502
|
+
{ "name": "--no-start", "description": "Don't start the services after creating them" },
|
|
503
|
+
{ "name": "--quiet-pull", "description": "Pull without printing progress information" },
|
|
504
|
+
{ "name": "-f", "description": "Specify compose file(s)", "type": "path" },
|
|
505
|
+
{ "name": "--project-name", "short": "-p", "description": "Project name", "type": "string" },
|
|
506
|
+
{ "name": "--env-file", "description": "Specify an alternate environment file", "type": "path" },
|
|
507
|
+
{ "name": "--profile", "description": "Specify a profile to enable", "type": "string" }
|
|
508
|
+
],
|
|
509
|
+
"examples": [
|
|
510
|
+
"docker compose up",
|
|
511
|
+
"docker compose up -d",
|
|
512
|
+
"docker compose up --build",
|
|
513
|
+
"docker compose up -d --force-recreate",
|
|
514
|
+
"docker compose up -d web api",
|
|
515
|
+
"docker compose up --scale worker=3",
|
|
516
|
+
"docker compose -f docker-compose.prod.yml up -d",
|
|
517
|
+
"docker compose up -d --wait",
|
|
518
|
+
"docker compose --profile debug up",
|
|
519
|
+
"docker compose up --remove-orphans"
|
|
520
|
+
]
|
|
521
|
+
},
|
|
522
|
+
{
|
|
523
|
+
"name": "compose down",
|
|
524
|
+
"description": "Stop and remove containers, networks defined in compose file",
|
|
525
|
+
"args": [],
|
|
526
|
+
"options": [
|
|
527
|
+
{ "name": "--volumes", "short": "-v", "description": "Remove named volumes declared in the volumes section and anonymous volumes" },
|
|
528
|
+
{ "name": "--rmi", "description": "Remove images (all|local)", "type": "string" },
|
|
529
|
+
{ "name": "--remove-orphans", "description": "Remove containers for services not defined in compose" },
|
|
530
|
+
{ "name": "--timeout", "short": "-t", "description": "Shutdown timeout in seconds", "type": "number" },
|
|
531
|
+
{ "name": "-f", "description": "Specify compose file(s)", "type": "path" },
|
|
532
|
+
{ "name": "--project-name", "short": "-p", "description": "Project name", "type": "string" }
|
|
533
|
+
],
|
|
534
|
+
"examples": [
|
|
535
|
+
"docker compose down",
|
|
536
|
+
"docker compose down -v",
|
|
537
|
+
"docker compose down --rmi all",
|
|
538
|
+
"docker compose down --rmi local -v",
|
|
539
|
+
"docker compose down --remove-orphans",
|
|
540
|
+
"docker compose -f docker-compose.prod.yml down"
|
|
541
|
+
]
|
|
542
|
+
},
|
|
543
|
+
{
|
|
544
|
+
"name": "compose ps",
|
|
545
|
+
"description": "List containers for a compose project",
|
|
546
|
+
"args": [{ "name": "<service>", "type": "string", "required": false, "description": "Service name(s)" }],
|
|
547
|
+
"options": [
|
|
548
|
+
{ "name": "--all", "short": "-a", "description": "Show all stopped containers" },
|
|
549
|
+
{ "name": "--format", "description": "Format output (table|json)", "type": "string" },
|
|
550
|
+
{ "name": "--filter", "description": "Filter services by condition", "type": "string" },
|
|
551
|
+
{ "name": "--quiet", "short": "-q", "description": "Only display IDs" },
|
|
552
|
+
{ "name": "--status", "description": "Filter by status (paused|restarting|removing|running|dead|created|exited)", "type": "string" },
|
|
553
|
+
{ "name": "--services", "description": "Display services" },
|
|
554
|
+
{ "name": "-f", "description": "Specify compose file(s)", "type": "path" }
|
|
555
|
+
],
|
|
556
|
+
"examples": [
|
|
557
|
+
"docker compose ps",
|
|
558
|
+
"docker compose ps -a",
|
|
559
|
+
"docker compose ps --format json",
|
|
560
|
+
"docker compose ps --status running",
|
|
561
|
+
"docker compose ps --services"
|
|
562
|
+
]
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
"name": "compose logs",
|
|
566
|
+
"description": "View output from containers",
|
|
567
|
+
"args": [{ "name": "<service>", "type": "string", "required": false, "description": "Service name(s)" }],
|
|
568
|
+
"options": [
|
|
569
|
+
{ "name": "--follow", "short": "-f", "description": "Follow log output" },
|
|
570
|
+
{ "name": "--tail", "short": "-n", "description": "Number of lines to show from end", "type": "string" },
|
|
571
|
+
{ "name": "--since", "description": "Show logs since timestamp", "type": "string" },
|
|
572
|
+
{ "name": "--until", "description": "Show logs before a timestamp", "type": "string" },
|
|
573
|
+
{ "name": "--timestamps", "short": "-t", "description": "Show timestamps" },
|
|
574
|
+
{ "name": "--no-color", "description": "Produce monochrome output" },
|
|
575
|
+
{ "name": "--no-log-prefix", "description": "Don't print prefix in logs" }
|
|
576
|
+
],
|
|
577
|
+
"examples": [
|
|
578
|
+
"docker compose logs",
|
|
579
|
+
"docker compose logs -f",
|
|
580
|
+
"docker compose logs --tail 100 web",
|
|
581
|
+
"docker compose logs --since 10m api worker",
|
|
582
|
+
"docker compose logs -f --no-log-prefix web"
|
|
583
|
+
]
|
|
584
|
+
},
|
|
585
|
+
{
|
|
586
|
+
"name": "compose build",
|
|
587
|
+
"description": "Build or rebuild services",
|
|
588
|
+
"args": [{ "name": "<service>", "type": "string", "required": false, "description": "Service name(s)" }],
|
|
589
|
+
"options": [
|
|
590
|
+
{ "name": "--build-arg", "description": "Set build-time variables", "type": "string" },
|
|
591
|
+
{ "name": "--no-cache", "description": "Do not use cache" },
|
|
592
|
+
{ "name": "--pull", "description": "Always pull a newer version of the image" },
|
|
593
|
+
{ "name": "--parallel", "description": "Build images in parallel" },
|
|
594
|
+
{ "name": "--progress", "description": "Set type of progress output (auto|plain|tty)", "type": "string" },
|
|
595
|
+
{ "name": "--push", "description": "Push service images" },
|
|
596
|
+
{ "name": "--quiet", "short": "-q", "description": "Don't print anything to STDOUT" }
|
|
597
|
+
],
|
|
598
|
+
"examples": [
|
|
599
|
+
"docker compose build",
|
|
600
|
+
"docker compose build --no-cache",
|
|
601
|
+
"docker compose build web",
|
|
602
|
+
"docker compose build --build-arg VERSION=1.0 web",
|
|
603
|
+
"docker compose build --parallel"
|
|
604
|
+
]
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
"name": "compose exec",
|
|
608
|
+
"description": "Execute a command in a running service container",
|
|
609
|
+
"args": [
|
|
610
|
+
{ "name": "<service>", "type": "string", "required": true, "description": "Service name" },
|
|
611
|
+
{ "name": "<command>", "type": "string", "required": true, "description": "Command to execute" }
|
|
612
|
+
],
|
|
613
|
+
"options": [
|
|
614
|
+
{ "name": "--detach", "short": "-d", "description": "Run in background" },
|
|
615
|
+
{ "name": "--env", "short": "-e", "description": "Set environment variables", "type": "string" },
|
|
616
|
+
{ "name": "--index", "description": "Index of the container if scaled service", "type": "number" },
|
|
617
|
+
{ "name": "--interactive", "short": "-i", "description": "Keep STDIN open (default true)" },
|
|
618
|
+
{ "name": "--tty", "short": "-t", "description": "Allocate a pseudo-TTY (default true)" },
|
|
619
|
+
{ "name": "--user", "short": "-u", "description": "Run as this user", "type": "string" },
|
|
620
|
+
{ "name": "--workdir", "short": "-w", "description": "Working directory", "type": "string" },
|
|
621
|
+
{ "name": "--privileged", "description": "Give extended privileges" }
|
|
622
|
+
],
|
|
623
|
+
"examples": [
|
|
624
|
+
"docker compose exec web bash",
|
|
625
|
+
"docker compose exec db psql -U postgres",
|
|
626
|
+
"docker compose exec -u root web sh",
|
|
627
|
+
"docker compose exec web rails console",
|
|
628
|
+
"docker compose exec -e DEBUG=1 web python manage.py shell"
|
|
629
|
+
]
|
|
630
|
+
},
|
|
631
|
+
{
|
|
632
|
+
"name": "compose pull",
|
|
633
|
+
"description": "Pull service images",
|
|
634
|
+
"args": [{ "name": "<service>", "type": "string", "required": false, "description": "Service name(s)" }],
|
|
635
|
+
"options": [
|
|
636
|
+
{ "name": "--ignore-buildable", "description": "Ignore images that can be built" },
|
|
637
|
+
{ "name": "--ignore-pull-failures", "description": "Pull what it can, ignore failures" },
|
|
638
|
+
{ "name": "--include-deps", "description": "Also pull services declared as dependencies" },
|
|
639
|
+
{ "name": "--quiet", "short": "-q", "description": "Pull without printing progress" },
|
|
640
|
+
{ "name": "--policy", "description": "Apply pull policy (missing|always)", "type": "string" }
|
|
641
|
+
],
|
|
642
|
+
"examples": [
|
|
643
|
+
"docker compose pull",
|
|
644
|
+
"docker compose pull web db",
|
|
645
|
+
"docker compose pull --ignore-pull-failures"
|
|
646
|
+
]
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
"name": "compose restart",
|
|
650
|
+
"description": "Restart service containers",
|
|
651
|
+
"args": [{ "name": "<service>", "type": "string", "required": false, "description": "Service name(s)" }],
|
|
652
|
+
"options": [
|
|
653
|
+
{ "name": "--timeout", "short": "-t", "description": "Shutdown timeout in seconds", "type": "number" },
|
|
654
|
+
{ "name": "--no-deps", "description": "Don't restart dependent services" }
|
|
655
|
+
],
|
|
656
|
+
"examples": [
|
|
657
|
+
"docker compose restart",
|
|
658
|
+
"docker compose restart web",
|
|
659
|
+
"docker compose restart -t 30 web api"
|
|
660
|
+
]
|
|
661
|
+
},
|
|
662
|
+
{
|
|
663
|
+
"name": "system prune",
|
|
664
|
+
"description": "Remove unused data (containers, networks, images, optionally volumes)",
|
|
665
|
+
"args": [],
|
|
666
|
+
"options": [
|
|
667
|
+
{ "name": "--all", "short": "-a", "description": "Remove all unused images, not just dangling" },
|
|
668
|
+
{ "name": "--volumes", "description": "Prune volumes" },
|
|
669
|
+
{ "name": "--force", "short": "-f", "description": "Do not prompt for confirmation" },
|
|
670
|
+
{ "name": "--filter", "description": "Provide filter values (e.g. until=24h, label=foo)", "type": "string" }
|
|
671
|
+
],
|
|
672
|
+
"examples": [
|
|
673
|
+
"docker system prune",
|
|
674
|
+
"docker system prune -f",
|
|
675
|
+
"docker system prune -a --volumes -f",
|
|
676
|
+
"docker system prune --filter until=24h"
|
|
677
|
+
]
|
|
678
|
+
},
|
|
679
|
+
{
|
|
680
|
+
"name": "system df",
|
|
681
|
+
"description": "Show Docker disk usage",
|
|
682
|
+
"args": [],
|
|
683
|
+
"options": [
|
|
684
|
+
{ "name": "--format", "description": "Format output using Go template", "type": "string" },
|
|
685
|
+
{ "name": "--verbose", "short": "-v", "description": "Show detailed information on space usage" }
|
|
686
|
+
],
|
|
687
|
+
"examples": [
|
|
688
|
+
"docker system df",
|
|
689
|
+
"docker system df -v",
|
|
690
|
+
"docker system df --format '{{.Type}}\\t{{.Size}}\\t{{.Reclaimable}}'"
|
|
691
|
+
]
|
|
692
|
+
},
|
|
693
|
+
{
|
|
694
|
+
"name": "system info",
|
|
695
|
+
"description": "Display system-wide information",
|
|
696
|
+
"args": [],
|
|
697
|
+
"options": [
|
|
698
|
+
{ "name": "--format", "short": "-f", "description": "Format output using Go template", "type": "string" }
|
|
699
|
+
],
|
|
700
|
+
"examples": [
|
|
701
|
+
"docker system info",
|
|
702
|
+
"docker info",
|
|
703
|
+
"docker info --format '{{.ServerVersion}}'",
|
|
704
|
+
"docker info --format '{{json .}}'"
|
|
705
|
+
]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
"name": "login",
|
|
709
|
+
"description": "Log in to a registry",
|
|
710
|
+
"args": [{ "name": "<server>", "type": "string", "required": false, "description": "Registry server URL (default: Docker Hub)" }],
|
|
711
|
+
"options": [
|
|
712
|
+
{ "name": "--username", "short": "-u", "description": "Username", "type": "string" },
|
|
713
|
+
{ "name": "--password", "short": "-p", "description": "Password", "type": "string" },
|
|
714
|
+
{ "name": "--password-stdin", "description": "Take the password from stdin" }
|
|
715
|
+
],
|
|
716
|
+
"examples": [
|
|
717
|
+
"docker login",
|
|
718
|
+
"docker login -u myuser",
|
|
719
|
+
"docker login ghcr.io",
|
|
720
|
+
"docker login myregistry.io:5000 -u myuser",
|
|
721
|
+
"echo $TOKEN | docker login ghcr.io -u USERNAME --password-stdin"
|
|
722
|
+
]
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
"name": "logout",
|
|
726
|
+
"description": "Log out from a registry",
|
|
727
|
+
"args": [{ "name": "<server>", "type": "string", "required": false, "description": "Registry server URL" }],
|
|
728
|
+
"options": [],
|
|
729
|
+
"examples": [
|
|
730
|
+
"docker logout",
|
|
731
|
+
"docker logout ghcr.io"
|
|
732
|
+
]
|
|
733
|
+
},
|
|
734
|
+
{
|
|
735
|
+
"name": "tag",
|
|
736
|
+
"description": "Create a tag that refers to a source image",
|
|
737
|
+
"args": [
|
|
738
|
+
{ "name": "<source>", "type": "string", "required": true, "description": "Source image (name[:tag])" },
|
|
739
|
+
{ "name": "<target>", "type": "string", "required": true, "description": "Target image (name[:tag])" }
|
|
740
|
+
],
|
|
741
|
+
"options": [],
|
|
742
|
+
"examples": [
|
|
743
|
+
"docker tag myapp myregistry.io/myapp:latest",
|
|
744
|
+
"docker tag myapp:latest myregistry.io/myapp:v1.0.0",
|
|
745
|
+
"docker tag abc123 myapp:stable",
|
|
746
|
+
"docker tag myapp ghcr.io/owner/myapp:sha-abc123"
|
|
747
|
+
]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
"name": "cp",
|
|
751
|
+
"description": "Copy files/folders between a container and the local filesystem",
|
|
752
|
+
"args": [
|
|
753
|
+
{ "name": "<src>", "type": "string", "required": true, "description": "Source path (container:path or local path)" },
|
|
754
|
+
{ "name": "<dest>", "type": "string", "required": true, "description": "Destination path (container:path or local path)" }
|
|
755
|
+
],
|
|
756
|
+
"options": [
|
|
757
|
+
{ "name": "--archive", "short": "-a", "description": "Archive mode (copy all uid/gid information)" },
|
|
758
|
+
{ "name": "--follow-link", "short": "-L", "description": "Always follow symbol link in SRC_PATH" },
|
|
759
|
+
{ "name": "--quiet", "short": "-q", "description": "Suppress progress output" }
|
|
760
|
+
],
|
|
761
|
+
"examples": [
|
|
762
|
+
"docker cp mycontainer:/app/logs ./logs",
|
|
763
|
+
"docker cp ./config.json mycontainer:/app/config.json",
|
|
764
|
+
"docker cp mycontainer:/var/log/app.log .",
|
|
765
|
+
"docker cp -a mycontainer:/data ./backup"
|
|
766
|
+
]
|
|
767
|
+
},
|
|
768
|
+
{
|
|
769
|
+
"name": "stats",
|
|
770
|
+
"description": "Display a live stream of container resource usage statistics",
|
|
771
|
+
"args": [{ "name": "<container>", "type": "string", "required": false, "description": "Container name(s) or ID(s) (default: all running)" }],
|
|
772
|
+
"options": [
|
|
773
|
+
{ "name": "--all", "short": "-a", "description": "Show all containers (default shows just running)" },
|
|
774
|
+
{ "name": "--format", "description": "Format output using Go template", "type": "string" },
|
|
775
|
+
{ "name": "--no-stream", "description": "Disable streaming stats and only pull the first result" },
|
|
776
|
+
{ "name": "--no-trunc", "description": "Do not truncate output" }
|
|
777
|
+
],
|
|
778
|
+
"examples": [
|
|
779
|
+
"docker stats",
|
|
780
|
+
"docker stats mycontainer",
|
|
781
|
+
"docker stats --no-stream",
|
|
782
|
+
"docker stats --format 'table {{.Name}}\\t{{.CPUPerc}}\\t{{.MemUsage}}'",
|
|
783
|
+
"docker stats --no-stream --format json"
|
|
784
|
+
]
|
|
785
|
+
},
|
|
786
|
+
{
|
|
787
|
+
"name": "top",
|
|
788
|
+
"description": "Display the running processes of a container",
|
|
789
|
+
"args": [
|
|
790
|
+
{ "name": "<container>", "type": "string", "required": true, "description": "Container name or ID" },
|
|
791
|
+
{ "name": "<ps_options>", "type": "string", "required": false, "description": "ps options (e.g. aux)" }
|
|
792
|
+
],
|
|
793
|
+
"options": [],
|
|
794
|
+
"examples": [
|
|
795
|
+
"docker top mycontainer",
|
|
796
|
+
"docker top mycontainer aux"
|
|
797
|
+
]
|
|
798
|
+
},
|
|
799
|
+
{
|
|
800
|
+
"name": "port",
|
|
801
|
+
"description": "List port mappings or a specific mapping for the container",
|
|
802
|
+
"args": [
|
|
803
|
+
{ "name": "<container>", "type": "string", "required": true, "description": "Container name or ID" },
|
|
804
|
+
{ "name": "<private_port>", "type": "string", "required": false, "description": "Private port (e.g. 80/tcp)" }
|
|
805
|
+
],
|
|
806
|
+
"options": [],
|
|
807
|
+
"examples": [
|
|
808
|
+
"docker port mycontainer",
|
|
809
|
+
"docker port mycontainer 80",
|
|
810
|
+
"docker port mycontainer 80/tcp"
|
|
811
|
+
]
|
|
812
|
+
},
|
|
813
|
+
{
|
|
814
|
+
"name": "diff",
|
|
815
|
+
"description": "Inspect changes to files or directories on a container's filesystem",
|
|
816
|
+
"args": [{ "name": "<container>", "type": "string", "required": true, "description": "Container name or ID" }],
|
|
817
|
+
"options": [],
|
|
818
|
+
"examples": [
|
|
819
|
+
"docker diff mycontainer"
|
|
820
|
+
]
|
|
821
|
+
},
|
|
822
|
+
{
|
|
823
|
+
"name": "commit",
|
|
824
|
+
"description": "Create a new image from a container's changes",
|
|
825
|
+
"args": [
|
|
826
|
+
{ "name": "<container>", "type": "string", "required": true, "description": "Container name or ID" },
|
|
827
|
+
{ "name": "<repository[:tag]>", "type": "string", "required": false, "description": "Repository and tag for new image" }
|
|
828
|
+
],
|
|
829
|
+
"options": [
|
|
830
|
+
{ "name": "--author", "short": "-a", "description": "Author (e.g. 'John <john@example.com>')", "type": "string" },
|
|
831
|
+
{ "name": "--change", "short": "-c", "description": "Apply Dockerfile instruction to the created image", "type": "string" },
|
|
832
|
+
{ "name": "--message", "short": "-m", "description": "Commit message", "type": "string" },
|
|
833
|
+
{ "name": "--pause", "short": "-p", "description": "Pause container during commit (default true)" }
|
|
834
|
+
],
|
|
835
|
+
"examples": [
|
|
836
|
+
"docker commit mycontainer myimage:v2",
|
|
837
|
+
"docker commit -m 'added config' mycontainer myimage:configured",
|
|
838
|
+
"docker commit -c 'CMD [\"nginx\"]' mycontainer mynginx:custom",
|
|
839
|
+
"docker commit -a 'Dev Team' mycontainer snapshot:latest"
|
|
840
|
+
]
|
|
841
|
+
},
|
|
842
|
+
{
|
|
843
|
+
"name": "save",
|
|
844
|
+
"description": "Save one or more images to a tar archive",
|
|
845
|
+
"args": [{ "name": "<image>", "type": "string", "required": true, "description": "Image name(s)" }],
|
|
846
|
+
"options": [
|
|
847
|
+
{ "name": "--output", "short": "-o", "description": "Write to a file instead of STDOUT", "type": "path" }
|
|
848
|
+
],
|
|
849
|
+
"examples": [
|
|
850
|
+
"docker save -o myimage.tar myimage:latest",
|
|
851
|
+
"docker save myimage:latest | gzip > myimage.tar.gz",
|
|
852
|
+
"docker save image1 image2 -o images.tar"
|
|
853
|
+
]
|
|
854
|
+
},
|
|
855
|
+
{
|
|
856
|
+
"name": "load",
|
|
857
|
+
"description": "Load an image from a tar archive or STDIN",
|
|
858
|
+
"args": [],
|
|
859
|
+
"options": [
|
|
860
|
+
{ "name": "--input", "short": "-i", "description": "Read from tar archive file", "type": "path" },
|
|
861
|
+
{ "name": "--quiet", "short": "-q", "description": "Suppress the load output" }
|
|
862
|
+
],
|
|
863
|
+
"examples": [
|
|
864
|
+
"docker load -i myimage.tar",
|
|
865
|
+
"docker load < myimage.tar",
|
|
866
|
+
"gunzip -c myimage.tar.gz | docker load"
|
|
867
|
+
]
|
|
868
|
+
},
|
|
869
|
+
{
|
|
870
|
+
"name": "export",
|
|
871
|
+
"description": "Export a container's filesystem as a tar archive",
|
|
872
|
+
"args": [{ "name": "<container>", "type": "string", "required": true, "description": "Container name or ID" }],
|
|
873
|
+
"options": [
|
|
874
|
+
{ "name": "--output", "short": "-o", "description": "Write to a file instead of STDOUT", "type": "path" }
|
|
875
|
+
],
|
|
876
|
+
"examples": [
|
|
877
|
+
"docker export -o container-fs.tar mycontainer",
|
|
878
|
+
"docker export mycontainer | gzip > container.tar.gz"
|
|
879
|
+
]
|
|
880
|
+
},
|
|
881
|
+
{
|
|
882
|
+
"name": "import",
|
|
883
|
+
"description": "Import the contents from a tarball to create a filesystem image",
|
|
884
|
+
"args": [
|
|
885
|
+
{ "name": "<file|url>", "type": "string", "required": true, "description": "Tar file path, URL, or - for STDIN" },
|
|
886
|
+
{ "name": "<repository[:tag]>", "type": "string", "required": false, "description": "Repository and tag" }
|
|
887
|
+
],
|
|
888
|
+
"options": [
|
|
889
|
+
{ "name": "--change", "short": "-c", "description": "Apply Dockerfile instruction to the created image", "type": "string" },
|
|
890
|
+
{ "name": "--message", "short": "-m", "description": "Set commit message for imported image", "type": "string" },
|
|
891
|
+
{ "name": "--platform", "description": "Set platform if server is multi-platform capable", "type": "string" }
|
|
892
|
+
],
|
|
893
|
+
"examples": [
|
|
894
|
+
"docker import container-fs.tar myimage:imported",
|
|
895
|
+
"docker import https://example.com/image.tar myimage:remote",
|
|
896
|
+
"cat container.tar.gz | docker import - myimage:restored",
|
|
897
|
+
"docker import -c 'CMD [\"/bin/bash\"]' backup.tar myimage:custom"
|
|
898
|
+
]
|
|
899
|
+
},
|
|
900
|
+
{
|
|
901
|
+
"name": "buildx build",
|
|
902
|
+
"description": "Build with BuildKit (extended build capabilities)",
|
|
903
|
+
"args": [{ "name": "<path|url>", "type": "path", "required": true, "description": "Build context" }],
|
|
904
|
+
"options": [
|
|
905
|
+
{ "name": "--tag", "short": "-t", "description": "Name and optionally a tag (name:tag)", "type": "string" },
|
|
906
|
+
{ "name": "--file", "short": "-f", "description": "Path to Dockerfile", "type": "path" },
|
|
907
|
+
{ "name": "--platform", "description": "Set target platform(s) for build", "type": "string" },
|
|
908
|
+
{ "name": "--push", "description": "Push image to registry after build" },
|
|
909
|
+
{ "name": "--load", "description": "Load the single-platform build result to docker images" },
|
|
910
|
+
{ "name": "--build-arg", "description": "Set build-time variables", "type": "string" },
|
|
911
|
+
{ "name": "--target", "description": "Set the target build stage", "type": "string" },
|
|
912
|
+
{ "name": "--no-cache", "description": "Do not use cache when building" },
|
|
913
|
+
{ "name": "--pull", "description": "Always attempt to pull all referenced images" },
|
|
914
|
+
{ "name": "--cache-from", "description": "External cache sources (e.g. type=registry,ref=...)", "type": "string" },
|
|
915
|
+
{ "name": "--cache-to", "description": "Cache export destinations", "type": "string" },
|
|
916
|
+
{ "name": "--output", "short": "-o", "description": "Output destination (e.g. type=local,dest=path)", "type": "string" },
|
|
917
|
+
{ "name": "--progress", "description": "Set type of progress output (auto|plain|tty)", "type": "string" },
|
|
918
|
+
{ "name": "--secret", "description": "Secret to expose to the build", "type": "string" },
|
|
919
|
+
{ "name": "--ssh", "description": "SSH agent socket or keys to expose", "type": "string" },
|
|
920
|
+
{ "name": "--builder", "description": "Override the configured builder instance", "type": "string" },
|
|
921
|
+
{ "name": "--label", "description": "Set metadata for an image", "type": "string" },
|
|
922
|
+
{ "name": "--network", "description": "Set the networking mode for RUN instructions", "type": "string" },
|
|
923
|
+
{ "name": "--sbom", "description": "Shorthand for --attest=type=sbom", "type": "string" },
|
|
924
|
+
{ "name": "--provenance", "description": "Shorthand for --attest=type=provenance", "type": "string" },
|
|
925
|
+
{ "name": "--attest", "description": "Attestation parameters (type=sbom|provenance)", "type": "string" },
|
|
926
|
+
{ "name": "--shm-size", "description": "Size of /dev/shm", "type": "string" },
|
|
927
|
+
{ "name": "--ulimit", "description": "Ulimit options", "type": "string" },
|
|
928
|
+
{ "name": "--add-host", "description": "Add a custom host-to-IP mapping", "type": "string" },
|
|
929
|
+
{ "name": "--allow", "description": "Allow extra privileged entitlement (network.host|security.insecure)", "type": "string" },
|
|
930
|
+
{ "name": "--iidfile", "description": "Write the image ID to the file", "type": "path" },
|
|
931
|
+
{ "name": "--metadata-file", "description": "Write build result metadata to the file", "type": "path" }
|
|
932
|
+
],
|
|
933
|
+
"examples": [
|
|
934
|
+
"docker buildx build -t myapp .",
|
|
935
|
+
"docker buildx build --platform linux/amd64,linux/arm64 -t myapp --push .",
|
|
936
|
+
"docker buildx build --load -t myapp .",
|
|
937
|
+
"docker buildx build --cache-from type=registry,ref=myapp:cache --cache-to type=registry,ref=myapp:cache -t myapp .",
|
|
938
|
+
"docker buildx build --secret id=npmrc,src=.npmrc -t myapp .",
|
|
939
|
+
"docker buildx build --provenance=true --sbom=true -t myapp --push ."
|
|
940
|
+
]
|
|
941
|
+
},
|
|
942
|
+
{
|
|
943
|
+
"name": "buildx create",
|
|
944
|
+
"description": "Create a new builder instance",
|
|
945
|
+
"args": [{ "name": "<context|endpoint>", "type": "string", "required": false, "description": "Builder context or endpoint" }],
|
|
946
|
+
"options": [
|
|
947
|
+
{ "name": "--name", "description": "Builder instance name", "type": "string" },
|
|
948
|
+
{ "name": "--driver", "description": "Builder driver (docker|docker-container|kubernetes|remote)", "type": "string" },
|
|
949
|
+
{ "name": "--driver-opt", "description": "Driver-specific options", "type": "string" },
|
|
950
|
+
{ "name": "--platform", "description": "Fixed platforms for current node", "type": "string" },
|
|
951
|
+
{ "name": "--use", "description": "Set the current builder instance" },
|
|
952
|
+
{ "name": "--bootstrap", "description": "Boot builder after creation" },
|
|
953
|
+
{ "name": "--buildkitd-flags", "description": "Flags for buildkitd daemon", "type": "string" },
|
|
954
|
+
{ "name": "--config", "description": "BuildKit config file", "type": "path" },
|
|
955
|
+
{ "name": "--append", "description": "Append a node to builder instead of changing it" },
|
|
956
|
+
{ "name": "--node", "description": "Create/modify node with given name", "type": "string" },
|
|
957
|
+
{ "name": "--leave", "description": "Remove a node from builder instead of changing it" }
|
|
958
|
+
],
|
|
959
|
+
"examples": [
|
|
960
|
+
"docker buildx create --name mybuilder --use",
|
|
961
|
+
"docker buildx create --name multiarch --driver docker-container --bootstrap",
|
|
962
|
+
"docker buildx create --name mybuilder --platform linux/amd64,linux/arm64 --use",
|
|
963
|
+
"docker buildx create --driver kubernetes --driver-opt namespace=buildkit"
|
|
964
|
+
]
|
|
965
|
+
},
|
|
966
|
+
{
|
|
967
|
+
"name": "buildx use",
|
|
968
|
+
"description": "Set the current builder instance",
|
|
969
|
+
"args": [{ "name": "<name>", "type": "string", "required": true, "description": "Builder instance name" }],
|
|
970
|
+
"options": [
|
|
971
|
+
{ "name": "--default", "description": "Set builder as default for current context" },
|
|
972
|
+
{ "name": "--global", "description": "Builder persists context changes" }
|
|
973
|
+
],
|
|
974
|
+
"examples": [
|
|
975
|
+
"docker buildx use mybuilder",
|
|
976
|
+
"docker buildx use default",
|
|
977
|
+
"docker buildx use --global mybuilder"
|
|
978
|
+
]
|
|
979
|
+
},
|
|
980
|
+
{
|
|
981
|
+
"name": "buildx ls",
|
|
982
|
+
"description": "List builder instances",
|
|
983
|
+
"args": [],
|
|
984
|
+
"options": [
|
|
985
|
+
{ "name": "--format", "description": "Format output", "type": "string" }
|
|
986
|
+
],
|
|
987
|
+
"examples": [
|
|
988
|
+
"docker buildx ls"
|
|
989
|
+
]
|
|
990
|
+
}
|
|
991
|
+
],
|
|
992
|
+
"globalOptions": [
|
|
993
|
+
{ "name": "--config", "description": "Location of client config files", "type": "path" },
|
|
994
|
+
{ "name": "--context", "short": "-c", "description": "Name of the context to use for connecting to the daemon", "type": "string" },
|
|
995
|
+
{ "name": "--debug", "short": "-D", "description": "Enable debug mode" },
|
|
996
|
+
{ "name": "--host", "short": "-H", "description": "Daemon socket to connect to", "type": "string" },
|
|
997
|
+
{ "name": "--log-level", "short": "-l", "description": "Set the logging level (debug|info|warn|error|fatal)", "type": "string" },
|
|
998
|
+
{ "name": "--tls", "description": "Use TLS; implied by --tlsverify" },
|
|
999
|
+
{ "name": "--tlscacert", "description": "Trust certs signed only by this CA", "type": "path" },
|
|
1000
|
+
{ "name": "--tlscert", "description": "Path to TLS certificate file", "type": "path" },
|
|
1001
|
+
{ "name": "--tlskey", "description": "Path to TLS key file", "type": "path" },
|
|
1002
|
+
{ "name": "--tlsverify", "description": "Use TLS and verify the remote" },
|
|
1003
|
+
{ "name": "--version", "short": "-v", "description": "Print version information and quit" }
|
|
1004
|
+
],
|
|
1005
|
+
"examples": [
|
|
1006
|
+
"docker run -d -p 80:80 nginx",
|
|
1007
|
+
"docker build -t myapp .",
|
|
1008
|
+
"docker compose up -d",
|
|
1009
|
+
"docker ps -a",
|
|
1010
|
+
"docker logs -f mycontainer",
|
|
1011
|
+
"docker exec -it mycontainer bash",
|
|
1012
|
+
"docker system prune -a --volumes -f",
|
|
1013
|
+
"docker buildx build --platform linux/amd64,linux/arm64 -t myapp --push ."
|
|
1014
|
+
],
|
|
1015
|
+
"relatedCommands": ["docker-compose", "podman", "kubectl", "nerdctl", "buildah", "skopeo", "crictl"],
|
|
1016
|
+
"contextEngine": {
|
|
1017
|
+
"detectors": [
|
|
1018
|
+
{
|
|
1019
|
+
"name": "running_containers",
|
|
1020
|
+
"description": "Currently running containers with name, image, status, and ports",
|
|
1021
|
+
"command": "docker ps --format '{{.Names}}\t{{.Image}}\t{{.Status}}\t{{.Ports}}'",
|
|
1022
|
+
"parser": "lines",
|
|
1023
|
+
"cacheFor": 5,
|
|
1024
|
+
"requiresCmd": "docker"
|
|
1025
|
+
},
|
|
1026
|
+
{
|
|
1027
|
+
"name": "all_containers",
|
|
1028
|
+
"description": "All containers including stopped ones",
|
|
1029
|
+
"command": "docker ps -a --format '{{.Names}}\t{{.Image}}\t{{.Status}}'",
|
|
1030
|
+
"parser": "lines",
|
|
1031
|
+
"cacheFor": 10,
|
|
1032
|
+
"requiresCmd": "docker"
|
|
1033
|
+
},
|
|
1034
|
+
{
|
|
1035
|
+
"name": "images",
|
|
1036
|
+
"description": "Locally available Docker images with repository, tag, size, and ID",
|
|
1037
|
+
"command": "docker images --format '{{.Repository}}:{{.Tag}}\t{{.Size}}\t{{.ID}}'",
|
|
1038
|
+
"parser": "lines",
|
|
1039
|
+
"cacheFor": 30,
|
|
1040
|
+
"requiresCmd": "docker"
|
|
1041
|
+
},
|
|
1042
|
+
{
|
|
1043
|
+
"name": "volumes",
|
|
1044
|
+
"description": "Docker volumes and their drivers",
|
|
1045
|
+
"command": "docker volume ls --format '{{.Name}}\t{{.Driver}}'",
|
|
1046
|
+
"parser": "lines",
|
|
1047
|
+
"cacheFor": 30,
|
|
1048
|
+
"requiresCmd": "docker"
|
|
1049
|
+
},
|
|
1050
|
+
{
|
|
1051
|
+
"name": "networks",
|
|
1052
|
+
"description": "Docker networks with name, driver, and scope",
|
|
1053
|
+
"command": "docker network ls --format '{{.Name}}\t{{.Driver}}\t{{.Scope}}'",
|
|
1054
|
+
"parser": "lines",
|
|
1055
|
+
"cacheFor": 30,
|
|
1056
|
+
"requiresCmd": "docker"
|
|
1057
|
+
},
|
|
1058
|
+
{
|
|
1059
|
+
"name": "compose_services",
|
|
1060
|
+
"description": "Running Docker Compose services and their status",
|
|
1061
|
+
"command": "docker compose ps --format '{{.Name}}\t{{.Service}}\t{{.Status}}'",
|
|
1062
|
+
"parser": "lines",
|
|
1063
|
+
"cacheFor": 10,
|
|
1064
|
+
"requiresCmd": "docker"
|
|
1065
|
+
},
|
|
1066
|
+
{
|
|
1067
|
+
"name": "docker_info",
|
|
1068
|
+
"description": "Docker daemon server version, OS, CPU, and memory summary",
|
|
1069
|
+
"command": "docker info --format '{{.ServerVersion}} {{.OperatingSystem}} {{.NCPU}}cores {{.MemTotal}}'",
|
|
1070
|
+
"parser": "text",
|
|
1071
|
+
"cacheFor": 300,
|
|
1072
|
+
"requiresCmd": "docker"
|
|
1073
|
+
},
|
|
1074
|
+
{
|
|
1075
|
+
"name": "disk_usage",
|
|
1076
|
+
"description": "Docker disk usage by resource type",
|
|
1077
|
+
"command": "docker system df --format '{{.Type}}\t{{.TotalCount}}\t{{.Size}}\t{{.Reclaimable}}'",
|
|
1078
|
+
"parser": "lines",
|
|
1079
|
+
"cacheFor": 60,
|
|
1080
|
+
"requiresCmd": "docker"
|
|
1081
|
+
},
|
|
1082
|
+
{
|
|
1083
|
+
"name": "dangling_images",
|
|
1084
|
+
"description": "IDs of dangling (untagged) images that can be pruned",
|
|
1085
|
+
"command": "docker images -f dangling=true -q",
|
|
1086
|
+
"parser": "lines",
|
|
1087
|
+
"cacheFor": 30,
|
|
1088
|
+
"requiresCmd": "docker"
|
|
1089
|
+
},
|
|
1090
|
+
{
|
|
1091
|
+
"name": "buildx_builders",
|
|
1092
|
+
"description": "Available BuildKit builder instances and their status",
|
|
1093
|
+
"command": "docker buildx ls",
|
|
1094
|
+
"parser": "text",
|
|
1095
|
+
"cacheFor": 60,
|
|
1096
|
+
"requiresCmd": "docker"
|
|
1097
|
+
}
|
|
1098
|
+
]
|
|
1099
|
+
}
|
|
1100
|
+
}
|