CLI
Skaffold command-line interface provides the following commands:
End-to-end pipelines:
- skaffold run - to build & deploy once
- skaffold dev - to trigger the watch loop build & deploy workflow with cleanup on exit
- skaffold debug - to run a pipeline in debug mode
Pipeline building blocks for CI/CD:
- skaffold build - to just build and tag your image(s)
- skaffold deploy - to deploy the given image(s)
- skaffold delete - to cleanup the deployed artifacts
- skaffold render - build and tag images, and output templated Kubernetes manifests
- skaffold apply - to apply hydrated manifests to a cluster
Getting started with a new project:
- skaffold init - to bootstrap Skaffold config
- skaffold fix - to upgrade from older skaffold.yaml schema version to newer skaffold.yaml schema version
Other Commands:
- skaffold help - print help
- skaffold version - get Skaffold version
- skaffold completion - setup tab completion for the CLI
- skaffold config - manage context specific parameters
- skaffold credits - export third party notices to given path (./skaffold-credits by default)
- skaffold diagnose - diagnostics of Skaffold works in your project
- skaffold schema - list and print json schemas used to validate skaffold.yaml configuration
Global flags
| Flag | Description |
|---|---|
-h, --help |
Prints the HELP file for the current command. |
-v, --verbosity LOG-LEVEL |
Uses a specific log level. Available log levels are info, warn, error, fatal, debug and trace. Default value is warn. |
Global environment variables
| Flag | Description |
|---|---|
SKAFFOLD_UPDATE_CHECK |
Enables checking for latest version of the Skaffold binary. By default it’s true. |
Skaffold commands
skaffold
End-to-end Pipelines:
run Run a pipeline
dev Run a pipeline in development mode
debug Run a pipeline in debug mode
Pipeline Building Blocks:
build Build the artifacts
test Run tests against your built application images
deploy Deploy pre-built artifacts
delete Delete any resources deployed by Skaffold
render Generate rendered Kubernetes manifests
apply Apply hydrated manifests to a cluster
verify Run verification tests against skaffold deployments
Getting Started With a New Project:
init Generate configuration for deploying an application
Other Commands:
completion Output shell completion for the given shell (bash, fish or zsh)
config Interact with the global Skaffold config file (defaults to `$HOME/.skaffold/config`)
diagnose Run a diagnostic on Skaffold
exec Execute a custom action
fix Update old configuration to a newer schema version
schema List JSON schemas used to validate skaffold.yaml configuration
version Print the version information
Use "skaffold <command> --help" for more information about a given command.
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_COLOR(same as--color)SKAFFOLD_INTERACTIVE(same as--interactive)SKAFFOLD_TIMESTAMPS(same as--timestamps)SKAFFOLD_UPDATE_CHECK(same as--update-check)SKAFFOLD_VERBOSITY(same as--verbosity)
skaffold apply
Apply hydrated manifests to a cluster
Examples:
# Hydrate Kubernetes pod manifest first
skaffold render --output rendered-pod.yaml
# Then create resources on your cluster from that hydrated manifest
skaffold apply rendered-pod.yaml
Options:
--assume-yes=false:
If true, skaffold will skip yes/no confirmation from the user and default to yes
--cloud-run-location='':
The GCP Region to deploy Cloud Run services to
--cloud-run-project='':
The GCP Project ID or Project Number to deploy for Cloud Run
-c, --config='':
File for global configurations (defaults to $HOME/.skaffold/config)
-f, --filename='skaffold.yaml':
Path or URL to the Skaffold config file
--force=false:
Recreate Kubernetes resources if necessary for deployment, warning: might cause downtime!
--iterative-status-check=true:
Run `status-check` iteratively after each deploy step, instead of all-together at the end of all deploys (default).
--kube-context='':
Deploy to this Kubernetes context
--kubeconfig='':
Path to the kubeconfig file to use for CLI requests.
-l, --label=[]:
Add custom labels to deployed objects. Set multiple times for multiple labels
-m, --module=[]:
Filter Skaffold configs to only the provided named modules
-n, --namespace='':
Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace
-p, --profile=[]:
Activate profiles by name (prefixed with `-` to disable a profile)
--remote-cache-dir='':
Specify the location of the remote cache (default $HOME/.skaffold/remote-cache)
--rpc-http-port=:
tcp port to expose the Skaffold API over HTTP REST
--rpc-port=:
tcp port to expose the Skaffold API over gRPC
--status-check=:
Wait for deployed resources to stabilize
--status-check-selectors='':
File containing resource selectors for kubernetes resources status check. A sample file looks like the following: { "selectors":[ { "group":"my.domain", "kind":"MyCRD" } ] } The values of "group" and "kind" are regular expressions.
--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.
--tail=false:
Stream logs from deployed objects
--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'
--wait-for-connection=false:
Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit
Usage:
skaffold apply [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ASSUME_YES(same as--assume-yes)SKAFFOLD_CLOUD_RUN_LOCATION(same as--cloud-run-location)SKAFFOLD_CLOUD_RUN_PROJECT(same as--cloud-run-project)SKAFFOLD_CONFIG(same as--config)SKAFFOLD_FILENAME(same as--filename)SKAFFOLD_FORCE(same as--force)SKAFFOLD_ITERATIVE_STATUS_CHECK(same as--iterative-status-check)SKAFFOLD_KUBE_CONTEXT(same as--kube-context)SKAFFOLD_KUBECONFIG(same as--kubeconfig)SKAFFOLD_LABEL(same as--label)SKAFFOLD_MODULE(same as--module)SKAFFOLD_NAMESPACE(same as--namespace)SKAFFOLD_PROFILE(same as--profile)SKAFFOLD_REMOTE_CACHE_DIR(same as--remote-cache-dir)SKAFFOLD_RPC_HTTP_PORT(same as--rpc-http-port)SKAFFOLD_RPC_PORT(same as--rpc-port)SKAFFOLD_STATUS_CHECK(same as--status-check)SKAFFOLD_STATUS_CHECK_SELECTORS(same as--status-check-selectors)SKAFFOLD_SYNC_REMOTE_CACHE(same as--sync-remote-cache)SKAFFOLD_TAIL(same as--tail)SKAFFOLD_TOLERATE_FAILURES_UNTIL_DEADLINE(same as--tolerate-failures-until-deadline)SKAFFOLD_WAIT_FOR_CONNECTION(same as--wait-for-connection)
skaffold build
Build the artifacts
Examples:
# Build all the artifacts
skaffold build
# Build artifacts with a profile activated
skaffold build -p <profile>
# Build artifacts whose image name contains <db>
skaffold build -b <db>
# Quietly build artifacts and output the image names as json
skaffold build -q > build_result.json
# Build the artifacts and then deploy them
skaffold build -q | skaffold deploy --build-artifacts -
# Print the final image names
skaffold build -q --dry-run
Options:
--assume-yes=false:
If true, skaffold will skip yes/no confirmation from the user and default to yes
--build-concurrency=-1:
Number of concurrently running builds. Set to 0 to run all builds in parallel. Doesn't violate build order among dependencies.
-b, --build-image=[]:
Only build artifacts with image names that contain the given substring. Default is to build sources for all artifacts
--cache-artifacts=true:
Set to false to disable default caching of artifacts
--cache-file='':
Specify the location of the cache file (default $HOME/.skaffold/cache)
--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`
-c, --config='':
File for global configurations (defaults to $HOME/.skaffold/config)
-d, --default-repo='':
Default repository value (overrides global config)
--detect-minikube=true:
Use heuristics to detect a minikube cluster
--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
--dry-run=false:
Don't build images, just compute the tag for each artifact.
--file-output='':
Filename to write build images to
-f, --filename='skaffold.yaml':
Path or URL to the Skaffold config file
--insecure-registry=[]:
Target registries for built images which are not secure
--kube-context='':
Deploy to this Kubernetes context
--kubeconfig='':
Path to the kubeconfig file to use for CLI requests.
-m, --module=[]:
Filter Skaffold configs to only the provided named modules
--mute-logs=[]:
mute logs for specified stages in pipeline (build, deploy, status-check, none, all)
-n, --namespace='':
Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace
-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
--platform=[]:
The platform to target for the build artifacts
-p, --profile=[]:
Activate profiles by name (prefixed with `-` to disable a profile)
--profile-auto-activation=true:
Set to false to disable profile auto activation
--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.
--push=:
Push the built images to the specified image repository.
-q, --quiet=false:
Suppress the build output and print image built on success. See --output to format output.
--remote-cache-dir='':
Specify the location of the remote cache (default $HOME/.skaffold/remote-cache)
--rpc-http-port=:
tcp port to expose the Skaffold API over HTTP REST
--rpc-port=:
tcp port to expose the Skaffold API over gRPC
--skip-tests=false:
Whether to skip the tests after building
--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.
-t, --tag='':
The optional custom tag to use for images which overrides the current Tagger configuration
--toot=false:
Emit a terminal beep after the deploy is complete
--wait-for-connection=false:
Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit
Usage:
skaffold build [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ASSUME_YES(same as--assume-yes)SKAFFOLD_BUILD_CONCURRENCY(same as--build-concurrency)SKAFFOLD_BUILD_IMAGE(same as--build-image)SKAFFOLD_CACHE_ARTIFACTS(same as--cache-artifacts)SKAFFOLD_CACHE_FILE(same as--cache-file)SKAFFOLD_CHECK_CLUSTER_NODE_PLATFORMS(same as--check-cluster-node-platforms)SKAFFOLD_CONFIG(same as--config)SKAFFOLD_DEFAULT_REPO(same as--default-repo)SKAFFOLD_DETECT_MINIKUBE(same as--detect-minikube)SKAFFOLD_DISABLE_MULTI_PLATFORM_BUILD(same as--disable-multi-platform-build)SKAFFOLD_DRY_RUN(same as--dry-run)SKAFFOLD_FILE_OUTPUT(same as--file-output)SKAFFOLD_FILENAME(same as--filename)SKAFFOLD_INSECURE_REGISTRY(same as--insecure-registry)SKAFFOLD_KUBE_CONTEXT(same as--kube-context)SKAFFOLD_KUBECONFIG(same as--kubeconfig)SKAFFOLD_MODULE(same as--module)SKAFFOLD_MUTE_LOGS(same as--mute-logs)SKAFFOLD_NAMESPACE(same as--namespace)SKAFFOLD_OUTPUT(same as--output)SKAFFOLD_PLATFORM(same as--platform)SKAFFOLD_PROFILE(same as--profile)SKAFFOLD_PROFILE_AUTO_ACTIVATION(same as--profile-auto-activation)SKAFFOLD_PROPAGATE_PROFILES(same as--propagate-profiles)SKAFFOLD_PUSH(same as--push)SKAFFOLD_QUIET(same as--quiet)SKAFFOLD_REMOTE_CACHE_DIR(same as--remote-cache-dir)SKAFFOLD_RPC_HTTP_PORT(same as--rpc-http-port)SKAFFOLD_RPC_PORT(same as--rpc-port)SKAFFOLD_SKIP_TESTS(same as--skip-tests)SKAFFOLD_SYNC_REMOTE_CACHE(same as--sync-remote-cache)SKAFFOLD_TAG(same as--tag)SKAFFOLD_TOOT(same as--toot)SKAFFOLD_WAIT_FOR_CONNECTION(same as--wait-for-connection)
skaffold completion
Output shell completion for the given shell (bash, fish or zsh)
Usage:
skaffold completion SHELL [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
skaffold config
Interact with the global Skaffold config file (defaults to $HOME/.skaffold/config)
Available Commands:
list List all values set in the global Skaffold config
set Set a value in the global Skaffold config
unset Unset a value in the global Skaffold config
Use "skaffold config <command> --help" for more information about a given command.
skaffold config list
List all values set in the global Skaffold config
Options:
-a, --all=false:
Show values for all kubecontexts
-c, --config='':
Path to Skaffold config
-k, --kube-context='':
Kubectl context to set values against
Usage:
skaffold config list [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ALL(same as--all)SKAFFOLD_CONFIG(same as--config)SKAFFOLD_KUBE_CONTEXT(same as--kube-context)
skaffold config set
Set a value in the global Skaffold config
Examples:
# Mark a registry as insecure
skaffold config set insecure-registries <insecure1.io>
# Globally set the default image repository
skaffold config set default-repo <myrepo>
# Globally set multi-level repo support
skaffold config set multi-level-repo true
# Disable pushing images for a given Kubernetes context
skaffold config set --kube-context <mycluster> local-cluster true
Options:
-c, --config='':
Path to Skaffold config
-g, --global=false:
Set value for global config
-k, --kube-context='':
Kubectl context to set values against
Usage:
skaffold config set [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_CONFIG(same as--config)SKAFFOLD_GLOBAL(same as--global)SKAFFOLD_KUBE_CONTEXT(same as--kube-context)
skaffold config unset
Unset a value in the global Skaffold config
Options:
-c, --config='':
Path to Skaffold config
-g, --global=false:
Set value for global config
-k, --kube-context='':
Kubectl context to set values against
Usage:
skaffold config unset [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_CONFIG(same as--config)SKAFFOLD_GLOBAL(same as--global)SKAFFOLD_KUBE_CONTEXT(same as--kube-context)
skaffold debug
Run a pipeline in debug mode
Examples:
# Launch with port-forwarding
skaffold debug --port-forward
Options:
--assume-yes=false:
If true, skaffold will skip yes/no confirmation from the user and default to yes
--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
--auto-build=false:
When set to false, builds wait for API request instead of running automatically
--auto-create-config=true:
If true, skaffold will try to create a config for the user's run if it doesn't find one
--auto-deploy=false:
When set to false, deploys wait for API request instead of running automatically
--auto-sync=false:
When set to false, syncs wait for API request instead of running automatically
--build-concurrency=-1:
Number of concurrently running builds. Set to 0 to run all builds in parallel. Doesn't violate build order among dependencies.
--cache-artifacts=true:
Set to false to disable default caching of artifacts
--cache-file='':
Specify the location of the cache file (default $HOME/.skaffold/cache)
--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`
--cleanup=true:
Delete deployments after dev or debug mode is interrupted
--cloud-run-location='':
The GCP Region to deploy Cloud Run services to
--cloud-run-project='':
The GCP Project ID or Project Number to deploy for Cloud Run
-c, --config='':
File for global configurations (defaults to $HOME/.skaffold/config)
-d, --default-repo='':
Default repository value (overrides global config)
--detect-minikube=true:
Use heuristics to detect a minikube cluster
--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
--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
-f, --filename='skaffold.yaml':
Path or URL to the Skaffold config file
--force=false:
Recreate Kubernetes resources if necessary for deployment, warning: might cause downtime!
--hydration-dir='.kpt-pipeline':
The directory to where the (kpt) hydration takes place. Default to a hidden directory .kpt-pipeline.
--insecure-registry=[]:
Target registries for built images which are not secure
--iterative-status-check=true:
Run `status-check` iteratively after each deploy step, instead of all-together at the end of all deploys (default).
--keep-running-on-failure=false:
If true, the session will be suspended instead of ending if any errors occur, the user can fix the errors during the session suspension, the session can be restored and continued by pressing any key.
--kube-context='':
Deploy to this Kubernetes context
--kubeconfig='':
Path to the kubeconfig file to use for CLI requests.
-l, --label=[]:
Add custom labels to deployed objects. Set multiple times for multiple labels
-m, --module=[]:
Filter Skaffold configs to only the provided named modules
--mute-logs=[]:
mute logs for specified stages in pipeline (build, deploy, status-check, none, all)
-n, --namespace='':
Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace
--no-prune=false:
Skip removing images and containers built by Skaffold during cleanup after dev or debug mode
--no-prune-children=false:
Skip removing layers reused by Skaffold
--platform=[]:
The platform to target for the build artifacts
--port-forward=user,debug:
Port-forward exposes service ports and container ports within pods and other resources (off, user, services, debug, pods)
-p, --profile=[]:
Activate profiles by name (prefixed with `-` to disable a profile)
--profile-auto-activation=true:
Set to false to disable profile auto activation
--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.
--protocols=[]:
Priority sorted order of debugger protocols to support.
--remote-cache-dir='':
Specify the location of the remote cache (default $HOME/.skaffold/remote-cache)
--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
--rpc-http-port=:
tcp port to expose the Skaffold API over HTTP REST
--rpc-port=:
tcp port to expose the Skaffold API over gRPC
--skip-tests=false:
Whether to skip the tests after building
--status-check=:
Wait for deployed resources to stabilize
--status-check-selectors='':
File containing resource selectors for kubernetes resources status check. A sample file looks like the following: { "selectors":[ { "group":"my.domain", "kind":"MyCRD" } ] } The values of "group" and "kind" are regular expressions.
--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.
-t, --tag='':
The optional custom tag to use for images which overrides the current Tagger configuration
--tail=true:
Stream logs from deployed objects
--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'
--toot=false:
Emit a terminal beep after the deploy is complete
--trigger='notify':
How is change detection triggered? (polling, notify, or manual)
--wait-for-connection=false:
Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit
--wait-for-deletions=true:
Wait for pending deletions to complete before a deployment
--wait-for-deletions-delay=2s:
Delay between two checks for pending deletions
--wait-for-deletions-max=1m0s:
Max duration to wait for pending deletions
-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
-i, --watch-poll-interval=1000:
Interval (in ms) between two checks for file changes
Usage:
skaffold debug [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ASSUME_YES(same as--assume-yes)SKAFFOLD_AUTO(same as--auto)SKAFFOLD_AUTO_BUILD(same as--auto-build)SKAFFOLD_AUTO_CREATE_CONFIG(same as--auto-create-config)SKAFFOLD_AUTO_DEPLOY(same as--auto-deploy)SKAFFOLD_AUTO_SYNC(same as--auto-sync)SKAFFOLD_BUILD_CONCURRENCY(same as--build-concurrency)SKAFFOLD_CACHE_ARTIFACTS(same as--cache-artifacts)SKAFFOLD_CACHE_FILE(same as--cache-file)SKAFFOLD_CHECK_CLUSTER_NODE_PLATFORMS(same as--check-cluster-node-platforms)SKAFFOLD_CLEANUP(same as--cleanup)SKAFFOLD_CLOUD_RUN_LOCATION(same as--cloud-run-location)SKAFFOLD_CLOUD_RUN_PROJECT(same as--cloud-run-project)SKAFFOLD_CONFIG(same as--config)SKAFFOLD_DEFAULT_REPO(same as--default-repo)SKAFFOLD_DETECT_MINIKUBE(same as--detect-minikube)SKAFFOLD_DISABLE_MULTI_PLATFORM_BUILD(same as--disable-multi-platform-build)SKAFFOLD_ENABLE_PLATFORM_NODE_AFFINITY(same as--enable-platform-node-affinity)SKAFFOLD_FILENAME(same as--filename)SKAFFOLD_FORCE(same as--force)SKAFFOLD_HYDRATION_DIR(same as--hydration-dir)SKAFFOLD_INSECURE_REGISTRY(same as--insecure-registry)SKAFFOLD_ITERATIVE_STATUS_CHECK(same as--iterative-status-check)SKAFFOLD_KEEP_RUNNING_ON_FAILURE(same as--keep-running-on-failure)SKAFFOLD_KUBE_CONTEXT(same as--kube-context)SKAFFOLD_KUBECONFIG(same as--kubeconfig)SKAFFOLD_LABEL(same as--label)SKAFFOLD_MODULE(same as--module)SKAFFOLD_MUTE_LOGS(same as--mute-logs)SKAFFOLD_NAMESPACE(same as--namespace)SKAFFOLD_NO_PRUNE(same as--no-prune)SKAFFOLD_NO_PRUNE_CHILDREN(same as--no-prune-children)SKAFFOLD_PLATFORM(same as--platform)SKAFFOLD_PORT_FORWARD(same as--port-forward)SKAFFOLD_PROFILE(same as--profile)SKAFFOLD_PROFILE_AUTO_ACTIVATION(same as--profile-auto-activation)SKAFFOLD_PROPAGATE_PROFILES(same as--propagate-profiles)SKAFFOLD_PROTOCOLS(same as--protocols)SKAFFOLD_REMOTE_CACHE_DIR(same as--remote-cache-dir)SKAFFOLD_RESOURCE_SELECTOR_RULES_FILE(same as--resource-selector-rules-file)SKAFFOLD_RPC_HTTP_PORT(same as--rpc-http-port)SKAFFOLD_RPC_PORT(same as--rpc-port)SKAFFOLD_SKIP_TESTS(same as--skip-tests)SKAFFOLD_STATUS_CHECK(same as--status-check)SKAFFOLD_STATUS_CHECK_SELECTORS(same as--status-check-selectors)SKAFFOLD_SYNC_REMOTE_CACHE(same as--sync-remote-cache)SKAFFOLD_TAG(same as--tag)SKAFFOLD_TAIL(same as--tail)SKAFFOLD_TOLERATE_FAILURES_UNTIL_DEADLINE(same as--tolerate-failures-until-deadline)SKAFFOLD_TOOT(same as--toot)SKAFFOLD_TRIGGER(same as--trigger)SKAFFOLD_WAIT_FOR_CONNECTION(same as--wait-for-connection)SKAFFOLD_WAIT_FOR_DELETIONS(same as--wait-for-deletions)SKAFFOLD_WAIT_FOR_DELETIONS_DELAY(same as--wait-for-deletions-delay)SKAFFOLD_WAIT_FOR_DELETIONS_MAX(same as--wait-for-deletions-max)SKAFFOLD_WATCH_IMAGE(same as--watch-image)SKAFFOLD_WATCH_POLL_INTERVAL(same as--watch-poll-interval)
skaffold delete
Delete any resources deployed by Skaffold
Examples:
# Print the resources to be deleted
skaffold delete --dry-run
Options:
--assume-yes=false:
If true, skaffold will skip yes/no confirmation from the user and default to yes
--cloud-run-location='':
The GCP Region to deploy Cloud Run services to
--cloud-run-project='':
The GCP Project ID or Project Number to deploy for Cloud Run
-c, --config='':
File for global configurations (defaults to $HOME/.skaffold/config)
-d, --default-repo='':
Default repository value (overrides global config)
--detect-minikube=true:
Use heuristics to detect a minikube cluster
--dry-run=false:
Don't delete resources, just print them.
-f, --filename='skaffold.yaml':
Path or URL to the Skaffold config file
--kube-context='':
Deploy to this Kubernetes context
--kubeconfig='':
Path to the kubeconfig file to use for CLI requests.
-m, --module=[]:
Filter Skaffold configs to only the provided named modules
-n, --namespace='':
Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace
-p, --profile=[]:
Activate profiles by name (prefixed with `-` to disable a profile)
--profile-auto-activation=true:
Set to false to disable profile auto activation
--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.
--remote-cache-dir='':
Specify the location of the remote cache (default $HOME/.skaffold/remote-cache)
--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.
Usage:
skaffold delete [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ASSUME_YES(same as--assume-yes)SKAFFOLD_CLOUD_RUN_LOCATION(same as--cloud-run-location)SKAFFOLD_CLOUD_RUN_PROJECT(same as--cloud-run-project)SKAFFOLD_CONFIG(same as--config)SKAFFOLD_DEFAULT_REPO(same as--default-repo)SKAFFOLD_DETECT_MINIKUBE(same as--detect-minikube)SKAFFOLD_DRY_RUN(same as--dry-run)SKAFFOLD_FILENAME(same as--filename)SKAFFOLD_KUBE_CONTEXT(same as--kube-context)SKAFFOLD_KUBECONFIG(same as--kubeconfig)SKAFFOLD_MODULE(same as--module)SKAFFOLD_NAMESPACE(same as--namespace)SKAFFOLD_PROFILE(same as--profile)SKAFFOLD_PROFILE_AUTO_ACTIVATION(same as--profile-auto-activation)SKAFFOLD_PROPAGATE_PROFILES(same as--propagate-profiles)SKAFFOLD_REMOTE_CACHE_DIR(same as--remote-cache-dir)SKAFFOLD_SYNC_REMOTE_CACHE(same as--sync-remote-cache)
skaffold deploy
Deploy pre-built artifacts
Examples:
# Build the artifacts and collect the tags into a file
skaffold build --file-output=tags.json
# Deploy those tags
skaffold deploy --build-artifacts=tags.json
# Build the artifacts and then deploy them
skaffold build -q | skaffold deploy --build-artifacts -
Options:
--assume-yes=false:
If true, skaffold will skip yes/no confirmation from the user and default to yes
-a, --build-artifacts=:
File containing pre-built images to use instead of rebuilding artifacts. A sample file looks like the following: { "builds":[ { "imageName":"registry/image1", "tag":"registry/image1:tag" },{ "imageName":"registry/image2", "tag":"registry/image2:tag" }] } The build result from a previous 'skaffold build --file-output' run can be used here
--build-concurrency=-1:
Number of concurrently running builds. Set to 0 to run all builds in parallel. Doesn't violate build order among dependencies.
--cloud-run-location='':
The GCP Region to deploy Cloud Run services to
--cloud-run-project='':
The GCP Project ID or Project Number to deploy for Cloud Run
-c, --config='':
File for global configurations (defaults to $HOME/.skaffold/config)
-d, --default-repo='':
Default repository value (overrides global config)
--detect-minikube=true:
Use heuristics to detect a minikube cluster
--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
-f, --filename='skaffold.yaml':
Path or URL to the Skaffold config file
--force=false:
Recreate Kubernetes resources if necessary for deployment, warning: might cause downtime!
--hydration-dir='.kpt-pipeline':
The directory to where the (kpt) hydration takes place. Default to a hidden directory .kpt-pipeline.
-i, --images=:
A list of pre-built images to deploy, either tagged images or NAME=TAG pairs
--iterative-status-check=true:
Run `status-check` iteratively after each deploy step, instead of all-together at the end of all deploys (default).
--kube-context='':
Deploy to this Kubernetes context
--kubeconfig='':
Path to the kubeconfig file to use for CLI requests.
-l, --label=[]:
Add custom labels to deployed objects. Set multiple times for multiple labels
--load-images=false:
If true, skaffold will force load the container images into the local cluster.
-m, --module=[]:
Filter Skaffold configs to only the provided named modules
--mute-logs=[]:
mute logs for specified stages in pipeline (build, deploy, status-check, none, all)
-n, --namespace='':
Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace
--port-forward=off:
Port-forward exposes service ports and container ports within pods and other resources (off, user, services, debug, pods)
-p, --profile=[]:
Activate profiles by name (prefixed with `-` to disable a profile)
--profile-auto-activation=true:
Set to false to disable profile auto activation
--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.
--remote-cache-dir='':
Specify the location of the remote cache (default $HOME/.skaffold/remote-cache)
--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
--rpc-http-port=:
tcp port to expose the Skaffold API over HTTP REST
--rpc-port=:
tcp port to expose the Skaffold API over gRPC
--status-check=:
Wait for deployed resources to stabilize
--status-check-selectors='':
File containing resource selectors for kubernetes resources status check. A sample file looks like the following: { "selectors":[ { "group":"my.domain", "kind":"MyCRD" } ] } The values of "group" and "kind" are regular expressions.
--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.
-t, --tag='':
The optional custom tag to use for images which overrides the current Tagger configuration
--tail=false:
Stream logs from deployed objects
--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'
--toot=false:
Emit a terminal beep after the deploy is complete
--wait-for-connection=false:
Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit
--wait-for-deletions=true:
Wait for pending deletions to complete before a deployment
--wait-for-deletions-delay=2s:
Delay between two checks for pending deletions
--wait-for-deletions-max=1m0s:
Max duration to wait for pending deletions
Usage:
skaffold deploy [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ASSUME_YES(same as--assume-yes)SKAFFOLD_BUILD_ARTIFACTS(same as--build-artifacts)SKAFFOLD_BUILD_CONCURRENCY(same as--build-concurrency)SKAFFOLD_CLOUD_RUN_LOCATION(same as--cloud-run-location)SKAFFOLD_CLOUD_RUN_PROJECT(same as--cloud-run-project)SKAFFOLD_CONFIG(same as--config)SKAFFOLD_DEFAULT_REPO(same as--default-repo)SKAFFOLD_DETECT_MINIKUBE(same as--detect-minikube)SKAFFOLD_ENABLE_PLATFORM_NODE_AFFINITY(same as--enable-platform-node-affinity)SKAFFOLD_FILENAME(same as--filename)SKAFFOLD_FORCE(same as--force)SKAFFOLD_HYDRATION_DIR(same as--hydration-dir)SKAFFOLD_IMAGES(same as--images)SKAFFOLD_ITERATIVE_STATUS_CHECK(same as--iterative-status-check)SKAFFOLD_KUBE_CONTEXT(same as--kube-context)SKAFFOLD_KUBECONFIG(same as--kubeconfig)SKAFFOLD_LABEL(same as--label)SKAFFOLD_LOAD_IMAGES(same as--load-images)SKAFFOLD_MODULE(same as--module)SKAFFOLD_MUTE_LOGS(same as--mute-logs)SKAFFOLD_NAMESPACE(same as--namespace)SKAFFOLD_PORT_FORWARD(same as--port-forward)SKAFFOLD_PROFILE(same as--profile)SKAFFOLD_PROFILE_AUTO_ACTIVATION(same as--profile-auto-activation)SKAFFOLD_PROPAGATE_PROFILES(same as--propagate-profiles)SKAFFOLD_REMOTE_CACHE_DIR(same as--remote-cache-dir)SKAFFOLD_RESOURCE_SELECTOR_RULES_FILE(same as--resource-selector-rules-file)SKAFFOLD_RPC_HTTP_PORT(same as--rpc-http-port)SKAFFOLD_RPC_PORT(same as--rpc-port)SKAFFOLD_STATUS_CHECK(same as--status-check)SKAFFOLD_STATUS_CHECK_SELECTORS(same as--status-check-selectors)SKAFFOLD_SYNC_REMOTE_CACHE(same as--sync-remote-cache)SKAFFOLD_TAG(same as--tag)SKAFFOLD_TAIL(same as--tail)SKAFFOLD_TOLERATE_FAILURES_UNTIL_DEADLINE(same as--tolerate-failures-until-deadline)SKAFFOLD_TOOT(same as--toot)SKAFFOLD_WAIT_FOR_CONNECTION(same as--wait-for-connection)SKAFFOLD_WAIT_FOR_DELETIONS(same as--wait-for-deletions)SKAFFOLD_WAIT_FOR_DELETIONS_DELAY(same as--wait-for-deletions-delay)SKAFFOLD_WAIT_FOR_DELETIONS_MAX(same as--wait-for-deletions-max)
skaffold dev
Run a pipeline in development mode
Options:
--assume-yes=false:
If true, skaffold will skip yes/no confirmation from the user and default to yes
--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
--auto-build=true:
When set to false, builds wait for API request instead of running automatically
--auto-create-config=true:
If true, skaffold will try to create a config for the user's run if it doesn't find one
--auto-deploy=true:
When set to false, deploys wait for API request instead of running automatically
--auto-sync=true:
When set to false, syncs wait for API request instead of running automatically
--build-concurrency=-1:
Number of concurrently running builds. Set to 0 to run all builds in parallel. Doesn't violate build order among dependencies.
--cache-artifacts=true:
Set to false to disable default caching of artifacts
--cache-file='':
Specify the location of the cache file (default $HOME/.skaffold/cache)
--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`
--cleanup=true:
Delete deployments after dev or debug mode is interrupted
--cloud-run-location='':
The GCP Region to deploy Cloud Run services to
--cloud-run-project='':
The GCP Project ID or Project Number to deploy for Cloud Run
-c, --config='':
File for global configurations (defaults to $HOME/.skaffold/config)
-d, --default-repo='':
Default repository value (overrides global config)
--detect-minikube=true:
Use heuristics to detect a minikube cluster
--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.
--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
--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
-f, --filename='skaffold.yaml':
Path or URL to the Skaffold config file
--force=false:
Recreate Kubernetes resources if necessary for deployment, warning: might cause downtime!
--hydration-dir='.kpt-pipeline':
The directory to where the (kpt) hydration takes place. Default to a hidden directory .kpt-pipeline.
--insecure-registry=[]:
Target registries for built images which are not secure
--iterative-status-check=true:
Run `status-check` iteratively after each deploy step, instead of all-together at the end of all deploys (default).
--keep-running-on-failure=false:
If true, the session will be suspended instead of ending if any errors occur, the user can fix the errors during the session suspension, the session can be restored and continued by pressing any key.
--kube-context='':
Deploy to this Kubernetes context
--kubeconfig='':
Path to the kubeconfig file to use for CLI requests.
-l, --label=[]:
Add custom labels to deployed objects. Set multiple times for multiple labels
-m, --module=[]:
Filter Skaffold configs to only the provided named modules
--mute-logs=[]:
mute logs for specified stages in pipeline (build, deploy, status-check, none, all)
-n, --namespace='':
Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace
--no-prune=false:
Skip removing images and containers built by Skaffold during cleanup after dev or debug mode
--no-prune-children=false:
Skip removing layers reused by Skaffold
--platform=[]:
The platform to target for the build artifacts
--port-forward=user:
Port-forward exposes service ports and container ports within pods and other resources (off, user, services, debug, pods)
-p, --profile=[]:
Activate profiles by name (prefixed with `-` to disable a profile)
--profile-auto-activation=true:
Set to false to disable profile auto activation
--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.
--remote-cache-dir='':
Specify the location of the remote cache (default $HOME/.skaffold/remote-cache)
--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
--rpc-http-port=:
tcp port to expose the Skaffold API over HTTP REST
--rpc-port=:
tcp port to expose the Skaffold API over gRPC
--skip-tests=false:
Whether to skip the tests after building
--status-check=:
Wait for deployed resources to stabilize
--status-check-selectors='':
File containing resource selectors for kubernetes resources status check. A sample file looks like the following: { "selectors":[ { "group":"my.domain", "kind":"MyCRD" } ] } The values of "group" and "kind" are regular expressions.
--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.
-t, --tag='':
The optional custom tag to use for images which overrides the current Tagger configuration
--tail=true:
Stream logs from deployed objects
--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'
--toot=false:
Emit a terminal beep after the deploy is complete
--trigger='notify':
How is change detection triggered? (polling, notify, or manual)
--wait-for-connection=false:
Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit
--wait-for-deletions=true:
Wait for pending deletions to complete before a deployment
--wait-for-deletions-delay=2s:
Delay between two checks for pending deletions
--wait-for-deletions-max=1m0s:
Max duration to wait for pending deletions
-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
-i, --watch-poll-interval=1000:
Interval (in ms) between two checks for file changes
Usage:
skaffold dev [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ASSUME_YES(same as--assume-yes)SKAFFOLD_AUTO(same as--auto)SKAFFOLD_AUTO_BUILD(same as--auto-build)SKAFFOLD_AUTO_CREATE_CONFIG(same as--auto-create-config)SKAFFOLD_AUTO_DEPLOY(same as--auto-deploy)SKAFFOLD_AUTO_SYNC(same as--auto-sync)SKAFFOLD_BUILD_CONCURRENCY(same as--build-concurrency)SKAFFOLD_CACHE_ARTIFACTS(same as--cache-artifacts)SKAFFOLD_CACHE_FILE(same as--cache-file)SKAFFOLD_CHECK_CLUSTER_NODE_PLATFORMS(same as--check-cluster-node-platforms)SKAFFOLD_CLEANUP(same as--cleanup)SKAFFOLD_CLOUD_RUN_LOCATION(same as--cloud-run-location)SKAFFOLD_CLOUD_RUN_PROJECT(same as--cloud-run-project)SKAFFOLD_CONFIG(same as--config)SKAFFOLD_DEFAULT_REPO(same as--default-repo)SKAFFOLD_DETECT_MINIKUBE(same as--detect-minikube)SKAFFOLD_DIGEST_SOURCE(same as--digest-source)SKAFFOLD_DISABLE_MULTI_PLATFORM_BUILD(same as--disable-multi-platform-build)SKAFFOLD_ENABLE_PLATFORM_NODE_AFFINITY(same as--enable-platform-node-affinity)SKAFFOLD_FILENAME(same as--filename)SKAFFOLD_FORCE(same as--force)SKAFFOLD_HYDRATION_DIR(same as--hydration-dir)SKAFFOLD_INSECURE_REGISTRY(same as--insecure-registry)SKAFFOLD_ITERATIVE_STATUS_CHECK(same as--iterative-status-check)SKAFFOLD_KEEP_RUNNING_ON_FAILURE(same as--keep-running-on-failure)SKAFFOLD_KUBE_CONTEXT(same as--kube-context)SKAFFOLD_KUBECONFIG(same as--kubeconfig)SKAFFOLD_LABEL(same as--label)SKAFFOLD_MODULE(same as--module)SKAFFOLD_MUTE_LOGS(same as--mute-logs)SKAFFOLD_NAMESPACE(same as--namespace)SKAFFOLD_NO_PRUNE(same as--no-prune)SKAFFOLD_NO_PRUNE_CHILDREN(same as--no-prune-children)SKAFFOLD_PLATFORM(same as--platform)SKAFFOLD_PORT_FORWARD(same as--port-forward)SKAFFOLD_PROFILE(same as--profile)SKAFFOLD_PROFILE_AUTO_ACTIVATION(same as--profile-auto-activation)SKAFFOLD_PROPAGATE_PROFILES(same as--propagate-profiles)SKAFFOLD_REMOTE_CACHE_DIR(same as--remote-cache-dir)SKAFFOLD_RESOURCE_SELECTOR_RULES_FILE(same as--resource-selector-rules-file)SKAFFOLD_RPC_HTTP_PORT(same as--rpc-http-port)SKAFFOLD_RPC_PORT(same as--rpc-port)SKAFFOLD_SKIP_TESTS(same as--skip-tests)SKAFFOLD_STATUS_CHECK(same as--status-check)SKAFFOLD_STATUS_CHECK_SELECTORS(same as--status-check-selectors)SKAFFOLD_SYNC_REMOTE_CACHE(same as--sync-remote-cache)SKAFFOLD_TAG(same as--tag)SKAFFOLD_TAIL(same as--tail)SKAFFOLD_TOLERATE_FAILURES_UNTIL_DEADLINE(same as--tolerate-failures-until-deadline)SKAFFOLD_TOOT(same as--toot)SKAFFOLD_TRIGGER(same as--trigger)SKAFFOLD_WAIT_FOR_CONNECTION(same as--wait-for-connection)SKAFFOLD_WAIT_FOR_DELETIONS(same as--wait-for-deletions)SKAFFOLD_WAIT_FOR_DELETIONS_DELAY(same as--wait-for-deletions-delay)SKAFFOLD_WAIT_FOR_DELETIONS_MAX(same as--wait-for-deletions-max)SKAFFOLD_WATCH_IMAGE(same as--watch-image)SKAFFOLD_WATCH_POLL_INTERVAL(same as--watch-poll-interval)
skaffold diagnose
Run a diagnostic on Skaffold
Examples:
# Search for configuration issues and print the effective configuration
skaffold diagnose
# Print the effective skaffold.yaml configuration for given profile
skaffold diagnose --yaml-only --profile PROFILE
Options:
--assume-yes=false:
If true, skaffold will skip yes/no confirmation from the user and default to yes
-c, --config='':
File for global configurations (defaults to $HOME/.skaffold/config)
--enable-templating=false:
Render supported templated fields with golang template engine
-f, --filename='skaffold.yaml':
Path or URL to the Skaffold config file
-m, --module=[]:
Filter Skaffold configs to only the provided named modules
-o, --output='':
File to write diagnose result
-p, --profile=[]:
Activate profiles by name (prefixed with `-` to disable a profile)
--profile-auto-activation=true:
Set to false to disable profile auto activation
--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.
--remote-cache-dir='':
Specify the location of the remote cache (default $HOME/.skaffold/remote-cache)
--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.
--yaml-only=false:
Only prints the effective skaffold.yaml configuration
Usage:
skaffold diagnose [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ASSUME_YES(same as--assume-yes)SKAFFOLD_CONFIG(same as--config)SKAFFOLD_ENABLE_TEMPLATING(same as--enable-templating)SKAFFOLD_FILENAME(same as--filename)SKAFFOLD_MODULE(same as--module)SKAFFOLD_OUTPUT(same as--output)SKAFFOLD_PROFILE(same as--profile)SKAFFOLD_PROFILE_AUTO_ACTIVATION(same as--profile-auto-activation)SKAFFOLD_PROPAGATE_PROFILES(same as--propagate-profiles)SKAFFOLD_REMOTE_CACHE_DIR(same as--remote-cache-dir)SKAFFOLD_SYNC_REMOTE_CACHE(same as--sync-remote-cache)SKAFFOLD_YAML_ONLY(same as--yaml-only)
skaffold exec
Execute a custom action
Examples:
# Execute a defined action
skaffold exec <action-name>
# Execute a defined action that uses an image built from Skaffold. First, build the images
skaffold build --file-output=build.json
# Then use the built artifacts
skaffold exec <action-name> --build-artifacts=build.json
Options:
--assume-yes=false:
If true, skaffold will skip yes/no confirmation from the user and default to yes
-a, --build-artifacts=:
File containing pre-built images to use instead of rebuilding artifacts. A sample file looks like the following: { "builds":[ { "imageName":"registry/image1", "tag":"registry/image1:tag" },{ "imageName":"registry/image2", "tag":"registry/image2:tag" }] } The build result from a previous 'skaffold build --file-output' run can be used here
-d, --default-repo='':
Default repository value (overrides global config)
--docker-network='':
Name of an existing docker network to use when running the verify tests. If not specified, Skaffold will create a new network to use of the form 'skaffold-network-<uuid>'
--env-file='':
File containing env var key-value pairs that will be set in all verify container envs
-f, --filename='skaffold.yaml':
Path or URL to the Skaffold config file
-m, --module=[]:
Filter Skaffold configs to only the provided named modules
-n, --namespace='':
Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace
--port-forward=off:
Port-forward exposes service ports and container ports within pods and other resources (off, user, services, debug, pods)
-p, --profile=[]:
Activate profiles by name (prefixed with `-` to disable a profile)
--profile-auto-activation=true:
Set to false to disable profile auto activation
--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.
--remote-cache-dir='':
Specify the location of the remote cache (default $HOME/.skaffold/remote-cache)
--rpc-http-port=:
tcp port to expose the Skaffold API over HTTP REST
--rpc-port=:
tcp port to expose the Skaffold API over gRPC
--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.
Usage:
skaffold exec [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ASSUME_YES(same as--assume-yes)SKAFFOLD_BUILD_ARTIFACTS(same as--build-artifacts)SKAFFOLD_DEFAULT_REPO(same as--default-repo)SKAFFOLD_DOCKER_NETWORK(same as--docker-network)SKAFFOLD_ENV_FILE(same as--env-file)SKAFFOLD_FILENAME(same as--filename)SKAFFOLD_MODULE(same as--module)SKAFFOLD_NAMESPACE(same as--namespace)SKAFFOLD_PORT_FORWARD(same as--port-forward)SKAFFOLD_PROFILE(same as--profile)SKAFFOLD_PROFILE_AUTO_ACTIVATION(same as--profile-auto-activation)SKAFFOLD_PROPAGATE_PROFILES(same as--propagate-profiles)SKAFFOLD_REMOTE_CACHE_DIR(same as--remote-cache-dir)SKAFFOLD_RPC_HTTP_PORT(same as--rpc-http-port)SKAFFOLD_RPC_PORT(same as--rpc-port)SKAFFOLD_SYNC_REMOTE_CACHE(same as--sync-remote-cache)
skaffold fix
Update old configuration to a newer schema version
Examples:
# Update "skaffold.yaml" in the current folder to the latest version
skaffold fix
# Update "skaffold.yaml" in the current folder to version "skaffold/v1"
skaffold fix --version skaffold/v1
# Update "skaffold.yaml" in the current folder in-place
skaffold fix --overwrite
# Update "skaffold.yaml" and write the output to a new file
skaffold fix --output skaffold.new.yaml
Options:
--assume-yes=false:
If true, skaffold will skip yes/no confirmation from the user and default to yes
-f, --filename='skaffold.yaml':
Path or URL to the Skaffold config file
-m, --module=[]:
Filter Skaffold configs to only the provided named modules
-o, --output='':
File to write the changed config (instead of standard output)
--overwrite=false:
Overwrite original config with fixed config
--remote-cache-dir='':
Specify the location of the remote cache (default $HOME/.skaffold/remote-cache)
--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.
--version='skaffold/v4beta13':
Target schema version to upgrade to
Usage:
skaffold fix [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ASSUME_YES(same as--assume-yes)SKAFFOLD_FILENAME(same as--filename)SKAFFOLD_MODULE(same as--module)SKAFFOLD_OUTPUT(same as--output)SKAFFOLD_OVERWRITE(same as--overwrite)SKAFFOLD_REMOTE_CACHE_DIR(same as--remote-cache-dir)SKAFFOLD_SYNC_REMOTE_CACHE(same as--sync-remote-cache)SKAFFOLD_VERSION(same as--version)
skaffold init
Generate configuration for deploying an application
Options:
--analyze=false:
Print all discoverable Dockerfiles and images in JSON format to stdout
-a, --artifact=[]:
'='-delimited Dockerfile/image pair, or JSON string, to generate build artifact (example: --artifact='{"builder":"Docker","payload":{"path":"/web/Dockerfile.web"},"image":"gcr.io/web-project/image"}')
--assume-yes=false:
If true, skaffold will skip yes/no confirmation from the user and default to yes
--compose-file='':
Initialize from a docker-compose file
--default-kustomization='':
Default Kustomization overlay path (others will be added as profiles)
-f, --filename='skaffold.yaml':
Path or URL to the Skaffold config file
--force=false:
Force the generation of the Skaffold config
--generate-manifests=false:
Allows skaffold to try and generate basic kubernetes resources to get your project started
-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
-m, --module=[]:
Filter Skaffold configs to only the provided named modules
--remote-cache-dir='':
Specify the location of the remote cache (default $HOME/.skaffold/remote-cache)
--skip-build=false:
Skip generating build artifacts in Skaffold config
--skip-unreachable-dirs=false:
Instead of erroring, it will skip the directories that cannot be accessed due to permissions
--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.
Usage:
skaffold init [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ANALYZE(same as--analyze)SKAFFOLD_ARTIFACT(same as--artifact)SKAFFOLD_ASSUME_YES(same as--assume-yes)SKAFFOLD_COMPOSE_FILE(same as--compose-file)SKAFFOLD_DEFAULT_KUSTOMIZATION(same as--default-kustomization)SKAFFOLD_FILENAME(same as--filename)SKAFFOLD_FORCE(same as--force)SKAFFOLD_GENERATE_MANIFESTS(same as--generate-manifests)SKAFFOLD_KUBERNETES_MANIFEST(same as--kubernetes-manifest)SKAFFOLD_MODULE(same as--module)SKAFFOLD_REMOTE_CACHE_DIR(same as--remote-cache-dir)SKAFFOLD_SKIP_BUILD(same as--skip-build)SKAFFOLD_SKIP_UNREACHABLE_DIRS(same as--skip-unreachable-dirs)SKAFFOLD_SYNC_REMOTE_CACHE(same as--sync-remote-cache)
skaffold options
The following options can be passed to any command:
--color=34:
Specify the default output color in ANSI escape codes
--interactive=true:
Allow user prompts for more information
--timestamps=false:
Print timestamps in logs
--update-check=true:
Check for a more recent version of Skaffold
-v, --verbosity='warning':
Log level: one of [panic fatal error warning info debug trace]
skaffold render
Generate rendered Kubernetes manifests
Examples:
# Hydrate Kubernetes manifests without building the images, using digest resolved from tag in remote registry
skaffold render --digest-source=remote
Options:
--assume-yes=false:
If true, skaffold will skip yes/no confirmation from the user and default to yes
-a, --build-artifacts=:
File containing pre-built images to use instead of rebuilding artifacts. A sample file looks like the following: { "builds":[ { "imageName":"registry/image1", "tag":"registry/image1:tag" },{ "imageName":"registry/image2", "tag":"registry/image2:tag" }] } The build result from a previous 'skaffold build --file-output' run can be used here
--cache-artifacts=true:
Set to false to disable default caching of artifacts
-d, --default-repo='':
Default repository value (overrides global config)
--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.
--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
-f, --filename='skaffold.yaml':
Path or URL to the Skaffold config file
--hydration-dir='.kpt-pipeline':
The directory to where the (kpt) hydration takes place. Default to a hidden directory .kpt-pipeline.
-i, --images=:
A list of pre-built images to deploy, either tagged images or NAME=TAG pairs
-l, --label=[]:
Add custom labels to deployed objects. Set multiple times for multiple labels
--loud=false:
Show the build logs and output
-m, --module=[]:
Filter Skaffold configs to only the provided named modules
-n, --namespace='':
Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace
--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.
-o, --output='':
File to write rendered manifests to
--platform=[]:
The platform to target for the build artifacts
-p, --profile=[]:
Activate profiles by name (prefixed with `-` to disable a profile)
--profile-auto-activation=true:
Set to false to disable profile auto activation
--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.
--remote-cache-dir='':
Specify the location of the remote cache (default $HOME/.skaffold/remote-cache)
--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
--set=[]:
overrides templated manifest fields by provided key-value pairs
--set-value-file='':
overrides templated manifest fields by a file containing key-value pairs in .env file format
--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.
-t, --tag='':
The optional custom tag to use for images which overrides the current Tagger configuration
--wait-for-connection=false:
Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit
Usage:
skaffold render [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ASSUME_YES(same as--assume-yes)SKAFFOLD_BUILD_ARTIFACTS(same as--build-artifacts)SKAFFOLD_CACHE_ARTIFACTS(same as--cache-artifacts)SKAFFOLD_DEFAULT_REPO(same as--default-repo)SKAFFOLD_DIGEST_SOURCE(same as--digest-source)SKAFFOLD_ENABLE_PLATFORM_NODE_AFFINITY(same as--enable-platform-node-affinity)SKAFFOLD_FILENAME(same as--filename)SKAFFOLD_HYDRATION_DIR(same as--hydration-dir)SKAFFOLD_IMAGES(same as--images)SKAFFOLD_LABEL(same as--label)SKAFFOLD_LOUD(same as--loud)SKAFFOLD_MODULE(same as--module)SKAFFOLD_NAMESPACE(same as--namespace)SKAFFOLD_OFFLINE(same as--offline)SKAFFOLD_OUTPUT(same as--output)SKAFFOLD_PLATFORM(same as--platform)SKAFFOLD_PROFILE(same as--profile)SKAFFOLD_PROFILE_AUTO_ACTIVATION(same as--profile-auto-activation)SKAFFOLD_PROPAGATE_PROFILES(same as--propagate-profiles)SKAFFOLD_REMOTE_CACHE_DIR(same as--remote-cache-dir)SKAFFOLD_RESOURCE_SELECTOR_RULES_FILE(same as--resource-selector-rules-file)SKAFFOLD_SET(same as--set)SKAFFOLD_SET_VALUE_FILE(same as--set-value-file)SKAFFOLD_SYNC_REMOTE_CACHE(same as--sync-remote-cache)SKAFFOLD_TAG(same as--tag)SKAFFOLD_WAIT_FOR_CONNECTION(same as--wait-for-connection)
skaffold run
Run a pipeline
Examples:
# Build, test, deploy and tail the logs
skaffold run --tail
# Run with a given profile
skaffold run -p <profile>
Options:
--assume-yes=false:
If true, skaffold will skip yes/no confirmation from the user and default to yes
--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
--auto-create-config=true:
If true, skaffold will try to create a config for the user's run if it doesn't find one
--build-concurrency=-1:
Number of concurrently running builds. Set to 0 to run all builds in parallel. Doesn't violate build order among dependencies.
-b, --build-image=[]:
Only build artifacts with image names that contain the given substring. Default is to build sources for all artifacts
--cache-artifacts=true:
Set to false to disable default caching of artifacts
--cache-file='':
Specify the location of the cache file (default $HOME/.skaffold/cache)
--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`
--cleanup=true:
Delete deployments after dev or debug mode is interrupted
--cloud-run-location='':
The GCP Region to deploy Cloud Run services to
--cloud-run-project='':
The GCP Project ID or Project Number to deploy for Cloud Run
-c, --config='':
File for global configurations (defaults to $HOME/.skaffold/config)
-d, --default-repo='':
Default repository value (overrides global config)
--detect-minikube=true:
Use heuristics to detect a minikube cluster
--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.
--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
--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
-f, --filename='skaffold.yaml':
Path or URL to the Skaffold config file
--force=false:
Recreate Kubernetes resources if necessary for deployment, warning: might cause downtime!
--hydration-dir='.kpt-pipeline':
The directory to where the (kpt) hydration takes place. Default to a hidden directory .kpt-pipeline.
--insecure-registry=[]:
Target registries for built images which are not secure
--iterative-status-check=true:
Run `status-check` iteratively after each deploy step, instead of all-together at the end of all deploys (default).
--kube-context='':
Deploy to this Kubernetes context
--kubeconfig='':
Path to the kubeconfig file to use for CLI requests.
-l, --label=[]:
Add custom labels to deployed objects. Set multiple times for multiple labels
-m, --module=[]:
Filter Skaffold configs to only the provided named modules
--mute-logs=[]:
mute logs for specified stages in pipeline (build, deploy, status-check, none, all)
-n, --namespace='':
Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace
--no-prune=false:
Skip removing images and containers built by Skaffold during cleanup after dev or debug mode
--no-prune-children=false:
Skip removing layers reused by Skaffold
--platform=[]:
The platform to target for the build artifacts
--port-forward=off:
Port-forward exposes service ports and container ports within pods and other resources (off, user, services, debug, pods)
-p, --profile=[]:
Activate profiles by name (prefixed with `-` to disable a profile)
--profile-auto-activation=true:
Set to false to disable profile auto activation
--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.
--remote-cache-dir='':
Specify the location of the remote cache (default $HOME/.skaffold/remote-cache)
--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
--rpc-http-port=:
tcp port to expose the Skaffold API over HTTP REST
--rpc-port=:
tcp port to expose the Skaffold API over gRPC
--skip-tests=false:
Whether to skip the tests after building
--status-check=:
Wait for deployed resources to stabilize
--status-check-selectors='':
File containing resource selectors for kubernetes resources status check. A sample file looks like the following: { "selectors":[ { "group":"my.domain", "kind":"MyCRD" } ] } The values of "group" and "kind" are regular expressions.
--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.
-t, --tag='':
The optional custom tag to use for images which overrides the current Tagger configuration
--tail=false:
Stream logs from deployed objects
--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'
--toot=false:
Emit a terminal beep after the deploy is complete
--wait-for-connection=false:
Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit
--wait-for-deletions=true:
Wait for pending deletions to complete before a deployment
--wait-for-deletions-delay=2s:
Delay between two checks for pending deletions
--wait-for-deletions-max=1m0s:
Max duration to wait for pending deletions
Usage:
skaffold run [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ASSUME_YES(same as--assume-yes)SKAFFOLD_AUTO(same as--auto)SKAFFOLD_AUTO_CREATE_CONFIG(same as--auto-create-config)SKAFFOLD_BUILD_CONCURRENCY(same as--build-concurrency)SKAFFOLD_BUILD_IMAGE(same as--build-image)SKAFFOLD_CACHE_ARTIFACTS(same as--cache-artifacts)SKAFFOLD_CACHE_FILE(same as--cache-file)SKAFFOLD_CHECK_CLUSTER_NODE_PLATFORMS(same as--check-cluster-node-platforms)SKAFFOLD_CLEANUP(same as--cleanup)SKAFFOLD_CLOUD_RUN_LOCATION(same as--cloud-run-location)SKAFFOLD_CLOUD_RUN_PROJECT(same as--cloud-run-project)SKAFFOLD_CONFIG(same as--config)SKAFFOLD_DEFAULT_REPO(same as--default-repo)SKAFFOLD_DETECT_MINIKUBE(same as--detect-minikube)SKAFFOLD_DIGEST_SOURCE(same as--digest-source)SKAFFOLD_DISABLE_MULTI_PLATFORM_BUILD(same as--disable-multi-platform-build)SKAFFOLD_ENABLE_PLATFORM_NODE_AFFINITY(same as--enable-platform-node-affinity)SKAFFOLD_FILENAME(same as--filename)SKAFFOLD_FORCE(same as--force)SKAFFOLD_HYDRATION_DIR(same as--hydration-dir)SKAFFOLD_INSECURE_REGISTRY(same as--insecure-registry)SKAFFOLD_ITERATIVE_STATUS_CHECK(same as--iterative-status-check)SKAFFOLD_KUBE_CONTEXT(same as--kube-context)SKAFFOLD_KUBECONFIG(same as--kubeconfig)SKAFFOLD_LABEL(same as--label)SKAFFOLD_MODULE(same as--module)SKAFFOLD_MUTE_LOGS(same as--mute-logs)SKAFFOLD_NAMESPACE(same as--namespace)SKAFFOLD_NO_PRUNE(same as--no-prune)SKAFFOLD_NO_PRUNE_CHILDREN(same as--no-prune-children)SKAFFOLD_PLATFORM(same as--platform)SKAFFOLD_PORT_FORWARD(same as--port-forward)SKAFFOLD_PROFILE(same as--profile)SKAFFOLD_PROFILE_AUTO_ACTIVATION(same as--profile-auto-activation)SKAFFOLD_PROPAGATE_PROFILES(same as--propagate-profiles)SKAFFOLD_REMOTE_CACHE_DIR(same as--remote-cache-dir)SKAFFOLD_RESOURCE_SELECTOR_RULES_FILE(same as--resource-selector-rules-file)SKAFFOLD_RPC_HTTP_PORT(same as--rpc-http-port)SKAFFOLD_RPC_PORT(same as--rpc-port)SKAFFOLD_SKIP_TESTS(same as--skip-tests)SKAFFOLD_STATUS_CHECK(same as--status-check)SKAFFOLD_STATUS_CHECK_SELECTORS(same as--status-check-selectors)SKAFFOLD_SYNC_REMOTE_CACHE(same as--sync-remote-cache)SKAFFOLD_TAG(same as--tag)SKAFFOLD_TAIL(same as--tail)SKAFFOLD_TOLERATE_FAILURES_UNTIL_DEADLINE(same as--tolerate-failures-until-deadline)SKAFFOLD_TOOT(same as--toot)SKAFFOLD_WAIT_FOR_CONNECTION(same as--wait-for-connection)SKAFFOLD_WAIT_FOR_DELETIONS(same as--wait-for-deletions)SKAFFOLD_WAIT_FOR_DELETIONS_DELAY(same as--wait-for-deletions-delay)SKAFFOLD_WAIT_FOR_DELETIONS_MAX(same as--wait-for-deletions-max)
skaffold schema
List JSON schemas used to validate skaffold.yaml configuration
Available Commands:
get Print a given skaffold.yaml's json schema
Use "skaffold schema <command> --help" for more information about a given command.
skaffold schema get
Print a given skaffold.yaml’s json schema
Examples:
# Print the schema in version `skaffold/v1`
skaffold schema get skaffold/v1
Usage:
skaffold schema get [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
skaffold test
Run tests against your built application images
Examples:
# Build the artifacts and collect the tags into a file
skaffold build --file-output=tags.json
# Run test against images previously built by Skaffold into a 'tags.json' file
skaffold test --build-artifacts=tags.json
Options:
--assume-yes=false:
If true, skaffold will skip yes/no confirmation from the user and default to yes
-a, --build-artifacts=:
File containing pre-built images to use instead of rebuilding artifacts. A sample file looks like the following: { "builds":[ { "imageName":"registry/image1", "tag":"registry/image1:tag" },{ "imageName":"registry/image2", "tag":"registry/image2:tag" }] } The build result from a previous 'skaffold build --file-output' run can be used here
-c, --config='':
File for global configurations (defaults to $HOME/.skaffold/config)
-f, --filename='skaffold.yaml':
Path or URL to the Skaffold config file
-i, --images=:
A list of pre-built images to deploy, either tagged images or NAME=TAG pairs
-m, --module=[]:
Filter Skaffold configs to only the provided named modules
-p, --profile=[]:
Activate profiles by name (prefixed with `-` to disable a profile)
--profile-auto-activation=true:
Set to false to disable profile auto activation
--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.
--remote-cache-dir='':
Specify the location of the remote cache (default $HOME/.skaffold/remote-cache)
--rpc-http-port=:
tcp port to expose the Skaffold API over HTTP REST
--rpc-port=:
tcp port to expose the Skaffold API over gRPC
--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.
--wait-for-connection=false:
Blocks ending execution of skaffold until the /v2/events gRPC/HTTP endpoint is hit
Usage:
skaffold test [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ASSUME_YES(same as--assume-yes)SKAFFOLD_BUILD_ARTIFACTS(same as--build-artifacts)SKAFFOLD_CONFIG(same as--config)SKAFFOLD_FILENAME(same as--filename)SKAFFOLD_IMAGES(same as--images)SKAFFOLD_MODULE(same as--module)SKAFFOLD_PROFILE(same as--profile)SKAFFOLD_PROFILE_AUTO_ACTIVATION(same as--profile-auto-activation)SKAFFOLD_PROPAGATE_PROFILES(same as--propagate-profiles)SKAFFOLD_REMOTE_CACHE_DIR(same as--remote-cache-dir)SKAFFOLD_RPC_HTTP_PORT(same as--rpc-http-port)SKAFFOLD_RPC_PORT(same as--rpc-port)SKAFFOLD_SYNC_REMOTE_CACHE(same as--sync-remote-cache)SKAFFOLD_WAIT_FOR_CONNECTION(same as--wait-for-connection)
skaffold verify
Run verification tests against skaffold deployments
Examples:
# Deploy with skaffold and then verify deployments
skaffold deploy -q | skaffold verify
Options:
--assume-yes=false:
If true, skaffold will skip yes/no confirmation from the user and default to yes
-a, --build-artifacts=:
File containing pre-built images to use instead of rebuilding artifacts. A sample file looks like the following: { "builds":[ { "imageName":"registry/image1", "tag":"registry/image1:tag" },{ "imageName":"registry/image2", "tag":"registry/image2:tag" }] } The build result from a previous 'skaffold build --file-output' run can be used here
-d, --default-repo='':
Default repository value (overrides global config)
--docker-network='':
Name of an existing docker network to use when running the verify tests. If not specified, Skaffold will create a new network to use of the form 'skaffold-network-<uuid>'
--env-file='':
File containing env var key-value pairs that will be set in all verify container envs
-f, --filename='skaffold.yaml':
Path or URL to the Skaffold config file
-m, --module=[]:
Filter Skaffold configs to only the provided named modules
-n, --namespace='':
Runs deployments in the specified namespace. When used with 'render' command, renders manifests contain the namespace
--port-forward=off:
Port-forward exposes service ports and container ports within pods and other resources (off, user, services, debug, pods)
-p, --profile=[]:
Activate profiles by name (prefixed with `-` to disable a profile)
--profile-auto-activation=true:
Set to false to disable profile auto activation
--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.
--remote-cache-dir='':
Specify the location of the remote cache (default $HOME/.skaffold/remote-cache)
--rpc-http-port=:
tcp port to expose the Skaffold API over HTTP REST
--rpc-port=:
tcp port to expose the Skaffold API over gRPC
--status-check=:
Wait for deployed resources to stabilize
--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.
Usage:
skaffold verify [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_ASSUME_YES(same as--assume-yes)SKAFFOLD_BUILD_ARTIFACTS(same as--build-artifacts)SKAFFOLD_DEFAULT_REPO(same as--default-repo)SKAFFOLD_DOCKER_NETWORK(same as--docker-network)SKAFFOLD_ENV_FILE(same as--env-file)SKAFFOLD_FILENAME(same as--filename)SKAFFOLD_MODULE(same as--module)SKAFFOLD_NAMESPACE(same as--namespace)SKAFFOLD_PORT_FORWARD(same as--port-forward)SKAFFOLD_PROFILE(same as--profile)SKAFFOLD_PROFILE_AUTO_ACTIVATION(same as--profile-auto-activation)SKAFFOLD_PROPAGATE_PROFILES(same as--propagate-profiles)SKAFFOLD_REMOTE_CACHE_DIR(same as--remote-cache-dir)SKAFFOLD_RPC_HTTP_PORT(same as--rpc-http-port)SKAFFOLD_RPC_PORT(same as--rpc-port)SKAFFOLD_STATUS_CHECK(same as--status-check)SKAFFOLD_SYNC_REMOTE_CACHE(same as--sync-remote-cache)
skaffold version
Print the version information
Options:
-o, --output={{.Version}}
: Format output with go-template. For full struct documentation, see https://godoc.org/github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/version#Info
Usage:
skaffold version [options]
Use "skaffold options" for a list of global command-line options (applies to all commands).
Env vars:
SKAFFOLD_OUTPUT(same as--output)
Last modified May 2, 2025: chore: 2.16 release (#9807) (7912f7ef)