Getting Started With Your Project

Skaffold requires a skaffold.yaml, but - for supported projects - Skaffold can generate a simple config for you that you can get started with. To configure Skaffold for your application you can run [skaffold init][init].

Running [skaffold init][init] at the root of your project directory will walk you through a wizard and create a skaffold.yaml that defines how your project is built and deployed.

[init]: {{<relref "docs/pipeline-stages/init" >}}

skaffold init

What's next

You can further set up [File Sync]({{<relref "/docs/pipeline-stages/filesync" >}}) for source files that do not need a rebuild in [dev mode]({{<relref "/docs/workflows/dev">}}).

Skaffold automatically forwards Kubernetes Services in [dev mode]({{<relref "/docs/workflows/dev">}}) if you run it with --port-forward. If your project contains resources other than services, you can set-up [port-forwarding]({{<relref "/docs/pipeline-stages/port-forwarding" >}}) to port-forward these resources in [dev]({{<relref "docs/workflows/dev" >}}) or [debug]({{<relref "/docs/workflows/debug" >}}) mode.

For more understanding on how init works, see [skaffold init]({{<relref "/docs/pipeline-stages/init" >}}).