github.com/GoogleContainerTools/skaffold/v2@v2.13.2/docs-v1/content/en/docs/references/cli/_index.md (about) 1 --- 2 title: "CLI" 3 linkTitle: "CLI" 4 weight: 1 5 --- 6 7 Skaffold command-line interface provides the following commands: 8 9 10 End-to-end pipelines: 11 12 * [skaffold run](#skaffold-run) - to build & deploy once 13 * [skaffold dev](#skaffold-dev) - to trigger the watch loop build & deploy workflow with cleanup on exit 14 * [skaffold debug](#skaffold-debug) - to run a pipeline in debug mode 15 16 Pipeline building blocks for CI/CD: 17 18 * [skaffold build](#skaffold-build) - to just build and tag your image(s) 19 * [skaffold deploy](#skaffold-deploy) - to deploy the given image(s) 20 * [skaffold delete](#skaffold-delete) - to cleanup the deployed artifacts 21 * [skaffold render](#skaffold-render) - build and tag images, and output templated Kubernetes manifests 22 * [skaffold apply](#skaffold-apply) - to apply hydrated manifests to a cluster 23 24 Getting started with a new project: 25 26 * [skaffold init](#skaffold-init) - to bootstrap Skaffold config 27 * [skaffold fix](#skaffold-fix) - to upgrade from older skaffold.yaml schema version to newer skaffold.yaml schema version 28 29 Other Commands: 30 31 * [skaffold help](#skaffold-help) - print help 32 * [skaffold version](#skaffold-version) - get Skaffold version 33 * [skaffold completion](#skaffold-completion) - setup tab completion for the CLI 34 * [skaffold config](#skaffold-config) - manage context specific parameters 35 * [skaffold credits](#skaffold-credits) - export third party notices to given path (./skaffold-credits by default) 36 * [skaffold diagnose](#skaffold-diagnose) - diagnostics of Skaffold works in your project 37 * [skaffold schema](#skaffold-schema) - list and print json schemas used to validate skaffold.yaml configuration 38 39 40 ## Global flags 41 42 | Flag | Description | 43 |------- |---------------| 44 |`-h, --help`| Prints the HELP file for the current command.| 45 |`-v, --verbosity LOG-LEVEL` | Uses a specific log level. Available log levels are `info`, `warn`, `error`, `fatal`, `debug` and `trace`. Default value is `warn`.| 46 47 48 ## Global environment variables 49 50 | Flag | Description | 51 |------- |---------------| 52 |`SKAFFOLD_UPDATE_CHECK`|Enables checking for latest version of the Skaffold binary. By default it's `true`. | 53 54 55 ## Skaffold commands 56 57 <!-- 58 ****** 59 To edit this file above edit index_header - the rest of the file is autogenerated by cmd/skaffold/man 60 ****** 61 --> 62 63 ### skaffold 64 65 66 67 ``` 68 69 70 End-to-end Pipelines: 71 run Run a pipeline 72 dev Run a pipeline in development mode 73 debug Run a pipeline in debug mode 74 75 Pipeline Building Blocks: 76 build Build the artifacts 77 test Run tests against your built application images 78 deploy Deploy pre-built artifacts 79 delete Delete any resources deployed by Skaffold 80 render Generate rendered Kubernetes manifests 81 apply Apply hydrated manifests to a cluster 82 verify Run verification tests against skaffold deployments 83 84 Getting Started With a New Project: 85 init Generate configuration for deploying an application 86 87 Other Commands: 88 completion Output shell completion for the given shell (bash, fish or zsh) 89 config Interact with the global Skaffold config file (defaults to `$HOME/.skaffold/config`) 90 diagnose Run a diagnostic on Skaffold 91 fix Update old configuration to a newer schema version 92 schema List JSON schemas used to validate skaffold.yaml configuration 93 survey Opens a web browser to fill out the Skaffold survey 94 version Print the version information 95 96 Use "skaffold <command> --help" for more information about a given command. 97 Use "skaffold options" for a list of global command-line options (applies to all commands). 98 99 100 ``` 101 Env vars: 102 103 * `SKAFFOLD_COLOR` (same as `--color`) 104 * `SKAFFOLD_INTERACTIVE` (same as `--interactive`) 105 * `SKAFFOLD_TIMESTAMPS` (same as `--timestamps`) 106 * `SKAFFOLD_UPDATE_CHECK` (same as `--update-check`) 107 * `SKAFFOLD_VERBOSITY` (same as `--verbosity`) 108 109 ### skaffold apply 110 111 Apply hydrated manifests to a cluster 112 113 ``` 114 115 116 Examples: 117 # Hydrate Kubernetes pod manifest first 118 skaffold render --output rendered-pod.yaml 119 120 # Then create resources on your cluster from that hydrated manifest 121 skaffold apply rendered-pod.yaml 122 123 Options: 124 --assume-yes=false: If true, skaffold will skip yes/no confirmation from the user and default to yes 125 --cloud-run-location='': The GCP Region to deploy Cloud Run services to 126 --cloud-run-project='': The GCP Project ID or Project Number to deploy for Cloud Run 127 -c, --config='': File for global configurations (defaults to $HOME/.skaffold/config) 128 -f, --filename='skaffold.yaml': Path or URL to the Skaffold config file 129 --force=false: Recreate Kubernetes resources if necessary for deployment, warning: might cause downtime! 130 --iterative-status-check=false: Run `status-check` iteratively after each deploy step, instead of all-together at the end of all deploys (default). 131 --kube-context='': Deploy to this Kubernetes context 132 --kubeconfig='': Path to the kubeconfig file to use for CLI requests. 133 -m, --module=[]: Filter Skaffold configs to only the provided named modules 134 -n, --namespace='': Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace 135 -p, --profile=[]: Activate profiles by name (prefixed with `-` to disable a profile) 136 --remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos) 137 --rpc-http-port=: tcp port to expose the Skaffold API over HTTP REST 138 --rpc-port=: tcp port to expose the Skaffold API over gRPC 139 --status-check=: Wait for deployed resources to stabilize 140 --sync-remote-cache='always': Controls how Skaffold manages the remote config cache (see `remote-cache-dir`). One of `always` (default), `missing`, or `never`. `always` syncs remote repositories to latest on access. `missing` only clones remote repositories if they do not exist locally. `never` means the user takes responsibility for updating remote repositories. 141 --tail=false: Stream logs from deployed objects 142 --tolerate-failures-until-deadline=false: Configures `status-check` to tolerate failures until Skaffold's statusCheckDeadline duration or the deployments progressDeadlineSeconds Otherwise deployment failures skaffold encounters will immediately fail the deployment. Defaults to 'false' 143 --wait-for-connection=false: Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit 144 145 Usage: 146 skaffold apply [options] 147 148 Use "skaffold options" for a list of global command-line options (applies to all commands). 149 150 151 ``` 152 Env vars: 153 154 * `SKAFFOLD_ASSUME_YES` (same as `--assume-yes`) 155 * `SKAFFOLD_CLOUD_RUN_LOCATION` (same as `--cloud-run-location`) 156 * `SKAFFOLD_CLOUD_RUN_PROJECT` (same as `--cloud-run-project`) 157 * `SKAFFOLD_CONFIG` (same as `--config`) 158 * `SKAFFOLD_FILENAME` (same as `--filename`) 159 * `SKAFFOLD_FORCE` (same as `--force`) 160 * `SKAFFOLD_ITERATIVE_STATUS_CHECK` (same as `--iterative-status-check`) 161 * `SKAFFOLD_KUBE_CONTEXT` (same as `--kube-context`) 162 * `SKAFFOLD_KUBECONFIG` (same as `--kubeconfig`) 163 * `SKAFFOLD_MODULE` (same as `--module`) 164 * `SKAFFOLD_NAMESPACE` (same as `--namespace`) 165 * `SKAFFOLD_PROFILE` (same as `--profile`) 166 * `SKAFFOLD_REMOTE_CACHE_DIR` (same as `--remote-cache-dir`) 167 * `SKAFFOLD_RPC_HTTP_PORT` (same as `--rpc-http-port`) 168 * `SKAFFOLD_RPC_PORT` (same as `--rpc-port`) 169 * `SKAFFOLD_STATUS_CHECK` (same as `--status-check`) 170 * `SKAFFOLD_SYNC_REMOTE_CACHE` (same as `--sync-remote-cache`) 171 * `SKAFFOLD_TAIL` (same as `--tail`) 172 * `SKAFFOLD_TOLERATE_FAILURES_UNTIL_DEADLINE` (same as `--tolerate-failures-until-deadline`) 173 * `SKAFFOLD_WAIT_FOR_CONNECTION` (same as `--wait-for-connection`) 174 175 ### skaffold build 176 177 Build the artifacts 178 179 ``` 180 181 182 Examples: 183 # Build all the artifacts 184 skaffold build 185 186 # Build artifacts with a profile activated 187 skaffold build -p <profile> 188 189 # Build artifacts whose image name contains <db> 190 skaffold build -b <db> 191 192 # Quietly build artifacts and output the image names as json 193 skaffold build -q > build_result.json 194 195 # Build the artifacts and then deploy them 196 skaffold build -q | skaffold deploy --build-artifacts - 197 198 # Print the final image names 199 skaffold build -q --dry-run 200 201 Options: 202 --assume-yes=false: If true, skaffold will skip yes/no confirmation from the user and default to yes 203 --build-concurrency=-1: Number of concurrently running builds. Set to 0 to run all builds in parallel. Doesn't violate build order among dependencies. 204 -b, --build-image=[]: Only build artifacts with image names that contain the given substring. Default is to build sources for all artifacts 205 --cache-artifacts=true: Set to false to disable default caching of artifacts 206 --cache-file='': Specify the location of the cache file (default $HOME/.skaffold/cache) 207 --check-cluster-node-platforms=false: When set to true, images are built for the target platforms matching the active kubernetes cluster node platforms. Enabled by default for `dev`, `debug` and `run` 208 -c, --config='': File for global configurations (defaults to $HOME/.skaffold/config) 209 -d, --default-repo='': Default repository value (overrides global config) 210 --detect-minikube=true: Use heuristics to detect a minikube cluster 211 --disable-multi-platform-build=false: When set to true, forces only single platform image builds even when multiple target platforms are specified. Enabled by default for `dev` and `debug` modes, to keep dev-loop fast 212 --dry-run=false: Don't build images, just compute the tag for each artifact. 213 --file-output='': Filename to write build images to 214 -f, --filename='skaffold.yaml': Path or URL to the Skaffold config file 215 --insecure-registry=[]: Target registries for built images which are not secure 216 --kube-context='': Deploy to this Kubernetes context 217 --kubeconfig='': Path to the kubeconfig file to use for CLI requests. 218 -m, --module=[]: Filter Skaffold configs to only the provided named modules 219 --mute-logs=[]: mute logs for specified stages in pipeline (build, deploy, status-check, none, all) 220 -n, --namespace='': Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace 221 -o, --output={{json .}}: Used in conjunction with --quiet flag. Format output with go-template. For full struct documentation, see https://godoc.org/github.com/GoogleContainerTools/skaffold/v2/cmd/skaffold/app/flags#BuildOutput 222 --platform=[]: The platform to target for the build artifacts 223 -p, --profile=[]: Activate profiles by name (prefixed with `-` to disable a profile) 224 --profile-auto-activation=true: Set to false to disable profile auto activation 225 --propagate-profiles=true: Setting '--propagate-profiles=false' disables propagating profiles set by the '--profile' flag across config dependencies. This mean that only profiles defined directly in the target 'skaffold.yaml' file are activated. 226 --push=: Push the built images to the specified image repository. 227 -q, --quiet=false: Suppress the build output and print image built on success. See --output to format output. 228 --remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos) 229 --rpc-http-port=: tcp port to expose the Skaffold API over HTTP REST 230 --rpc-port=: tcp port to expose the Skaffold API over gRPC 231 --skip-tests=false: Whether to skip the tests after building 232 --sync-remote-cache='always': Controls how Skaffold manages the remote config cache (see `remote-cache-dir`). One of `always` (default), `missing`, or `never`. `always` syncs remote repositories to latest on access. `missing` only clones remote repositories if they do not exist locally. `never` means the user takes responsibility for updating remote repositories. 233 -t, --tag='': The optional custom tag to use for images which overrides the current Tagger configuration 234 --toot=false: Emit a terminal beep after the deploy is complete 235 --wait-for-connection=false: Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit 236 237 Usage: 238 skaffold build [options] 239 240 Use "skaffold options" for a list of global command-line options (applies to all commands). 241 242 243 ``` 244 Env vars: 245 246 * `SKAFFOLD_ASSUME_YES` (same as `--assume-yes`) 247 * `SKAFFOLD_BUILD_CONCURRENCY` (same as `--build-concurrency`) 248 * `SKAFFOLD_BUILD_IMAGE` (same as `--build-image`) 249 * `SKAFFOLD_CACHE_ARTIFACTS` (same as `--cache-artifacts`) 250 * `SKAFFOLD_CACHE_FILE` (same as `--cache-file`) 251 * `SKAFFOLD_CHECK_CLUSTER_NODE_PLATFORMS` (same as `--check-cluster-node-platforms`) 252 * `SKAFFOLD_CONFIG` (same as `--config`) 253 * `SKAFFOLD_DEFAULT_REPO` (same as `--default-repo`) 254 * `SKAFFOLD_DETECT_MINIKUBE` (same as `--detect-minikube`) 255 * `SKAFFOLD_DISABLE_MULTI_PLATFORM_BUILD` (same as `--disable-multi-platform-build`) 256 * `SKAFFOLD_DRY_RUN` (same as `--dry-run`) 257 * `SKAFFOLD_FILE_OUTPUT` (same as `--file-output`) 258 * `SKAFFOLD_FILENAME` (same as `--filename`) 259 * `SKAFFOLD_INSECURE_REGISTRY` (same as `--insecure-registry`) 260 * `SKAFFOLD_KUBE_CONTEXT` (same as `--kube-context`) 261 * `SKAFFOLD_KUBECONFIG` (same as `--kubeconfig`) 262 * `SKAFFOLD_MODULE` (same as `--module`) 263 * `SKAFFOLD_MUTE_LOGS` (same as `--mute-logs`) 264 * `SKAFFOLD_NAMESPACE` (same as `--namespace`) 265 * `SKAFFOLD_OUTPUT` (same as `--output`) 266 * `SKAFFOLD_PLATFORM` (same as `--platform`) 267 * `SKAFFOLD_PROFILE` (same as `--profile`) 268 * `SKAFFOLD_PROFILE_AUTO_ACTIVATION` (same as `--profile-auto-activation`) 269 * `SKAFFOLD_PROPAGATE_PROFILES` (same as `--propagate-profiles`) 270 * `SKAFFOLD_PUSH` (same as `--push`) 271 * `SKAFFOLD_QUIET` (same as `--quiet`) 272 * `SKAFFOLD_REMOTE_CACHE_DIR` (same as `--remote-cache-dir`) 273 * `SKAFFOLD_RPC_HTTP_PORT` (same as `--rpc-http-port`) 274 * `SKAFFOLD_RPC_PORT` (same as `--rpc-port`) 275 * `SKAFFOLD_SKIP_TESTS` (same as `--skip-tests`) 276 * `SKAFFOLD_SYNC_REMOTE_CACHE` (same as `--sync-remote-cache`) 277 * `SKAFFOLD_TAG` (same as `--tag`) 278 * `SKAFFOLD_TOOT` (same as `--toot`) 279 * `SKAFFOLD_WAIT_FOR_CONNECTION` (same as `--wait-for-connection`) 280 281 ### skaffold completion 282 283 Output shell completion for the given shell (bash, fish or zsh) 284 285 ``` 286 287 288 Usage: 289 skaffold completion SHELL [options] 290 291 Use "skaffold options" for a list of global command-line options (applies to all commands). 292 293 294 ``` 295 296 ### skaffold config 297 298 Interact with the global Skaffold config file (defaults to `$HOME/.skaffold/config`) 299 300 ``` 301 302 303 Available Commands: 304 list List all values set in the global Skaffold config 305 set Set a value in the global Skaffold config 306 unset Unset a value in the global Skaffold config 307 308 Use "skaffold <command> --help" for more information about a given command. 309 310 311 ``` 312 313 ### skaffold config list 314 315 List all values set in the global Skaffold config 316 317 ``` 318 319 320 Options: 321 -a, --all=false: Show values for all kubecontexts 322 -c, --config='': Path to Skaffold config 323 -k, --kube-context='': Kubectl context to set values against 324 325 Usage: 326 skaffold config list [options] 327 328 Use "skaffold options" for a list of global command-line options (applies to all commands). 329 330 331 ``` 332 Env vars: 333 334 * `SKAFFOLD_ALL` (same as `--all`) 335 * `SKAFFOLD_CONFIG` (same as `--config`) 336 * `SKAFFOLD_KUBE_CONTEXT` (same as `--kube-context`) 337 338 ### skaffold config set 339 340 Set a value in the global Skaffold config 341 342 ``` 343 344 345 Examples: 346 # Mark a registry as insecure 347 skaffold config set insecure-registries <insecure1.io> 348 349 # Globally set the default image repository 350 skaffold config set default-repo <myrepo> 351 352 # Globally set multi-level repo support 353 skaffold config set multi-level-repo true 354 355 # Disable pushing images for a given Kubernetes context 356 skaffold config set --kube-context <mycluster> local-cluster true 357 358 Options: 359 -c, --config='': Path to Skaffold config 360 -g, --global=false: Set value for global config 361 -k, --kube-context='': Kubectl context to set values against 362 363 Usage: 364 skaffold config set [options] 365 366 Use "skaffold options" for a list of global command-line options (applies to all commands). 367 368 369 ``` 370 Env vars: 371 372 * `SKAFFOLD_CONFIG` (same as `--config`) 373 * `SKAFFOLD_GLOBAL` (same as `--global`) 374 * `SKAFFOLD_KUBE_CONTEXT` (same as `--kube-context`) 375 376 ### skaffold config unset 377 378 Unset a value in the global Skaffold config 379 380 ``` 381 382 383 Options: 384 -c, --config='': Path to Skaffold config 385 -g, --global=false: Set value for global config 386 -k, --kube-context='': Kubectl context to set values against 387 388 Usage: 389 skaffold config unset [options] 390 391 Use "skaffold options" for a list of global command-line options (applies to all commands). 392 393 394 ``` 395 Env vars: 396 397 * `SKAFFOLD_CONFIG` (same as `--config`) 398 * `SKAFFOLD_GLOBAL` (same as `--global`) 399 * `SKAFFOLD_KUBE_CONTEXT` (same as `--kube-context`) 400 401 ### skaffold debug 402 403 Run a pipeline in debug mode 404 405 ``` 406 407 408 Examples: 409 # Launch with port-forwarding 410 skaffold debug --port-forward 411 412 Options: 413 --assume-yes=false: If true, skaffold will skip yes/no confirmation from the user and default to yes 414 --auto=false: Run with an auto-generated skaffold configuration. This will create a temporary `skaffold.yaml` file and kubernetes manifests necessary to run the application 415 --auto-build=false: When set to false, builds wait for API request instead of running automatically 416 --auto-create-config=true: If true, skaffold will try to create a config for the user's run if it doesn't find one 417 --auto-deploy=false: When set to false, deploys wait for API request instead of running automatically 418 --auto-sync=false: When set to false, syncs wait for API request instead of running automatically 419 --build-concurrency=-1: Number of concurrently running builds. Set to 0 to run all builds in parallel. Doesn't violate build order among dependencies. 420 --cache-artifacts=true: Set to false to disable default caching of artifacts 421 --cache-file='': Specify the location of the cache file (default $HOME/.skaffold/cache) 422 --check-cluster-node-platforms=true: When set to true, images are built for the target platforms matching the active kubernetes cluster node platforms. Enabled by default for `dev`, `debug` and `run` 423 --cleanup=true: Delete deployments after dev or debug mode is interrupted 424 --cloud-run-location='': The GCP Region to deploy Cloud Run services to 425 --cloud-run-project='': The GCP Project ID or Project Number to deploy for Cloud Run 426 -c, --config='': File for global configurations (defaults to $HOME/.skaffold/config) 427 -d, --default-repo='': Default repository value (overrides global config) 428 --detect-minikube=true: Use heuristics to detect a minikube cluster 429 --disable-multi-platform-build=true: When set to true, forces only single platform image builds even when multiple target platforms are specified. Enabled by default for `dev` and `debug` modes, to keep dev-loop fast 430 --enable-platform-node-affinity=true: If true, when deploying to a mixed node cluster, skaffold will add platform (os/arch) node affinity definition to rendered manifests based on the image platforms 431 -f, --filename='skaffold.yaml': Path or URL to the Skaffold config file 432 --force=false: Recreate Kubernetes resources if necessary for deployment, warning: might cause downtime! 433 --hydration-dir='.kpt-pipeline': The directory to where the (kpt) hydration takes place. Default to a hidden directory .kpt-pipeline. 434 --insecure-registry=[]: Target registries for built images which are not secure 435 --iterative-status-check=false: Run `status-check` iteratively after each deploy step, instead of all-together at the end of all deploys (default). 436 --kube-context='': Deploy to this Kubernetes context 437 --kubeconfig='': Path to the kubeconfig file to use for CLI requests. 438 -l, --label=[]: Add custom labels to deployed objects. Set multiple times for multiple labels 439 -m, --module=[]: Filter Skaffold configs to only the provided named modules 440 --mute-logs=[]: mute logs for specified stages in pipeline (build, deploy, status-check, none, all) 441 -n, --namespace='': Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace 442 --no-prune=false: Skip removing images and containers built by Skaffold 443 --no-prune-children=false: Skip removing layers reused by Skaffold 444 --platform=[]: The platform to target for the build artifacts 445 --port-forward=user,debug: Port-forward exposes service ports and container ports within pods and other resources (off, user, services, debug, pods) 446 -p, --profile=[]: Activate profiles by name (prefixed with `-` to disable a profile) 447 --profile-auto-activation=true: Set to false to disable profile auto activation 448 --propagate-profiles=true: Setting '--propagate-profiles=false' disables propagating profiles set by the '--profile' flag across config dependencies. This mean that only profiles defined directly in the target 'skaffold.yaml' file are activated. 449 --protocols=[]: Priority sorted order of debugger protocols to support. 450 --remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos) 451 --resource-selector-rules-file='': Path to JSON file specifying the deny list of yaml objects for skaffold to NOT transform with 'image' and 'label' field replacements. NOTE: this list is additive to skaffold's default denylist and denylist has priority over allowlist 452 --rpc-http-port=: tcp port to expose the Skaffold API over HTTP REST 453 --rpc-port=: tcp port to expose the Skaffold API over gRPC 454 --skip-tests=false: Whether to skip the tests after building 455 --status-check=: Wait for deployed resources to stabilize 456 --sync-remote-cache='always': Controls how Skaffold manages the remote config cache (see `remote-cache-dir`). One of `always` (default), `missing`, or `never`. `always` syncs remote repositories to latest on access. `missing` only clones remote repositories if they do not exist locally. `never` means the user takes responsibility for updating remote repositories. 457 -t, --tag='': The optional custom tag to use for images which overrides the current Tagger configuration 458 --tail=true: Stream logs from deployed objects 459 --tolerate-failures-until-deadline=false: Configures `status-check` to tolerate failures until Skaffold's statusCheckDeadline duration or the deployments progressDeadlineSeconds Otherwise deployment failures skaffold encounters will immediately fail the deployment. Defaults to 'false' 460 --toot=false: Emit a terminal beep after the deploy is complete 461 --trigger='notify': How is change detection triggered? (polling, notify, or manual) 462 --wait-for-connection=false: Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit 463 --wait-for-deletions=true: Wait for pending deletions to complete before a deployment 464 --wait-for-deletions-delay=2s: Delay between two checks for pending deletions 465 --wait-for-deletions-max=1m0s: Max duration to wait for pending deletions 466 -w, --watch-image=[]: Choose which artifacts to watch. Artifacts with image names that contain the expression will be watched only. Default is to watch sources for all artifacts 467 -i, --watch-poll-interval=1000: Interval (in ms) between two checks for file changes 468 469 Usage: 470 skaffold debug [options] 471 472 Use "skaffold options" for a list of global command-line options (applies to all commands). 473 474 475 ``` 476 Env vars: 477 478 * `SKAFFOLD_ASSUME_YES` (same as `--assume-yes`) 479 * `SKAFFOLD_AUTO` (same as `--auto`) 480 * `SKAFFOLD_AUTO_BUILD` (same as `--auto-build`) 481 * `SKAFFOLD_AUTO_CREATE_CONFIG` (same as `--auto-create-config`) 482 * `SKAFFOLD_AUTO_DEPLOY` (same as `--auto-deploy`) 483 * `SKAFFOLD_AUTO_SYNC` (same as `--auto-sync`) 484 * `SKAFFOLD_BUILD_CONCURRENCY` (same as `--build-concurrency`) 485 * `SKAFFOLD_CACHE_ARTIFACTS` (same as `--cache-artifacts`) 486 * `SKAFFOLD_CACHE_FILE` (same as `--cache-file`) 487 * `SKAFFOLD_CHECK_CLUSTER_NODE_PLATFORMS` (same as `--check-cluster-node-platforms`) 488 * `SKAFFOLD_CLEANUP` (same as `--cleanup`) 489 * `SKAFFOLD_CLOUD_RUN_LOCATION` (same as `--cloud-run-location`) 490 * `SKAFFOLD_CLOUD_RUN_PROJECT` (same as `--cloud-run-project`) 491 * `SKAFFOLD_CONFIG` (same as `--config`) 492 * `SKAFFOLD_DEFAULT_REPO` (same as `--default-repo`) 493 * `SKAFFOLD_DETECT_MINIKUBE` (same as `--detect-minikube`) 494 * `SKAFFOLD_DISABLE_MULTI_PLATFORM_BUILD` (same as `--disable-multi-platform-build`) 495 * `SKAFFOLD_ENABLE_PLATFORM_NODE_AFFINITY` (same as `--enable-platform-node-affinity`) 496 * `SKAFFOLD_FILENAME` (same as `--filename`) 497 * `SKAFFOLD_FORCE` (same as `--force`) 498 * `SKAFFOLD_HYDRATION_DIR` (same as `--hydration-dir`) 499 * `SKAFFOLD_INSECURE_REGISTRY` (same as `--insecure-registry`) 500 * `SKAFFOLD_ITERATIVE_STATUS_CHECK` (same as `--iterative-status-check`) 501 * `SKAFFOLD_KUBE_CONTEXT` (same as `--kube-context`) 502 * `SKAFFOLD_KUBECONFIG` (same as `--kubeconfig`) 503 * `SKAFFOLD_LABEL` (same as `--label`) 504 * `SKAFFOLD_MODULE` (same as `--module`) 505 * `SKAFFOLD_MUTE_LOGS` (same as `--mute-logs`) 506 * `SKAFFOLD_NAMESPACE` (same as `--namespace`) 507 * `SKAFFOLD_NO_PRUNE` (same as `--no-prune`) 508 * `SKAFFOLD_NO_PRUNE_CHILDREN` (same as `--no-prune-children`) 509 * `SKAFFOLD_PLATFORM` (same as `--platform`) 510 * `SKAFFOLD_PORT_FORWARD` (same as `--port-forward`) 511 * `SKAFFOLD_PROFILE` (same as `--profile`) 512 * `SKAFFOLD_PROFILE_AUTO_ACTIVATION` (same as `--profile-auto-activation`) 513 * `SKAFFOLD_PROPAGATE_PROFILES` (same as `--propagate-profiles`) 514 * `SKAFFOLD_PROTOCOLS` (same as `--protocols`) 515 * `SKAFFOLD_REMOTE_CACHE_DIR` (same as `--remote-cache-dir`) 516 * `SKAFFOLD_RESOURCE_SELECTOR_RULES_FILE` (same as `--resource-selector-rules-file`) 517 * `SKAFFOLD_RPC_HTTP_PORT` (same as `--rpc-http-port`) 518 * `SKAFFOLD_RPC_PORT` (same as `--rpc-port`) 519 * `SKAFFOLD_SKIP_TESTS` (same as `--skip-tests`) 520 * `SKAFFOLD_STATUS_CHECK` (same as `--status-check`) 521 * `SKAFFOLD_SYNC_REMOTE_CACHE` (same as `--sync-remote-cache`) 522 * `SKAFFOLD_TAG` (same as `--tag`) 523 * `SKAFFOLD_TAIL` (same as `--tail`) 524 * `SKAFFOLD_TOLERATE_FAILURES_UNTIL_DEADLINE` (same as `--tolerate-failures-until-deadline`) 525 * `SKAFFOLD_TOOT` (same as `--toot`) 526 * `SKAFFOLD_TRIGGER` (same as `--trigger`) 527 * `SKAFFOLD_WAIT_FOR_CONNECTION` (same as `--wait-for-connection`) 528 * `SKAFFOLD_WAIT_FOR_DELETIONS` (same as `--wait-for-deletions`) 529 * `SKAFFOLD_WAIT_FOR_DELETIONS_DELAY` (same as `--wait-for-deletions-delay`) 530 * `SKAFFOLD_WAIT_FOR_DELETIONS_MAX` (same as `--wait-for-deletions-max`) 531 * `SKAFFOLD_WATCH_IMAGE` (same as `--watch-image`) 532 * `SKAFFOLD_WATCH_POLL_INTERVAL` (same as `--watch-poll-interval`) 533 534 ### skaffold delete 535 536 Delete any resources deployed by Skaffold 537 538 ``` 539 540 541 Examples: 542 # Print the resources to be deleted 543 skaffold delete --dry-run 544 545 Options: 546 --assume-yes=false: If true, skaffold will skip yes/no confirmation from the user and default to yes 547 --cloud-run-location='': The GCP Region to deploy Cloud Run services to 548 --cloud-run-project='': The GCP Project ID or Project Number to deploy for Cloud Run 549 -c, --config='': File for global configurations (defaults to $HOME/.skaffold/config) 550 -d, --default-repo='': Default repository value (overrides global config) 551 --detect-minikube=true: Use heuristics to detect a minikube cluster 552 --dry-run=false: Don't delete resources, just print them. 553 -f, --filename='skaffold.yaml': Path or URL to the Skaffold config file 554 --kube-context='': Deploy to this Kubernetes context 555 --kubeconfig='': Path to the kubeconfig file to use for CLI requests. 556 -m, --module=[]: Filter Skaffold configs to only the provided named modules 557 -n, --namespace='': Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace 558 -p, --profile=[]: Activate profiles by name (prefixed with `-` to disable a profile) 559 --profile-auto-activation=true: Set to false to disable profile auto activation 560 --propagate-profiles=true: Setting '--propagate-profiles=false' disables propagating profiles set by the '--profile' flag across config dependencies. This mean that only profiles defined directly in the target 'skaffold.yaml' file are activated. 561 --remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos) 562 --sync-remote-cache='always': Controls how Skaffold manages the remote config cache (see `remote-cache-dir`). One of `always` (default), `missing`, or `never`. `always` syncs remote repositories to latest on access. `missing` only clones remote repositories if they do not exist locally. `never` means the user takes responsibility for updating remote repositories. 563 564 Usage: 565 skaffold delete [options] 566 567 Use "skaffold options" for a list of global command-line options (applies to all commands). 568 569 570 ``` 571 Env vars: 572 573 * `SKAFFOLD_ASSUME_YES` (same as `--assume-yes`) 574 * `SKAFFOLD_CLOUD_RUN_LOCATION` (same as `--cloud-run-location`) 575 * `SKAFFOLD_CLOUD_RUN_PROJECT` (same as `--cloud-run-project`) 576 * `SKAFFOLD_CONFIG` (same as `--config`) 577 * `SKAFFOLD_DEFAULT_REPO` (same as `--default-repo`) 578 * `SKAFFOLD_DETECT_MINIKUBE` (same as `--detect-minikube`) 579 * `SKAFFOLD_DRY_RUN` (same as `--dry-run`) 580 * `SKAFFOLD_FILENAME` (same as `--filename`) 581 * `SKAFFOLD_KUBE_CONTEXT` (same as `--kube-context`) 582 * `SKAFFOLD_KUBECONFIG` (same as `--kubeconfig`) 583 * `SKAFFOLD_MODULE` (same as `--module`) 584 * `SKAFFOLD_NAMESPACE` (same as `--namespace`) 585 * `SKAFFOLD_PROFILE` (same as `--profile`) 586 * `SKAFFOLD_PROFILE_AUTO_ACTIVATION` (same as `--profile-auto-activation`) 587 * `SKAFFOLD_PROPAGATE_PROFILES` (same as `--propagate-profiles`) 588 * `SKAFFOLD_REMOTE_CACHE_DIR` (same as `--remote-cache-dir`) 589 * `SKAFFOLD_SYNC_REMOTE_CACHE` (same as `--sync-remote-cache`) 590 591 ### skaffold deploy 592 593 Deploy pre-built artifacts 594 595 ``` 596 597 598 Examples: 599 # Build the artifacts and collect the tags into a file 600 skaffold build --file-output=tags.json 601 602 # Deploy those tags 603 skaffold deploy --build-artifacts=tags.json 604 605 # Build the artifacts and then deploy them 606 skaffold build -q | skaffold deploy --build-artifacts - 607 608 Options: 609 --assume-yes=false: If true, skaffold will skip yes/no confirmation from the user and default to yes 610 -a, --build-artifacts=: File containing pre-built images to use instead of rebuilding artifacts. A sample file looks like the following: 611 { 612 "builds":[ 613 { 614 "imageName":"registry/image1", 615 "tag":"registry/image1:tag" 616 },{ 617 "imageName":"registry/image2", 618 "tag":"registry/image2:tag" 619 }] 620 } 621 The build result from a previous 'skaffold build --file-output' run can be used here 622 --build-concurrency=-1: Number of concurrently running builds. Set to 0 to run all builds in parallel. Doesn't violate build order among dependencies. 623 --cloud-run-location='': The GCP Region to deploy Cloud Run services to 624 --cloud-run-project='': The GCP Project ID or Project Number to deploy for Cloud Run 625 -c, --config='': File for global configurations (defaults to $HOME/.skaffold/config) 626 -d, --default-repo='': Default repository value (overrides global config) 627 --detect-minikube=true: Use heuristics to detect a minikube cluster 628 --enable-platform-node-affinity=false: If true, when deploying to a mixed node cluster, skaffold will add platform (os/arch) node affinity definition to rendered manifests based on the image platforms 629 -f, --filename='skaffold.yaml': Path or URL to the Skaffold config file 630 --force=false: Recreate Kubernetes resources if necessary for deployment, warning: might cause downtime! 631 --hydration-dir='.kpt-pipeline': The directory to where the (kpt) hydration takes place. Default to a hidden directory .kpt-pipeline. 632 -i, --images=: A list of pre-built images to deploy, either tagged images or NAME=TAG pairs 633 --iterative-status-check=false: Run `status-check` iteratively after each deploy step, instead of all-together at the end of all deploys (default). 634 --kube-context='': Deploy to this Kubernetes context 635 --kubeconfig='': Path to the kubeconfig file to use for CLI requests. 636 -l, --label=[]: Add custom labels to deployed objects. Set multiple times for multiple labels 637 --load-images=false: If true, skaffold will force load the container images into the local cluster. 638 -m, --module=[]: Filter Skaffold configs to only the provided named modules 639 --mute-logs=[]: mute logs for specified stages in pipeline (build, deploy, status-check, none, all) 640 -n, --namespace='': Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace 641 --port-forward=off: Port-forward exposes service ports and container ports within pods and other resources (off, user, services, debug, pods) 642 -p, --profile=[]: Activate profiles by name (prefixed with `-` to disable a profile) 643 --profile-auto-activation=true: Set to false to disable profile auto activation 644 --propagate-profiles=true: Setting '--propagate-profiles=false' disables propagating profiles set by the '--profile' flag across config dependencies. This mean that only profiles defined directly in the target 'skaffold.yaml' file are activated. 645 --remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos) 646 --resource-selector-rules-file='': Path to JSON file specifying the deny list of yaml objects for skaffold to NOT transform with 'image' and 'label' field replacements. NOTE: this list is additive to skaffold's default denylist and denylist has priority over allowlist 647 --rpc-http-port=: tcp port to expose the Skaffold API over HTTP REST 648 --rpc-port=: tcp port to expose the Skaffold API over gRPC 649 --status-check=: Wait for deployed resources to stabilize 650 --sync-remote-cache='always': Controls how Skaffold manages the remote config cache (see `remote-cache-dir`). One of `always` (default), `missing`, or `never`. `always` syncs remote repositories to latest on access. `missing` only clones remote repositories if they do not exist locally. `never` means the user takes responsibility for updating remote repositories. 651 -t, --tag='': The optional custom tag to use for images which overrides the current Tagger configuration 652 --tail=false: Stream logs from deployed objects 653 --tolerate-failures-until-deadline=false: Configures `status-check` to tolerate failures until Skaffold's statusCheckDeadline duration or the deployments progressDeadlineSeconds Otherwise deployment failures skaffold encounters will immediately fail the deployment. Defaults to 'false' 654 --toot=false: Emit a terminal beep after the deploy is complete 655 --wait-for-connection=false: Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit 656 --wait-for-deletions=true: Wait for pending deletions to complete before a deployment 657 --wait-for-deletions-delay=2s: Delay between two checks for pending deletions 658 --wait-for-deletions-max=1m0s: Max duration to wait for pending deletions 659 660 Usage: 661 skaffold deploy [options] 662 663 Use "skaffold options" for a list of global command-line options (applies to all commands). 664 665 666 ``` 667 Env vars: 668 669 * `SKAFFOLD_ASSUME_YES` (same as `--assume-yes`) 670 * `SKAFFOLD_BUILD_ARTIFACTS` (same as `--build-artifacts`) 671 * `SKAFFOLD_BUILD_CONCURRENCY` (same as `--build-concurrency`) 672 * `SKAFFOLD_CLOUD_RUN_LOCATION` (same as `--cloud-run-location`) 673 * `SKAFFOLD_CLOUD_RUN_PROJECT` (same as `--cloud-run-project`) 674 * `SKAFFOLD_CONFIG` (same as `--config`) 675 * `SKAFFOLD_DEFAULT_REPO` (same as `--default-repo`) 676 * `SKAFFOLD_DETECT_MINIKUBE` (same as `--detect-minikube`) 677 * `SKAFFOLD_ENABLE_PLATFORM_NODE_AFFINITY` (same as `--enable-platform-node-affinity`) 678 * `SKAFFOLD_FILENAME` (same as `--filename`) 679 * `SKAFFOLD_FORCE` (same as `--force`) 680 * `SKAFFOLD_HYDRATION_DIR` (same as `--hydration-dir`) 681 * `SKAFFOLD_IMAGES` (same as `--images`) 682 * `SKAFFOLD_ITERATIVE_STATUS_CHECK` (same as `--iterative-status-check`) 683 * `SKAFFOLD_KUBE_CONTEXT` (same as `--kube-context`) 684 * `SKAFFOLD_KUBECONFIG` (same as `--kubeconfig`) 685 * `SKAFFOLD_LABEL` (same as `--label`) 686 * `SKAFFOLD_LOAD_IMAGES` (same as `--load-images`) 687 * `SKAFFOLD_MODULE` (same as `--module`) 688 * `SKAFFOLD_MUTE_LOGS` (same as `--mute-logs`) 689 * `SKAFFOLD_NAMESPACE` (same as `--namespace`) 690 * `SKAFFOLD_PORT_FORWARD` (same as `--port-forward`) 691 * `SKAFFOLD_PROFILE` (same as `--profile`) 692 * `SKAFFOLD_PROFILE_AUTO_ACTIVATION` (same as `--profile-auto-activation`) 693 * `SKAFFOLD_PROPAGATE_PROFILES` (same as `--propagate-profiles`) 694 * `SKAFFOLD_REMOTE_CACHE_DIR` (same as `--remote-cache-dir`) 695 * `SKAFFOLD_RESOURCE_SELECTOR_RULES_FILE` (same as `--resource-selector-rules-file`) 696 * `SKAFFOLD_RPC_HTTP_PORT` (same as `--rpc-http-port`) 697 * `SKAFFOLD_RPC_PORT` (same as `--rpc-port`) 698 * `SKAFFOLD_STATUS_CHECK` (same as `--status-check`) 699 * `SKAFFOLD_SYNC_REMOTE_CACHE` (same as `--sync-remote-cache`) 700 * `SKAFFOLD_TAG` (same as `--tag`) 701 * `SKAFFOLD_TAIL` (same as `--tail`) 702 * `SKAFFOLD_TOLERATE_FAILURES_UNTIL_DEADLINE` (same as `--tolerate-failures-until-deadline`) 703 * `SKAFFOLD_TOOT` (same as `--toot`) 704 * `SKAFFOLD_WAIT_FOR_CONNECTION` (same as `--wait-for-connection`) 705 * `SKAFFOLD_WAIT_FOR_DELETIONS` (same as `--wait-for-deletions`) 706 * `SKAFFOLD_WAIT_FOR_DELETIONS_DELAY` (same as `--wait-for-deletions-delay`) 707 * `SKAFFOLD_WAIT_FOR_DELETIONS_MAX` (same as `--wait-for-deletions-max`) 708 709 ### skaffold dev 710 711 Run a pipeline in development mode 712 713 ``` 714 715 716 Options: 717 --assume-yes=false: If true, skaffold will skip yes/no confirmation from the user and default to yes 718 --auto=false: Run with an auto-generated skaffold configuration. This will create a temporary `skaffold.yaml` file and kubernetes manifests necessary to run the application 719 --auto-build=true: When set to false, builds wait for API request instead of running automatically 720 --auto-create-config=true: If true, skaffold will try to create a config for the user's run if it doesn't find one 721 --auto-deploy=true: When set to false, deploys wait for API request instead of running automatically 722 --auto-sync=true: When set to false, syncs wait for API request instead of running automatically 723 --build-concurrency=-1: Number of concurrently running builds. Set to 0 to run all builds in parallel. Doesn't violate build order among dependencies. 724 --cache-artifacts=true: Set to false to disable default caching of artifacts 725 --cache-file='': Specify the location of the cache file (default $HOME/.skaffold/cache) 726 --check-cluster-node-platforms=true: When set to true, images are built for the target platforms matching the active kubernetes cluster node platforms. Enabled by default for `dev`, `debug` and `run` 727 --cleanup=true: Delete deployments after dev or debug mode is interrupted 728 --cloud-run-location='': The GCP Region to deploy Cloud Run services to 729 --cloud-run-project='': The GCP Project ID or Project Number to deploy for Cloud Run 730 -c, --config='': File for global configurations (defaults to $HOME/.skaffold/config) 731 -d, --default-repo='': Default repository value (overrides global config) 732 --detect-minikube=true: Use heuristics to detect a minikube cluster 733 --digest-source='': Set to 'remote' to skip builds and resolve the digest of images by tag from the remote registry. Set to 'local' to build images locally and use digests from built images. Set to 'tag' to use tags directly from the build. Set to 'none' to use tags directly from the Kubernetes manifests. If unspecified, defaults to 'remote' for remote clusters, and 'tag' for local clusters like kind or minikube. 734 --disable-multi-platform-build=true: When set to true, forces only single platform image builds even when multiple target platforms are specified. Enabled by default for `dev` and `debug` modes, to keep dev-loop fast 735 --enable-platform-node-affinity=true: If true, when deploying to a mixed node cluster, skaffold will add platform (os/arch) node affinity definition to rendered manifests based on the image platforms 736 -f, --filename='skaffold.yaml': Path or URL to the Skaffold config file 737 --force=false: Recreate Kubernetes resources if necessary for deployment, warning: might cause downtime! 738 --hydration-dir='.kpt-pipeline': The directory to where the (kpt) hydration takes place. Default to a hidden directory .kpt-pipeline. 739 --insecure-registry=[]: Target registries for built images which are not secure 740 --iterative-status-check=false: Run `status-check` iteratively after each deploy step, instead of all-together at the end of all deploys (default). 741 --kube-context='': Deploy to this Kubernetes context 742 --kubeconfig='': Path to the kubeconfig file to use for CLI requests. 743 -l, --label=[]: Add custom labels to deployed objects. Set multiple times for multiple labels 744 -m, --module=[]: Filter Skaffold configs to only the provided named modules 745 --mute-logs=[]: mute logs for specified stages in pipeline (build, deploy, status-check, none, all) 746 -n, --namespace='': Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace 747 --no-prune=false: Skip removing images and containers built by Skaffold 748 --no-prune-children=false: Skip removing layers reused by Skaffold 749 --platform=[]: The platform to target for the build artifacts 750 --port-forward=user: Port-forward exposes service ports and container ports within pods and other resources (off, user, services, debug, pods) 751 -p, --profile=[]: Activate profiles by name (prefixed with `-` to disable a profile) 752 --profile-auto-activation=true: Set to false to disable profile auto activation 753 --propagate-profiles=true: Setting '--propagate-profiles=false' disables propagating profiles set by the '--profile' flag across config dependencies. This mean that only profiles defined directly in the target 'skaffold.yaml' file are activated. 754 --remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos) 755 --resource-selector-rules-file='': Path to JSON file specifying the deny list of yaml objects for skaffold to NOT transform with 'image' and 'label' field replacements. NOTE: this list is additive to skaffold's default denylist and denylist has priority over allowlist 756 --rpc-http-port=: tcp port to expose the Skaffold API over HTTP REST 757 --rpc-port=: tcp port to expose the Skaffold API over gRPC 758 --skip-tests=false: Whether to skip the tests after building 759 --status-check=: Wait for deployed resources to stabilize 760 --sync-remote-cache='always': Controls how Skaffold manages the remote config cache (see `remote-cache-dir`). One of `always` (default), `missing`, or `never`. `always` syncs remote repositories to latest on access. `missing` only clones remote repositories if they do not exist locally. `never` means the user takes responsibility for updating remote repositories. 761 -t, --tag='': The optional custom tag to use for images which overrides the current Tagger configuration 762 --tail=true: Stream logs from deployed objects 763 --tolerate-failures-until-deadline=false: Configures `status-check` to tolerate failures until Skaffold's statusCheckDeadline duration or the deployments progressDeadlineSeconds Otherwise deployment failures skaffold encounters will immediately fail the deployment. Defaults to 'false' 764 --toot=false: Emit a terminal beep after the deploy is complete 765 --trigger='notify': How is change detection triggered? (polling, notify, or manual) 766 --wait-for-connection=false: Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit 767 --wait-for-deletions=true: Wait for pending deletions to complete before a deployment 768 --wait-for-deletions-delay=2s: Delay between two checks for pending deletions 769 --wait-for-deletions-max=1m0s: Max duration to wait for pending deletions 770 -w, --watch-image=[]: Choose which artifacts to watch. Artifacts with image names that contain the expression will be watched only. Default is to watch sources for all artifacts 771 -i, --watch-poll-interval=1000: Interval (in ms) between two checks for file changes 772 773 Usage: 774 skaffold dev [options] 775 776 Use "skaffold options" for a list of global command-line options (applies to all commands). 777 778 779 ``` 780 Env vars: 781 782 * `SKAFFOLD_ASSUME_YES` (same as `--assume-yes`) 783 * `SKAFFOLD_AUTO` (same as `--auto`) 784 * `SKAFFOLD_AUTO_BUILD` (same as `--auto-build`) 785 * `SKAFFOLD_AUTO_CREATE_CONFIG` (same as `--auto-create-config`) 786 * `SKAFFOLD_AUTO_DEPLOY` (same as `--auto-deploy`) 787 * `SKAFFOLD_AUTO_SYNC` (same as `--auto-sync`) 788 * `SKAFFOLD_BUILD_CONCURRENCY` (same as `--build-concurrency`) 789 * `SKAFFOLD_CACHE_ARTIFACTS` (same as `--cache-artifacts`) 790 * `SKAFFOLD_CACHE_FILE` (same as `--cache-file`) 791 * `SKAFFOLD_CHECK_CLUSTER_NODE_PLATFORMS` (same as `--check-cluster-node-platforms`) 792 * `SKAFFOLD_CLEANUP` (same as `--cleanup`) 793 * `SKAFFOLD_CLOUD_RUN_LOCATION` (same as `--cloud-run-location`) 794 * `SKAFFOLD_CLOUD_RUN_PROJECT` (same as `--cloud-run-project`) 795 * `SKAFFOLD_CONFIG` (same as `--config`) 796 * `SKAFFOLD_DEFAULT_REPO` (same as `--default-repo`) 797 * `SKAFFOLD_DETECT_MINIKUBE` (same as `--detect-minikube`) 798 * `SKAFFOLD_DIGEST_SOURCE` (same as `--digest-source`) 799 * `SKAFFOLD_DISABLE_MULTI_PLATFORM_BUILD` (same as `--disable-multi-platform-build`) 800 * `SKAFFOLD_ENABLE_PLATFORM_NODE_AFFINITY` (same as `--enable-platform-node-affinity`) 801 * `SKAFFOLD_FILENAME` (same as `--filename`) 802 * `SKAFFOLD_FORCE` (same as `--force`) 803 * `SKAFFOLD_HYDRATION_DIR` (same as `--hydration-dir`) 804 * `SKAFFOLD_INSECURE_REGISTRY` (same as `--insecure-registry`) 805 * `SKAFFOLD_ITERATIVE_STATUS_CHECK` (same as `--iterative-status-check`) 806 * `SKAFFOLD_KUBE_CONTEXT` (same as `--kube-context`) 807 * `SKAFFOLD_KUBECONFIG` (same as `--kubeconfig`) 808 * `SKAFFOLD_LABEL` (same as `--label`) 809 * `SKAFFOLD_MODULE` (same as `--module`) 810 * `SKAFFOLD_MUTE_LOGS` (same as `--mute-logs`) 811 * `SKAFFOLD_NAMESPACE` (same as `--namespace`) 812 * `SKAFFOLD_NO_PRUNE` (same as `--no-prune`) 813 * `SKAFFOLD_NO_PRUNE_CHILDREN` (same as `--no-prune-children`) 814 * `SKAFFOLD_PLATFORM` (same as `--platform`) 815 * `SKAFFOLD_PORT_FORWARD` (same as `--port-forward`) 816 * `SKAFFOLD_PROFILE` (same as `--profile`) 817 * `SKAFFOLD_PROFILE_AUTO_ACTIVATION` (same as `--profile-auto-activation`) 818 * `SKAFFOLD_PROPAGATE_PROFILES` (same as `--propagate-profiles`) 819 * `SKAFFOLD_REMOTE_CACHE_DIR` (same as `--remote-cache-dir`) 820 * `SKAFFOLD_RESOURCE_SELECTOR_RULES_FILE` (same as `--resource-selector-rules-file`) 821 * `SKAFFOLD_RPC_HTTP_PORT` (same as `--rpc-http-port`) 822 * `SKAFFOLD_RPC_PORT` (same as `--rpc-port`) 823 * `SKAFFOLD_SKIP_TESTS` (same as `--skip-tests`) 824 * `SKAFFOLD_STATUS_CHECK` (same as `--status-check`) 825 * `SKAFFOLD_SYNC_REMOTE_CACHE` (same as `--sync-remote-cache`) 826 * `SKAFFOLD_TAG` (same as `--tag`) 827 * `SKAFFOLD_TAIL` (same as `--tail`) 828 * `SKAFFOLD_TOLERATE_FAILURES_UNTIL_DEADLINE` (same as `--tolerate-failures-until-deadline`) 829 * `SKAFFOLD_TOOT` (same as `--toot`) 830 * `SKAFFOLD_TRIGGER` (same as `--trigger`) 831 * `SKAFFOLD_WAIT_FOR_CONNECTION` (same as `--wait-for-connection`) 832 * `SKAFFOLD_WAIT_FOR_DELETIONS` (same as `--wait-for-deletions`) 833 * `SKAFFOLD_WAIT_FOR_DELETIONS_DELAY` (same as `--wait-for-deletions-delay`) 834 * `SKAFFOLD_WAIT_FOR_DELETIONS_MAX` (same as `--wait-for-deletions-max`) 835 * `SKAFFOLD_WATCH_IMAGE` (same as `--watch-image`) 836 * `SKAFFOLD_WATCH_POLL_INTERVAL` (same as `--watch-poll-interval`) 837 838 ### skaffold diagnose 839 840 Run a diagnostic on Skaffold 841 842 ``` 843 844 845 Examples: 846 # Search for configuration issues and print the effective configuration 847 skaffold diagnose 848 849 # Print the effective skaffold.yaml configuration for given profile 850 skaffold diagnose --yaml-only --profile PROFILE 851 852 Options: 853 --assume-yes=false: If true, skaffold will skip yes/no confirmation from the user and default to yes 854 -c, --config='': File for global configurations (defaults to $HOME/.skaffold/config) 855 -f, --filename='skaffold.yaml': Path or URL to the Skaffold config file 856 -m, --module=[]: Filter Skaffold configs to only the provided named modules 857 -p, --profile=[]: Activate profiles by name (prefixed with `-` to disable a profile) 858 --profile-auto-activation=true: Set to false to disable profile auto activation 859 --propagate-profiles=true: Setting '--propagate-profiles=false' disables propagating profiles set by the '--profile' flag across config dependencies. This mean that only profiles defined directly in the target 'skaffold.yaml' file are activated. 860 --remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos) 861 --sync-remote-cache='missing': Controls how Skaffold manages the remote config cache (see `remote-cache-dir`). One of `always` (default), `missing`, or `never`. `always` syncs remote repositories to latest on access. `missing` only clones remote repositories if they do not exist locally. `never` means the user takes responsibility for updating remote repositories. 862 --yaml-only=false: Only prints the effective skaffold.yaml configuration 863 864 Usage: 865 skaffold diagnose [options] 866 867 Use "skaffold options" for a list of global command-line options (applies to all commands). 868 869 870 ``` 871 Env vars: 872 873 * `SKAFFOLD_ASSUME_YES` (same as `--assume-yes`) 874 * `SKAFFOLD_CONFIG` (same as `--config`) 875 * `SKAFFOLD_FILENAME` (same as `--filename`) 876 * `SKAFFOLD_MODULE` (same as `--module`) 877 * `SKAFFOLD_PROFILE` (same as `--profile`) 878 * `SKAFFOLD_PROFILE_AUTO_ACTIVATION` (same as `--profile-auto-activation`) 879 * `SKAFFOLD_PROPAGATE_PROFILES` (same as `--propagate-profiles`) 880 * `SKAFFOLD_REMOTE_CACHE_DIR` (same as `--remote-cache-dir`) 881 * `SKAFFOLD_SYNC_REMOTE_CACHE` (same as `--sync-remote-cache`) 882 * `SKAFFOLD_YAML_ONLY` (same as `--yaml-only`) 883 884 ### skaffold fix 885 886 Update old configuration to a newer schema version 887 888 ``` 889 890 891 Examples: 892 # Update "skaffold.yaml" in the current folder to the latest version 893 skaffold fix 894 895 # Update "skaffold.yaml" in the current folder to version "skaffold/v1" 896 skaffold fix --version skaffold/v1 897 898 # Update "skaffold.yaml" in the current folder in-place 899 skaffold fix --overwrite 900 901 # Update "skaffold.yaml" and write the output to a new file 902 skaffold fix --output skaffold.new.yaml 903 904 Options: 905 --assume-yes=false: If true, skaffold will skip yes/no confirmation from the user and default to yes 906 -f, --filename='skaffold.yaml': Path or URL to the Skaffold config file 907 -m, --module=[]: Filter Skaffold configs to only the provided named modules 908 -o, --output='': File to write the changed config (instead of standard output) 909 --overwrite=false: Overwrite original config with fixed config 910 --remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos) 911 --sync-remote-cache='missing': Controls how Skaffold manages the remote config cache (see `remote-cache-dir`). One of `always` (default), `missing`, or `never`. `always` syncs remote repositories to latest on access. `missing` only clones remote repositories if they do not exist locally. `never` means the user takes responsibility for updating remote repositories. 912 --version='skaffold/v4beta2': Target schema version to upgrade to 913 914 Usage: 915 skaffold fix [options] 916 917 Use "skaffold options" for a list of global command-line options (applies to all commands). 918 919 920 ``` 921 Env vars: 922 923 * `SKAFFOLD_ASSUME_YES` (same as `--assume-yes`) 924 * `SKAFFOLD_FILENAME` (same as `--filename`) 925 * `SKAFFOLD_MODULE` (same as `--module`) 926 * `SKAFFOLD_OUTPUT` (same as `--output`) 927 * `SKAFFOLD_OVERWRITE` (same as `--overwrite`) 928 * `SKAFFOLD_REMOTE_CACHE_DIR` (same as `--remote-cache-dir`) 929 * `SKAFFOLD_SYNC_REMOTE_CACHE` (same as `--sync-remote-cache`) 930 * `SKAFFOLD_VERSION` (same as `--version`) 931 932 ### skaffold init 933 934 Generate configuration for deploying an application 935 936 ``` 937 938 939 Options: 940 --analyze=false: Print all discoverable Dockerfiles and images in JSON format to stdout 941 -a, --artifact=[]: '='-delimited Dockerfile/image pair, or JSON string, to generate build artifact 942 (example: --artifact='{"builder":"Docker","payload":{"path":"/web/Dockerfile.web"},"image":"gcr.io/web-project/image"}') 943 --assume-yes=false: If true, skaffold will skip yes/no confirmation from the user and default to yes 944 --compose-file='': Initialize from a docker-compose file 945 --default-kustomization='': Default Kustomization overlay path (others will be added as profiles) 946 -f, --filename='skaffold.yaml': Path or URL to the Skaffold config file 947 --force=false: Force the generation of the Skaffold config 948 --generate-manifests=false: Allows skaffold to try and generate basic kubernetes resources to get your project started 949 -k, --kubernetes-manifest=[]: A path or a glob pattern to kubernetes manifests (can be non-existent) to be added to the kubectl deployer (overrides detection of kubernetes manifests). Repeat the flag for multiple entries. E.g.: skaffold init -k pod.yaml -k k8s/*.yml 950 -m, --module=[]: Filter Skaffold configs to only the provided named modules 951 --remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos) 952 --skip-build=false: Skip generating build artifacts in Skaffold config 953 --sync-remote-cache='always': Controls how Skaffold manages the remote config cache (see `remote-cache-dir`). One of `always` (default), `missing`, or `never`. `always` syncs remote repositories to latest on access. `missing` only clones remote repositories if they do not exist locally. `never` means the user takes responsibility for updating remote repositories. 954 955 Usage: 956 skaffold init [options] 957 958 Use "skaffold options" for a list of global command-line options (applies to all commands). 959 960 961 ``` 962 Env vars: 963 964 * `SKAFFOLD_ANALYZE` (same as `--analyze`) 965 * `SKAFFOLD_ARTIFACT` (same as `--artifact`) 966 * `SKAFFOLD_ASSUME_YES` (same as `--assume-yes`) 967 * `SKAFFOLD_COMPOSE_FILE` (same as `--compose-file`) 968 * `SKAFFOLD_DEFAULT_KUSTOMIZATION` (same as `--default-kustomization`) 969 * `SKAFFOLD_FILENAME` (same as `--filename`) 970 * `SKAFFOLD_FORCE` (same as `--force`) 971 * `SKAFFOLD_GENERATE_MANIFESTS` (same as `--generate-manifests`) 972 * `SKAFFOLD_KUBERNETES_MANIFEST` (same as `--kubernetes-manifest`) 973 * `SKAFFOLD_MODULE` (same as `--module`) 974 * `SKAFFOLD_REMOTE_CACHE_DIR` (same as `--remote-cache-dir`) 975 * `SKAFFOLD_SKIP_BUILD` (same as `--skip-build`) 976 * `SKAFFOLD_SYNC_REMOTE_CACHE` (same as `--sync-remote-cache`) 977 978 ### skaffold options 979 980 981 982 ``` 983 The following options can be passed to any command: 984 985 --color=34: Specify the default output color in ANSI escape codes 986 --interactive=true: Allow user prompts for more information 987 --timestamps=false: Print timestamps in logs 988 --update-check=true: Check for a more recent version of Skaffold 989 -v, --verbosity='warning': Log level: one of [panic fatal error warning info debug trace] 990 991 992 ``` 993 994 ### skaffold render 995 996 Generate rendered Kubernetes manifests 997 998 ``` 999 1000 1001 Examples: 1002 # Hydrate Kubernetes manifests without building the images, using digest resolved from tag in remote registry 1003 skaffold render --digest-source=remote 1004 1005 Options: 1006 --assume-yes=false: If true, skaffold will skip yes/no confirmation from the user and default to yes 1007 -a, --build-artifacts=: File containing pre-built images to use instead of rebuilding artifacts. A sample file looks like the following: 1008 { 1009 "builds":[ 1010 { 1011 "imageName":"registry/image1", 1012 "tag":"registry/image1:tag" 1013 },{ 1014 "imageName":"registry/image2", 1015 "tag":"registry/image2:tag" 1016 }] 1017 } 1018 The build result from a previous 'skaffold build --file-output' run can be used here 1019 --cache-artifacts=true: Set to false to disable default caching of artifacts 1020 -d, --default-repo='': Default repository value (overrides global config) 1021 --digest-source='': Set to 'remote' to skip builds and resolve the digest of images by tag from the remote registry. Set to 'local' to build images locally and use digests from built images. Set to 'tag' to use tags directly from the build. Set to 'none' to use tags directly from the Kubernetes manifests. If unspecified, defaults to 'remote' for remote clusters, and 'tag' for local clusters like kind or minikube. 1022 --enable-platform-node-affinity=false: If true, when deploying to a mixed node cluster, skaffold will add platform (os/arch) node affinity definition to rendered manifests based on the image platforms 1023 -f, --filename='skaffold.yaml': Path or URL to the Skaffold config file 1024 --hydration-dir='.kpt-pipeline': The directory to where the (kpt) hydration takes place. Default to a hidden directory .kpt-pipeline. 1025 -i, --images=: A list of pre-built images to deploy, either tagged images or NAME=TAG pairs 1026 -l, --label=[]: Add custom labels to deployed objects. Set multiple times for multiple labels 1027 --loud=false: Show the build logs and output 1028 -m, --module=[]: Filter Skaffold configs to only the provided named modules 1029 -n, --namespace='': Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace 1030 --offline=false: Do not connect to Kubernetes API server for manifest creation and validation. This is helpful when no Kubernetes cluster is available (e.g. GitOps model). No metadata.namespace attribute is injected in this case - the manifest content does not get changed. 1031 -o, --output='': File to write rendered manifests to 1032 --platform=[]: The platform to target for the build artifacts 1033 -p, --profile=[]: Activate profiles by name (prefixed with `-` to disable a profile) 1034 --profile-auto-activation=true: Set to false to disable profile auto activation 1035 --propagate-profiles=true: Setting '--propagate-profiles=false' disables propagating profiles set by the '--profile' flag across config dependencies. This mean that only profiles defined directly in the target 'skaffold.yaml' file are activated. 1036 --remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos) 1037 --resource-selector-rules-file='': Path to JSON file specifying the deny list of yaml objects for skaffold to NOT transform with 'image' and 'label' field replacements. NOTE: this list is additive to skaffold's default denylist and denylist has priority over allowlist 1038 --sync-remote-cache='always': Controls how Skaffold manages the remote config cache (see `remote-cache-dir`). One of `always` (default), `missing`, or `never`. `always` syncs remote repositories to latest on access. `missing` only clones remote repositories if they do not exist locally. `never` means the user takes responsibility for updating remote repositories. 1039 -t, --tag='': The optional custom tag to use for images which overrides the current Tagger configuration 1040 --wait-for-connection=false: Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit 1041 1042 Usage: 1043 skaffold render [options] 1044 1045 Use "skaffold options" for a list of global command-line options (applies to all commands). 1046 1047 1048 ``` 1049 Env vars: 1050 1051 * `SKAFFOLD_ASSUME_YES` (same as `--assume-yes`) 1052 * `SKAFFOLD_BUILD_ARTIFACTS` (same as `--build-artifacts`) 1053 * `SKAFFOLD_CACHE_ARTIFACTS` (same as `--cache-artifacts`) 1054 * `SKAFFOLD_DEFAULT_REPO` (same as `--default-repo`) 1055 * `SKAFFOLD_DIGEST_SOURCE` (same as `--digest-source`) 1056 * `SKAFFOLD_ENABLE_PLATFORM_NODE_AFFINITY` (same as `--enable-platform-node-affinity`) 1057 * `SKAFFOLD_FILENAME` (same as `--filename`) 1058 * `SKAFFOLD_HYDRATION_DIR` (same as `--hydration-dir`) 1059 * `SKAFFOLD_IMAGES` (same as `--images`) 1060 * `SKAFFOLD_LABEL` (same as `--label`) 1061 * `SKAFFOLD_LOUD` (same as `--loud`) 1062 * `SKAFFOLD_MODULE` (same as `--module`) 1063 * `SKAFFOLD_NAMESPACE` (same as `--namespace`) 1064 * `SKAFFOLD_OFFLINE` (same as `--offline`) 1065 * `SKAFFOLD_OUTPUT` (same as `--output`) 1066 * `SKAFFOLD_PLATFORM` (same as `--platform`) 1067 * `SKAFFOLD_PROFILE` (same as `--profile`) 1068 * `SKAFFOLD_PROFILE_AUTO_ACTIVATION` (same as `--profile-auto-activation`) 1069 * `SKAFFOLD_PROPAGATE_PROFILES` (same as `--propagate-profiles`) 1070 * `SKAFFOLD_REMOTE_CACHE_DIR` (same as `--remote-cache-dir`) 1071 * `SKAFFOLD_RESOURCE_SELECTOR_RULES_FILE` (same as `--resource-selector-rules-file`) 1072 * `SKAFFOLD_SYNC_REMOTE_CACHE` (same as `--sync-remote-cache`) 1073 * `SKAFFOLD_TAG` (same as `--tag`) 1074 * `SKAFFOLD_WAIT_FOR_CONNECTION` (same as `--wait-for-connection`) 1075 1076 ### skaffold run 1077 1078 Run a pipeline 1079 1080 ``` 1081 1082 1083 Examples: 1084 # Build, test, deploy and tail the logs 1085 skaffold run --tail 1086 1087 # Run with a given profile 1088 skaffold run -p <profile> 1089 1090 Options: 1091 --assume-yes=false: If true, skaffold will skip yes/no confirmation from the user and default to yes 1092 --auto=false: Run with an auto-generated skaffold configuration. This will create a temporary `skaffold.yaml` file and kubernetes manifests necessary to run the application 1093 --auto-create-config=true: If true, skaffold will try to create a config for the user's run if it doesn't find one 1094 --build-concurrency=-1: Number of concurrently running builds. Set to 0 to run all builds in parallel. Doesn't violate build order among dependencies. 1095 -b, --build-image=[]: Only build artifacts with image names that contain the given substring. Default is to build sources for all artifacts 1096 --cache-artifacts=true: Set to false to disable default caching of artifacts 1097 --cache-file='': Specify the location of the cache file (default $HOME/.skaffold/cache) 1098 --check-cluster-node-platforms=true: When set to true, images are built for the target platforms matching the active kubernetes cluster node platforms. Enabled by default for `dev`, `debug` and `run` 1099 --cleanup=true: Delete deployments after dev or debug mode is interrupted 1100 --cloud-run-location='': The GCP Region to deploy Cloud Run services to 1101 --cloud-run-project='': The GCP Project ID or Project Number to deploy for Cloud Run 1102 -c, --config='': File for global configurations (defaults to $HOME/.skaffold/config) 1103 -d, --default-repo='': Default repository value (overrides global config) 1104 --detect-minikube=true: Use heuristics to detect a minikube cluster 1105 --digest-source='': Set to 'remote' to skip builds and resolve the digest of images by tag from the remote registry. Set to 'local' to build images locally and use digests from built images. Set to 'tag' to use tags directly from the build. Set to 'none' to use tags directly from the Kubernetes manifests. If unspecified, defaults to 'remote' for remote clusters, and 'tag' for local clusters like kind or minikube. 1106 --disable-multi-platform-build=false: When set to true, forces only single platform image builds even when multiple target platforms are specified. Enabled by default for `dev` and `debug` modes, to keep dev-loop fast 1107 --enable-platform-node-affinity=true: If true, when deploying to a mixed node cluster, skaffold will add platform (os/arch) node affinity definition to rendered manifests based on the image platforms 1108 -f, --filename='skaffold.yaml': Path or URL to the Skaffold config file 1109 --force=false: Recreate Kubernetes resources if necessary for deployment, warning: might cause downtime! 1110 --hydration-dir='.kpt-pipeline': The directory to where the (kpt) hydration takes place. Default to a hidden directory .kpt-pipeline. 1111 --insecure-registry=[]: Target registries for built images which are not secure 1112 --iterative-status-check=false: Run `status-check` iteratively after each deploy step, instead of all-together at the end of all deploys (default). 1113 --kube-context='': Deploy to this Kubernetes context 1114 --kubeconfig='': Path to the kubeconfig file to use for CLI requests. 1115 -l, --label=[]: Add custom labels to deployed objects. Set multiple times for multiple labels 1116 -m, --module=[]: Filter Skaffold configs to only the provided named modules 1117 --mute-logs=[]: mute logs for specified stages in pipeline (build, deploy, status-check, none, all) 1118 -n, --namespace='': Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace 1119 --no-prune=false: Skip removing images and containers built by Skaffold 1120 --no-prune-children=false: Skip removing layers reused by Skaffold 1121 --platform=[]: The platform to target for the build artifacts 1122 --port-forward=off: Port-forward exposes service ports and container ports within pods and other resources (off, user, services, debug, pods) 1123 -p, --profile=[]: Activate profiles by name (prefixed with `-` to disable a profile) 1124 --profile-auto-activation=true: Set to false to disable profile auto activation 1125 --propagate-profiles=true: Setting '--propagate-profiles=false' disables propagating profiles set by the '--profile' flag across config dependencies. This mean that only profiles defined directly in the target 'skaffold.yaml' file are activated. 1126 --remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos) 1127 --resource-selector-rules-file='': Path to JSON file specifying the deny list of yaml objects for skaffold to NOT transform with 'image' and 'label' field replacements. NOTE: this list is additive to skaffold's default denylist and denylist has priority over allowlist 1128 --rpc-http-port=: tcp port to expose the Skaffold API over HTTP REST 1129 --rpc-port=: tcp port to expose the Skaffold API over gRPC 1130 --skip-tests=false: Whether to skip the tests after building 1131 --status-check=: Wait for deployed resources to stabilize 1132 --sync-remote-cache='always': Controls how Skaffold manages the remote config cache (see `remote-cache-dir`). One of `always` (default), `missing`, or `never`. `always` syncs remote repositories to latest on access. `missing` only clones remote repositories if they do not exist locally. `never` means the user takes responsibility for updating remote repositories. 1133 -t, --tag='': The optional custom tag to use for images which overrides the current Tagger configuration 1134 --tail=false: Stream logs from deployed objects 1135 --tolerate-failures-until-deadline=false: Configures `status-check` to tolerate failures until Skaffold's statusCheckDeadline duration or the deployments progressDeadlineSeconds Otherwise deployment failures skaffold encounters will immediately fail the deployment. Defaults to 'false' 1136 --toot=false: Emit a terminal beep after the deploy is complete 1137 --wait-for-connection=false: Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit 1138 --wait-for-deletions=true: Wait for pending deletions to complete before a deployment 1139 --wait-for-deletions-delay=2s: Delay between two checks for pending deletions 1140 --wait-for-deletions-max=1m0s: Max duration to wait for pending deletions 1141 1142 Usage: 1143 skaffold run [options] 1144 1145 Use "skaffold options" for a list of global command-line options (applies to all commands). 1146 1147 1148 ``` 1149 Env vars: 1150 1151 * `SKAFFOLD_ASSUME_YES` (same as `--assume-yes`) 1152 * `SKAFFOLD_AUTO` (same as `--auto`) 1153 * `SKAFFOLD_AUTO_CREATE_CONFIG` (same as `--auto-create-config`) 1154 * `SKAFFOLD_BUILD_CONCURRENCY` (same as `--build-concurrency`) 1155 * `SKAFFOLD_BUILD_IMAGE` (same as `--build-image`) 1156 * `SKAFFOLD_CACHE_ARTIFACTS` (same as `--cache-artifacts`) 1157 * `SKAFFOLD_CACHE_FILE` (same as `--cache-file`) 1158 * `SKAFFOLD_CHECK_CLUSTER_NODE_PLATFORMS` (same as `--check-cluster-node-platforms`) 1159 * `SKAFFOLD_CLEANUP` (same as `--cleanup`) 1160 * `SKAFFOLD_CLOUD_RUN_LOCATION` (same as `--cloud-run-location`) 1161 * `SKAFFOLD_CLOUD_RUN_PROJECT` (same as `--cloud-run-project`) 1162 * `SKAFFOLD_CONFIG` (same as `--config`) 1163 * `SKAFFOLD_DEFAULT_REPO` (same as `--default-repo`) 1164 * `SKAFFOLD_DETECT_MINIKUBE` (same as `--detect-minikube`) 1165 * `SKAFFOLD_DIGEST_SOURCE` (same as `--digest-source`) 1166 * `SKAFFOLD_DISABLE_MULTI_PLATFORM_BUILD` (same as `--disable-multi-platform-build`) 1167 * `SKAFFOLD_ENABLE_PLATFORM_NODE_AFFINITY` (same as `--enable-platform-node-affinity`) 1168 * `SKAFFOLD_FILENAME` (same as `--filename`) 1169 * `SKAFFOLD_FORCE` (same as `--force`) 1170 * `SKAFFOLD_HYDRATION_DIR` (same as `--hydration-dir`) 1171 * `SKAFFOLD_INSECURE_REGISTRY` (same as `--insecure-registry`) 1172 * `SKAFFOLD_ITERATIVE_STATUS_CHECK` (same as `--iterative-status-check`) 1173 * `SKAFFOLD_KUBE_CONTEXT` (same as `--kube-context`) 1174 * `SKAFFOLD_KUBECONFIG` (same as `--kubeconfig`) 1175 * `SKAFFOLD_LABEL` (same as `--label`) 1176 * `SKAFFOLD_MODULE` (same as `--module`) 1177 * `SKAFFOLD_MUTE_LOGS` (same as `--mute-logs`) 1178 * `SKAFFOLD_NAMESPACE` (same as `--namespace`) 1179 * `SKAFFOLD_NO_PRUNE` (same as `--no-prune`) 1180 * `SKAFFOLD_NO_PRUNE_CHILDREN` (same as `--no-prune-children`) 1181 * `SKAFFOLD_PLATFORM` (same as `--platform`) 1182 * `SKAFFOLD_PORT_FORWARD` (same as `--port-forward`) 1183 * `SKAFFOLD_PROFILE` (same as `--profile`) 1184 * `SKAFFOLD_PROFILE_AUTO_ACTIVATION` (same as `--profile-auto-activation`) 1185 * `SKAFFOLD_PROPAGATE_PROFILES` (same as `--propagate-profiles`) 1186 * `SKAFFOLD_REMOTE_CACHE_DIR` (same as `--remote-cache-dir`) 1187 * `SKAFFOLD_RESOURCE_SELECTOR_RULES_FILE` (same as `--resource-selector-rules-file`) 1188 * `SKAFFOLD_RPC_HTTP_PORT` (same as `--rpc-http-port`) 1189 * `SKAFFOLD_RPC_PORT` (same as `--rpc-port`) 1190 * `SKAFFOLD_SKIP_TESTS` (same as `--skip-tests`) 1191 * `SKAFFOLD_STATUS_CHECK` (same as `--status-check`) 1192 * `SKAFFOLD_SYNC_REMOTE_CACHE` (same as `--sync-remote-cache`) 1193 * `SKAFFOLD_TAG` (same as `--tag`) 1194 * `SKAFFOLD_TAIL` (same as `--tail`) 1195 * `SKAFFOLD_TOLERATE_FAILURES_UNTIL_DEADLINE` (same as `--tolerate-failures-until-deadline`) 1196 * `SKAFFOLD_TOOT` (same as `--toot`) 1197 * `SKAFFOLD_WAIT_FOR_CONNECTION` (same as `--wait-for-connection`) 1198 * `SKAFFOLD_WAIT_FOR_DELETIONS` (same as `--wait-for-deletions`) 1199 * `SKAFFOLD_WAIT_FOR_DELETIONS_DELAY` (same as `--wait-for-deletions-delay`) 1200 * `SKAFFOLD_WAIT_FOR_DELETIONS_MAX` (same as `--wait-for-deletions-max`) 1201 1202 ### skaffold schema 1203 1204 List JSON schemas used to validate skaffold.yaml configuration 1205 1206 ``` 1207 1208 1209 Available Commands: 1210 get Print a given skaffold.yaml's json schema 1211 1212 Use "skaffold <command> --help" for more information about a given command. 1213 1214 1215 ``` 1216 1217 ### skaffold schema get 1218 1219 Print a given skaffold.yaml's json schema 1220 1221 ``` 1222 1223 1224 Examples: 1225 # Print the schema in version `skaffold/v1` 1226 skaffold schema get skaffold/v1 1227 1228 Usage: 1229 skaffold schema get [options] 1230 1231 Use "skaffold options" for a list of global command-line options (applies to all commands). 1232 1233 1234 ``` 1235 1236 ### skaffold survey 1237 1238 Opens a web browser to fill out the Skaffold survey 1239 1240 ``` 1241 1242 1243 Options: 1244 --id='hats': Survey ID for survey command to open. 1245 1246 Usage: 1247 skaffold survey [options] 1248 1249 Use "skaffold options" for a list of global command-line options (applies to all commands). 1250 1251 1252 ``` 1253 Env vars: 1254 1255 * `SKAFFOLD_ID` (same as `--id`) 1256 1257 ### skaffold test 1258 1259 Run tests against your built application images 1260 1261 ``` 1262 1263 1264 Examples: 1265 # Build the artifacts and collect the tags into a file 1266 skaffold build --file-output=tags.json 1267 1268 # Run test against images previously built by Skaffold into a 'tags.json' file 1269 skaffold test --build-artifacts=tags.json 1270 1271 Options: 1272 --assume-yes=false: If true, skaffold will skip yes/no confirmation from the user and default to yes 1273 -a, --build-artifacts=: File containing pre-built images to use instead of rebuilding artifacts. A sample file looks like the following: 1274 { 1275 "builds":[ 1276 { 1277 "imageName":"registry/image1", 1278 "tag":"registry/image1:tag" 1279 },{ 1280 "imageName":"registry/image2", 1281 "tag":"registry/image2:tag" 1282 }] 1283 } 1284 The build result from a previous 'skaffold build --file-output' run can be used here 1285 -c, --config='': File for global configurations (defaults to $HOME/.skaffold/config) 1286 -f, --filename='skaffold.yaml': Path or URL to the Skaffold config file 1287 -i, --images=: A list of pre-built images to deploy, either tagged images or NAME=TAG pairs 1288 -m, --module=[]: Filter Skaffold configs to only the provided named modules 1289 -p, --profile=[]: Activate profiles by name (prefixed with `-` to disable a profile) 1290 --profile-auto-activation=true: Set to false to disable profile auto activation 1291 --propagate-profiles=true: Setting '--propagate-profiles=false' disables propagating profiles set by the '--profile' flag across config dependencies. This mean that only profiles defined directly in the target 'skaffold.yaml' file are activated. 1292 --remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos) 1293 --rpc-http-port=: tcp port to expose the Skaffold API over HTTP REST 1294 --rpc-port=: tcp port to expose the Skaffold API over gRPC 1295 --sync-remote-cache='always': Controls how Skaffold manages the remote config cache (see `remote-cache-dir`). One of `always` (default), `missing`, or `never`. `always` syncs remote repositories to latest on access. `missing` only clones remote repositories if they do not exist locally. `never` means the user takes responsibility for updating remote repositories. 1296 --wait-for-connection=false: Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit 1297 1298 Usage: 1299 skaffold test [options] 1300 1301 Use "skaffold options" for a list of global command-line options (applies to all commands). 1302 1303 1304 ``` 1305 Env vars: 1306 1307 * `SKAFFOLD_ASSUME_YES` (same as `--assume-yes`) 1308 * `SKAFFOLD_BUILD_ARTIFACTS` (same as `--build-artifacts`) 1309 * `SKAFFOLD_CONFIG` (same as `--config`) 1310 * `SKAFFOLD_FILENAME` (same as `--filename`) 1311 * `SKAFFOLD_IMAGES` (same as `--images`) 1312 * `SKAFFOLD_MODULE` (same as `--module`) 1313 * `SKAFFOLD_PROFILE` (same as `--profile`) 1314 * `SKAFFOLD_PROFILE_AUTO_ACTIVATION` (same as `--profile-auto-activation`) 1315 * `SKAFFOLD_PROPAGATE_PROFILES` (same as `--propagate-profiles`) 1316 * `SKAFFOLD_REMOTE_CACHE_DIR` (same as `--remote-cache-dir`) 1317 * `SKAFFOLD_RPC_HTTP_PORT` (same as `--rpc-http-port`) 1318 * `SKAFFOLD_RPC_PORT` (same as `--rpc-port`) 1319 * `SKAFFOLD_SYNC_REMOTE_CACHE` (same as `--sync-remote-cache`) 1320 * `SKAFFOLD_WAIT_FOR_CONNECTION` (same as `--wait-for-connection`) 1321 1322 ### skaffold verify 1323 1324 Run verification tests against skaffold deployments 1325 1326 ``` 1327 1328 1329 Examples: 1330 # Deploy with skaffold and then verify deployments 1331 skaffold deploy -q | skaffold verify 1332 1333 Options: 1334 --assume-yes=false: If true, skaffold will skip yes/no confirmation from the user and default to yes 1335 -a, --build-artifacts=: File containing pre-built images to use instead of rebuilding artifacts. A sample file looks like the following: 1336 { 1337 "builds":[ 1338 { 1339 "imageName":"registry/image1", 1340 "tag":"registry/image1:tag" 1341 },{ 1342 "imageName":"registry/image2", 1343 "tag":"registry/image2:tag" 1344 }] 1345 } 1346 The build result from a previous 'skaffold build --file-output' run can be used here 1347 -d, --default-repo='': Default repository value (overrides global config) 1348 --docker-network='': Run verify tests in the specified docker network 1349 -f, --filename='skaffold.yaml': Path or URL to the Skaffold config file 1350 -m, --module=[]: Filter Skaffold configs to only the provided named modules 1351 --port-forward=off: Port-forward exposes service ports and container ports within pods and other resources (off, user, services, debug, pods) 1352 -p, --profile=[]: Activate profiles by name (prefixed with `-` to disable a profile) 1353 --profile-auto-activation=true: Set to false to disable profile auto activation 1354 --propagate-profiles=true: Setting '--propagate-profiles=false' disables propagating profiles set by the '--profile' flag across config dependencies. This mean that only profiles defined directly in the target 'skaffold.yaml' file are activated. 1355 --remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos) 1356 --rpc-http-port=: tcp port to expose the Skaffold API over HTTP REST 1357 --rpc-port=: tcp port to expose the Skaffold API over gRPC 1358 --status-check=: Wait for deployed resources to stabilize 1359 --sync-remote-cache='always': Controls how Skaffold manages the remote config cache (see `remote-cache-dir`). One of `always` (default), `missing`, or `never`. `always` syncs remote repositories to latest on access. `missing` only clones remote repositories if they do not exist locally. `never` means the user takes responsibility for updating remote repositories. 1360 1361 Usage: 1362 skaffold verify [options] 1363 1364 Use "skaffold options" for a list of global command-line options (applies to all commands). 1365 1366 1367 ``` 1368 Env vars: 1369 1370 * `SKAFFOLD_ASSUME_YES` (same as `--assume-yes`) 1371 * `SKAFFOLD_BUILD_ARTIFACTS` (same as `--build-artifacts`) 1372 * `SKAFFOLD_DEFAULT_REPO` (same as `--default-repo`) 1373 * `SKAFFOLD_DOCKER_NETWORK` (same as `--docker-network`) 1374 * `SKAFFOLD_FILENAME` (same as `--filename`) 1375 * `SKAFFOLD_MODULE` (same as `--module`) 1376 * `SKAFFOLD_PORT_FORWARD` (same as `--port-forward`) 1377 * `SKAFFOLD_PROFILE` (same as `--profile`) 1378 * `SKAFFOLD_PROFILE_AUTO_ACTIVATION` (same as `--profile-auto-activation`) 1379 * `SKAFFOLD_PROPAGATE_PROFILES` (same as `--propagate-profiles`) 1380 * `SKAFFOLD_REMOTE_CACHE_DIR` (same as `--remote-cache-dir`) 1381 * `SKAFFOLD_RPC_HTTP_PORT` (same as `--rpc-http-port`) 1382 * `SKAFFOLD_RPC_PORT` (same as `--rpc-port`) 1383 * `SKAFFOLD_STATUS_CHECK` (same as `--status-check`) 1384 * `SKAFFOLD_SYNC_REMOTE_CACHE` (same as `--sync-remote-cache`) 1385 1386 ### skaffold version 1387 1388 Print the version information 1389 1390 ``` 1391 1392 1393 Options: 1394 -o, --output={{.Version}} 1395 : Format output with go-template. For full struct documentation, see https://godoc.org/github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/version#Info 1396 1397 Usage: 1398 skaffold version [options] 1399 1400 Use "skaffold options" for a list of global command-line options (applies to all commands). 1401 1402 1403 ``` 1404 Env vars: 1405 1406 * `SKAFFOLD_OUTPUT` (same as `--output`)