You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/skopeo-copy.1.md
+67-67Lines changed: 67 additions & 67 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,221 +24,221 @@ See also [skopeo(1)](skopeo.1.md) for options placed before the subcommand name.
24
24
25
25
**--additional-tag**=_strings_
26
26
27
-
Additional tags (supports docker-archive).
27
+
: Additional tags (supports docker-archive).
28
28
29
29
**--all**, **-a**
30
30
31
-
If _source-image_ refers to a list of images, instead of copying just the image which matches the current OS and
32
-
architecture (subject to the use of the global --override-os, --override-arch and --override-variant options), attempt to copy all of
33
-
the images in the list, and the list itself.
31
+
: If _source-image_ refers to a list of images, instead of copying just the image which matches the current OS and
32
+
architecture (subject to the use of the global --override-os, --override-arch and --override-variant options), attempt to copy all of
33
+
the images in the list, and the list itself.
34
34
35
35
**--authfile**_path_
36
36
37
-
Path of the primary registry credentials file. On Linux, the default is ${XDG\_RUNTIME\_DIR}/containers/auth.json.
38
-
See **containers-auth.json**(5) for more details about the credential search mechanism and defaults on other platforms.
39
-
40
-
Use `skopeo login` to manage the credentials.
41
-
42
-
The default value of this option is read from the `REGISTRY\_AUTH\_FILE` environment variable.
37
+
: Path of the primary registry credentials file. On Linux, the default is ${XDG\_RUNTIME\_DIR}/containers/auth.json.
38
+
See **containers-auth.json**(5) for more details about the credential search mechanism and defaults on other platforms.
39
+
40
+
Use `skopeo login` to manage the credentials.
41
+
42
+
The default value of this option is read from the `REGISTRY\_AUTH\_FILE` environment variable.
43
43
44
44
**--src-authfile**_path_
45
45
46
-
Path of the primary registry credentials file for the source registry. Uses path given by `--authfile`, if not provided.
46
+
: Path of the primary registry credentials file for the source registry. Uses path given by `--authfile`, if not provided.
47
47
48
48
**--dest-authfile**_path_
49
49
50
-
Path of the primary registry credentials file for the destination registry. Uses path given by `--authfile`, if not provided.
50
+
: Path of the primary registry credentials file for the destination registry. Uses path given by `--authfile`, if not provided.
51
51
52
52
**--dest-shared-blob-dir**_directory_
53
53
54
-
Directory to use to share blobs across OCI repositories.
54
+
: Directory to use to share blobs across OCI repositories.
55
55
56
56
**--digestfile**_path_
57
57
58
-
After copying the image, write the digest of the resulting image to the file.
58
+
: After copying the image, write the digest of the resulting image to the file.
59
59
60
60
**--preserve-digests**
61
61
62
-
Preserve the digests during copying. Fail if the digest cannot be preserved.
62
+
: Preserve the digests during copying. Fail if the digest cannot be preserved.
63
63
64
-
This option does not change what will be copied; consider using `--all` at the same time.
64
+
This option does not change what will be copied; consider using `--all` at the same time.
65
65
66
66
**--encrypt-layer**_ints_
67
67
68
-
*Experimental* the 0-indexed layer indices, with support for negative indexing (e.g. 0 is the first layer, -1 is the last layer)
68
+
: *Experimental* the 0-indexed layer indices, with support for negative indexing (e.g. 0 is the first layer, -1 is the last layer)
69
69
70
70
**--format**, **-f**_manifest-type_
71
71
72
-
MANIFEST TYPE (oci, v2s1, or v2s2) to use in the destination (default is manifest type of source, with fallbacks)
72
+
: MANIFEST TYPE (oci, v2s1, or v2s2) to use in the destination (default is manifest type of source, with fallbacks)
73
73
74
74
**--help**, **-h**
75
75
76
-
Print usage statement
76
+
: Print usage statement
77
77
78
78
**--multi-arch**_option_
79
79
80
-
Control what is copied if _source-image_ refers to a multi-architecture image. Default is system.
80
+
: Control what is copied if _source-image_ refers to a multi-architecture image. Default is system.
81
81
82
-
Options:
83
-
- system: Copy only the image that matches the system architecture
84
-
- all: Copy the full multi-architecture image
85
-
- index-only: Copy only the index
82
+
: Options:
83
+
- system: Copy only the image that matches the system architecture
84
+
- all: Copy the full multi-architecture image
85
+
- index-only: Copy only the index
86
86
87
-
The index-only option usually fails unless the referenced per-architecture images are already present in the destination, or the target registry supports sparse indexes.
87
+
The index-only option usually fails unless the referenced per-architecture images are already present in the destination, or the target registry supports sparse indexes.
88
88
89
89
**--quiet**, **-q**
90
90
91
-
Suppress output information when copying images.
91
+
: Suppress output information when copying images.
92
92
93
93
**--remove-signatures**
94
94
95
-
Do not copy signatures, if any, from _source-image_. Necessary when copying a signed image to a destination which does not support signatures.
95
+
: Do not copy signatures, if any, from _source-image_. Necessary when copying a signed image to a destination which does not support signatures.
96
96
97
97
**--sign-by**_key-id_
98
98
99
-
Add a “simple signing” signature using that key ID for an image name corresponding to _destination-image_
99
+
: Add a “simple signing” signature using that key ID for an image name corresponding to _destination-image_
100
100
101
101
**--sign-by-sigstore**_param-file_
102
102
103
-
Add a sigstore signature based on the options in the specified containers sigstore signing parameter file, _param-file_.
104
-
See containers-sigstore-signing-params.yaml(5) for details about the file format.
103
+
: Add a sigstore signature based on the options in the specified containers sigstore signing parameter file, _param-file_.
104
+
See containers-sigstore-signing-params.yaml(5) for details about the file format.
105
105
106
106
**--sign-by-sigstore-private-key**_path_
107
107
108
-
Add a sigstore signature using a private key at _path_ for an image name corresponding to _destination-image_
108
+
: Add a sigstore signature using a private key at _path_ for an image name corresponding to _destination-image_
109
109
110
110
**--sign-by-sq-fingerprint**_fingerprint_
111
111
112
-
Add a “simple signing” signature using a Sequoia-PGP key with the specified _fingerprint_.
112
+
: Add a “simple signing” signature using a Sequoia-PGP key with the specified _fingerprint_.
113
113
114
114
**--sign-passphrase-file**_path_
115
115
116
-
The passphrase to use when signing with `--sign-by`, `--sign-by-sigstore-private-key` or `--sign-by-sq-fingerprint`.
117
-
Only the first line will be read. A passphrase stored in a file is of questionable security if other users can read this file. Do not use this option if at all avoidable.
116
+
: The passphrase to use when signing with `--sign-by`, `--sign-by-sigstore-private-key` or `--sign-by-sq-fingerprint`.
117
+
Only the first line will be read. A passphrase stored in a file is of questionable security if other users can read this file. Do not use this option if at all avoidable.
118
118
119
119
**--sign-identity**_reference_
120
120
121
-
The identity to use when signing the image. The identity must be a fully specified docker reference. If the identity is not specified, the target docker reference will be used.
121
+
: The identity to use when signing the image. The identity must be a fully specified docker reference. If the identity is not specified, the target docker reference will be used.
122
122
123
123
**--src-shared-blob-dir**_directory_
124
124
125
-
Directory to use to share blobs across OCI repositories.
125
+
: Directory to use to share blobs across OCI repositories.
126
126
127
127
**--encryption-key**_protocol:keyfile_
128
128
129
-
Specifies the encryption protocol, which can be JWE (RFC7516), PGP (RFC4880), and PKCS7 (RFC2315) and the key material required for image encryption. For instance, jwe:/path/to/key.pem or pgp:admin@example.com or pkcs7:/path/to/x509-file.
129
+
: Specifies the encryption protocol, which can be JWE (RFC7516), PGP (RFC4880), and PKCS7 (RFC2315) and the key material required for image encryption. For instance, jwe:/path/to/key.pem or pgp:admin@example.com or pkcs7:/path/to/x509-file.
130
130
131
131
**--decryption-key**_key[:passphrase]_
132
132
133
-
Key to be used for decryption of images. Key can point to keys and/or certificates. Decryption will be tried with all keys. If the key is protected by a passphrase, it is required to be passed in the argument and omitted otherwise.
133
+
: Key to be used for decryption of images. Key can point to keys and/or certificates. Decryption will be tried with all keys. If the key is protected by a passphrase, it is required to be passed in the argument and omitted otherwise.
134
134
135
135
**--src-creds**_username[:password]_
136
136
137
-
Credentials for accessing the source registry.
137
+
: Credentials for accessing the source registry.
138
138
139
139
**--dest-compress**
140
140
141
-
Compress tarball image layers when saving to directory using the 'dir' transport. (default is same compression type as source).
141
+
: Compress tarball image layers when saving to directory using the 'dir' transport. (default is same compression type as source).
142
142
143
143
**--dest-decompress**
144
144
145
-
Decompress tarball image layers when saving to directory using the 'dir' transport. (default is same compression type as source).
145
+
: Decompress tarball image layers when saving to directory using the 'dir' transport. (default is same compression type as source).
146
146
147
147
**--dest-oci-accept-uncompressed-layers**
148
148
149
-
Allow uncompressed image layers when saving to an OCI image using the 'oci' transport. (default is to compress things that aren't compressed).
149
+
: Allow uncompressed image layers when saving to an OCI image using the 'oci' transport. (default is to compress things that aren't compressed).
150
150
151
151
**--dest-creds**_username[:password]_
152
152
153
-
Credentials for accessing the destination registry.
153
+
: Credentials for accessing the destination registry.
154
154
155
155
**--src-cert-dir**_path_
156
156
157
-
Use certificates at _path_ (*.crt, *.cert, *.key) to connect to the source registry or daemon.
157
+
: Use certificates at _path_ (*.crt, *.cert, *.key) to connect to the source registry or daemon.
158
158
159
159
**--src-no-creds**
160
160
161
-
Access the registry anonymously.
161
+
: Access the registry anonymously.
162
162
163
163
**--src-tls-verify**=_bool_
164
164
165
-
Require HTTPS and verify certificates when talking to container source registry or daemon. Default to source registry setting.
165
+
: Require HTTPS and verify certificates when talking to container source registry or daemon. Default to source registry setting.
166
166
167
167
**--dest-cert-dir**_path_
168
168
169
-
Use certificates at _path_ (*.crt, *.cert, *.key) to connect to the destination registry or daemon.
169
+
: Use certificates at _path_ (*.crt, *.cert, *.key) to connect to the destination registry or daemon.
170
170
171
171
**--dest-no-creds**
172
172
173
-
Access the registry anonymously.
173
+
: Access the registry anonymously.
174
174
175
175
**--dest-tls-verify**=_bool_
176
176
177
-
Require HTTPS and verify certificates when talking to container destination registry or daemon. Default to destination registry setting.
177
+
: Require HTTPS and verify certificates when talking to container destination registry or daemon. Default to destination registry setting.
178
178
179
179
**--src-daemon-host**_host_
180
180
181
-
Copy from docker daemon at _host_. If _host_ starts with `tcp://`, HTTPS is enabled by default. To use plain HTTP, use the form `http://` (default is `unix:///var/run/docker.sock`).
181
+
: Copy from docker daemon at _host_. If _host_ starts with `tcp://`, HTTPS is enabled by default. To use plain HTTP, use the form `http://` (default is `unix:///var/run/docker.sock`).
182
182
183
183
**--dest-daemon-host**_host_
184
184
185
-
Copy to docker daemon at _host_. If _host_ starts with `tcp://`, HTTPS is enabled by default. To use plain HTTP, use the form `http://` (default is `unix:///var/run/docker.sock`).
185
+
: Copy to docker daemon at _host_. If _host_ starts with `tcp://`, HTTPS is enabled by default. To use plain HTTP, use the form `http://` (default is `unix:///var/run/docker.sock`).
186
186
187
-
Existing signatures, if any, are preserved as well.
187
+
Existing signatures, if any, are preserved as well.
188
188
189
189
**--dest-compress-format**_format_
190
190
191
-
Specifies the compression format to use. Supported values are: `gzip`, `zstd` and `zstd:chunked`.
192
-
`zstd:chunked` is incompatible with encrypting images,
193
-
and will be treated as `zstd` with a warning in that case.
191
+
: Specifies the compression format to use. Supported values are: `gzip`, `zstd` and `zstd:chunked`.
192
+
`zstd:chunked` is incompatible with encrypting images,
193
+
and will be treated as `zstd` with a warning in that case.
194
194
195
195
**--dest-compress-level**_format_
196
196
197
-
Specifies the compression level to use. The value is specific to the compression algorithm used, e.g. for zstd the accepted values are in the range 1-20 (inclusive), while for gzip it is 1-9 (inclusive).
197
+
: Specifies the compression level to use. The value is specific to the compression algorithm used, e.g. for zstd the accepted values are in the range 1-20 (inclusive), while for gzip it is 1-9 (inclusive).
198
198
199
199
**--dest-force-compress-format**
200
200
201
-
Ensures that the compression algorithm set in --dest-compress-format is used exclusively.
201
+
: Ensures that the compression algorithm set in --dest-compress-format is used exclusively.
202
202
203
203
**--src-registry-token**_token_
204
204
205
-
Bearer token for accessing the source registry.
205
+
: Bearer token for accessing the source registry.
206
206
207
207
**--dest-registry-token**_token_
208
208
209
-
Bearer token for accessing the destination registry.
209
+
: Bearer token for accessing the destination registry.
210
210
211
211
**--dest-precompute-digests**
212
212
213
-
Precompute digests to ensure layers are not uploaded that already exist on the destination registry. Layers with initially unknown digests (ex. compressing "on the fly") will be temporarily streamed to disk.
213
+
: Precompute digests to ensure layers are not uploaded that already exist on the destination registry. Layers with initially unknown digests (ex. compressing "on the fly") will be temporarily streamed to disk.
214
214
215
215
**--retry-times**
216
216
217
-
The number of times to retry.
217
+
: The number of times to retry.
218
218
219
219
**--retry-delay**
220
220
221
-
Fixed delay between retries. If not set (or set to 0s), retry wait time will be exponentially increased based on the number of failed attempts.
221
+
: Fixed delay between retries. If not set (or set to 0s), retry wait time will be exponentially increased based on the number of failed attempts.
222
222
223
223
**--src-username**
224
224
225
-
The username to access the source registry.
225
+
: The username to access the source registry.
226
226
227
227
**--src-password**
228
228
229
-
The password to access the source registry.
229
+
: The password to access the source registry.
230
230
231
231
**--dest-username**
232
232
233
-
The username to access the destination registry.
233
+
: The username to access the destination registry.
234
234
235
235
**--dest-password**
236
236
237
-
The password to access the destination registry.
237
+
: The password to access the destination registry.
238
238
239
239
**--image-parallel-copies**_n_
240
240
241
-
Maximum number of image layers to be copied (pulled/pushed) simultaneously. Not setting this field will fall back to containers/image defaults.
241
+
: Maximum number of image layers to be copied (pulled/pushed) simultaneously. Not setting this field will fall back to containers/image defaults.
0 commit comments