devspace Documentation

devspace use context                  # to select the right k8s cluster
devspace use namespace my-namespace   # will be automatically created during deployment

devspace add plugin https://github.com/loft-sh/loft-devspace-plugin

devspace login https://your-loft-instance.tld

devspace create space my-app

File: docs/pages/_partials/kubectl-kustomize.mdx Copy Chapter

The kustomize option expects a boolean stating if DevSpace should deploy using kustomize (or alternatively: kubectl apply -k when kustomize is not installed).

:::warning
If you set kustomize: true, all of your manifests must be paths to Kustomizations. If you want to deploy some plain manifests and some Kustomizations, create multiple deployments for each of them.
:::

Default Value for `kustomize`

kustomize: false

Example: Kustomize

deployments:
  backend:
    kubectl:
      kustomize: true
      manifests:
      - kustomization1/
      - glob/path/to/more/kustomizations/

File: docs/pages/_partials/kubectl-options-applyArgs.mdx Copy Chapter

The applyArgs option expects an array of strings stating additional arguments (and flags) that should be used when calling kubectl apply.

:::info Apply for Kustomize Deployments
Even if you set kustomize: true, DevSpace only renders the manifest templates using kustomize but the actual deployment will be executed using kubectl apply.
:::

Example: Custom Kubectl Args & Flags

deployments:
  backend:
    kubectl:
      manifests:
      - backend/
      applyArgs:
      - "--timeout"
      - "10s"
      - "--grace-period"
      - "30"

Deploying the above example would roughly be equivalent to this command:

kubectl apply --timeout=10s --grace-period=30 -f backend/

File: docs/pages/_partials/kubectl-options-binaryPath.mdx Copy Chapter

The kubectlBinaryPath is optional expects a path to the kubectl binary. By default, DevSpace will use the kustomize located on your $PATH. Use this to specify a location for kubectl if it is not on your $PATH and you do not want DevSpace to download the latest version.

:::warning
Setting kubectlBinaryPath makes it much harder to share your devspace.yaml with other team mates. It is recommended to add kubectl to your $PATH environment variable instead.
:::

Example: Setting Path To Kubectl Binary

deployments:
  backend:
    kubectl:
      kubectlBinaryPath: /path/to/kubectl
      manifests:
      - backend/

Explanation:
Deploying the above example would roughly be equivalent to this command:

/path/to/kubectl apply -f backend/

File: docs/pages/_partials/kubectl-updateImageTags.mdx Copy Chapter

If the updateImageTags field is set to true for a deployment, DevSpace will replace/update all image tags before deploying the project.

When enabled, DevSpace searches all your manifests for images that are defined in the images section of the devspace.yaml. If DevSpace finds an image, it replaces or appends the image tag with the tag it created during the image building process. Image tag replacement makes sure that your application will always be started with the most up-to-date image that DevSpace has built for you.

Example: Enable Tag Updates

deployments:
  backend:
    updateImageTags: true
    kubectl:
      manifests:
      - backend/

:::info In-Memory Tag Replacement
Tag replacement takes place in-memory and is not writing anything to the filesystem, i.e. it will never change any of your configuration files.
:::

File: docs/pages/_partials/kustomize-options-kustomizeArgs.mdx Copy Chapter

The kustomizeArgs option expects an array of strings stating additional arguments (and flags) that should be used when calling kustomize build.

Example: Custom Kustomize Args & Flags

deployments:
- name: backend
  kubectl:
    manifests:
    - backend/
    kustomize: true
    kustomizeArgs:
    - "--timeout"
    - "10s"
    - "--grace-period"
    - "30"

Deploying the above example would roughly be equivalent to this command:

kustomize build --timeout=10s --grace-period=30 -f backend/

Note: Directly copying the example shown above would result in your deploy failing (it would result in Error: unknown flag: --timeout).

File: docs/pages/_partials/note-create-space.mdx Copy Chapter

:::note Kube-Context
DevSpace automatically sets up a kube-context for this Space, so you can also access your namespace using kubectl, helm or any other Kubernetes tool. Try it:

kubectl get pods

:::

File: docs/pages/_partials/note-general-purpose-command.mdx Copy Chapter

:::note
This command is a general purpose command which also works for any pod/container in Kubernetes even if you are not within a DevSpace project.
:::

File: docs/pages/_partials/profiles-apply-multiple.mdx Copy Chapter

:::tip Apply Multiple Profiles with Flags

It is possible to apply multiple profiles in a single command with the --profile flag. This flag can take one or multiple profiles that will be applied in the order that they are specified.

Example:

# Apply profile1, profile2 and profile3 in this order
devspace print --profile profile1 --profile profile2 --profile profile3

:::

File: docs/pages/_partials/selector-image-selector.mdx Copy Chapter

The imageSelector option expects a string that specifies an image (e.g. my-registry.com/lib/my-image:tag) to select a target pod and container with. The newest running pod that has a container which matches this image will be selected by DevSpace.

In addition, you can also reference images from the images section in the imageSelector with:

• If the image in imageSelector matches a images.*.image, DevSpace will automatically append the latest built tag during runtime to the imageSelector.
• You can also let DevSpace resolve the target image and tag by using runtime variables ${runtime.images.IMAGE_NAME}, ${runtime.images.IMAGE_NAME.image} or ${runtime.images.IMAGE_NAME.tag}

For example:

images: 
  app: 
    image: my-registry.com/lib/my-image
dev:
  ...
  # DevSpace will search for the newest pod with a container that
  # uses my-registry.com/lib/other-image:latest
  - imageSelector: my-registry.com/lib/other-image:latest
  # DevSpace will search for the newest pod with a container that
  # uses my-registry.com/lib/my-image:xxxxx (latest built tag by DevSpace)
  - imageSelector: my-registry.com/lib/my-image
  # DevSpace will search for the newest pod with a container that
  # uses my-registry.com/lib/my-image:xxxxx (latest built tag by DevSpace)
  - imageSelector: ${runtime.images.app}
  # DevSpace will search for the newest pod with a container that
  # uses my-registry.com/lib/my-image:custom-tag
  - imageSelector: ${runtime.images.app.image}:custom-tag
  # DevSpace will search for the newest pod with a container that
  # uses my-registry.com/lib/my-image:xxxxx (latest built tag by DevSpace)
  - imageSelector: ${runtime.images.app.image}:${runtime.images.app.tag}
  # DevSpace will search for the newest pod with a container that
  # uses the image of app of dependency dep1 with the latest built tag by DevSpace
  - imageSelector: ${runtime.dependencies.dep1.images.app.image}:${runtime.dependencies.dep1.images.app.tag}

File: docs/pages/_partials/selector-label-selector.mdx Copy Chapter

The labelSelector option expects a key-value map of strings with Kubernetes labels. This can be used to select the correct target pod with labels instead of the image name like imageSelector or imageName. If the pod you want to select has multiple containers, make sure to use containerName as well.

File: docs/pages/_partials/start-app.mdx Copy Chapter

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs
defaultValue="javascript"
groupId="language"
values={[
{ label: 'Node.js', value: 'javascript', },
{ label: 'Python', value: 'python', },
{ label: 'Java', value: 'java', },
{ label: 'Ruby', value: 'ruby', },
{ label: 'Golang', value: 'golang', },
{ label: 'PHP', value: 'php', },
{ label: 'ASP.NET', value: 'dotnet', },
{ label: 'Your Own Project', value: 'custom', },
]
}>

npm start  
# or: npm run dev
# or: yarn start

python main.py

bundle exec rails server -p 3000 -b 0.0.0.0

go run main.go

./build.sh run

# Your application may already be running
# Try to open the browser on localhost to access it

# You can also run other commands now:
php ...
composer ...
ps aux

dotnet run

# Whatever command is needed to start your application

File: docs/pages/_partials/tip-print-config.mdx Copy Chapter

The following command is useful to verify that the profile modifies the config as intended:

devspace print -p profile-1 -p profile-2

The above command would print the config after applying all profile patches and replace statements from profile-1 first and then profile-2.

File: docs/pages/_partials/tip-use-namespace.mdx Copy Chapter

:::tip Kube-Context Namespace
Running the command above will change the default namespace of your kube-context, i.e. instead of using the default namespace, kubectl and other tools will now use a different namespace when working with this kube-context. That also means, you will not always need to use the --namespace / -n flag.
:::

File: docs/pages/_partials/vars-default.mdx Copy Chapter

The default option expects a string, integer or boolean defining the default value for the variable. You can also use other variables in a default value, with one of the following conditions being true:

• The used variable is defined before the variable that wants to use it
• The used variable is a predefined variable

:::note Type Casting
If a default value is specified, DevSpace will assume the type of the default value as the type for the variable, i.e. when default: "123" is defined and a value of 123 (int) is provided it would be casted to "123" (string). To explicitly use the value of a variable as a string within devspace.yaml, use $!{VAR_NAME} instead of ${VAR_NAME}.
:::

Example:

images:
  default:
    image: ${IMAGE}
vars:
  - name: IMAGE_REPOSITORY
    default: myrepository
    source: none
  - name: IMAGE_NAME
    default: devspace
    source: none
  - name: IMAGE
    default: ${IMAGE_REPOSITORY}/${IMAGE_NAME}
    source: none
  - name: NAMESPACE
    default: ${devspace.namespace}
    source: none

File: docs/pages/_partials/vars-force-string.mdx Copy Chapter

:::note Variable Type
By default, the type (string, int, bool) of variable will be determined by the type of its default value (if defined) or automatically detected if no default value is defined. To explicitly use the value of a variable as a string, use $!{VAR_NAME} instead of ${VAR_NAME}.
:::

File: docs/pages/_partials/vars-name.mdx Copy Chapter

The name option expects a string stating the name of the config variable that will be used to reference it within the remainder of the configuration.

:::info Must be unique
The name of a config variable must be unique and is mandatory when defining a config variable.
:::

File: docs/pages/_partials/warning-build-tool-priority.mdx Copy Chapter

:::warning Build Tool Priority
If you specify multiple build tools, DevSpace will try to use them in the following order:

1. disabled
2. custom
3. docker (uses kaniko as fallback if Docker host not reachable)
4. kaniko
   :::

File: docs/pages/_partials/warning-multiple-dev.mdx Copy Chapter

:::warning
Running devspace dev multiple times in parallel for the same project does not work and returns a fatal error because multiple instances of port forwarding and file sync will disturb each other. However, running devspace dev for several different projects (i.e. 2 different devspace.yaml files with different name) works seamlessly.
:::

File: docs/pages/_partials/workflow-build-images.mdx Copy Chapter

DevSpace triggers the image building process for the images specified in the images section of the devspace.yaml.

File: docs/pages/_partials/workflow-deploy-dependencies.mdx Copy Chapter

DevSpace loads the dependencies section from the devspace.yaml and creates a dependency tree. The current project will represent the root of this tree. Based on this dependency tree, DevSpace will start from the leaves and run these steps for each dependency:

• Build images of the dependency as configured in the images section of the dependency's devspace.yaml (unless skipBuild: true)
• Deploy the dependency as configured in the deployments section of the dependency's devspace.yaml

:::note What are Dendencies?
Dependencies allow you to deploy microservices, that the project you are currently deploying relies on. Dependencies can be located in a subpath of your project or they can be automatically loaded from a different git repository.
:::

File: docs/pages/_partials/workflow-deploy-project.mdx Copy Chapter

DevSpace iterates over every item in the deployments array defined in the devspace.yaml and deploys each of the deployments using the respective deployment tool:

• kubectl deployments will be deployed with kubectl (optionally using kustomize if kustomize: true)
• helm deployments will be deployed with the helm client that comes in-built with DevSpace

:::info kubectl Required
Deployments with kubectl require kubectl to be installed.
:::

File: docs/pages/_partials/workflow-open-links.mdx Copy Chapter

1. DevSpace starts to periodically send HTTP GET requests to the URLs provideded via dev.*.open[*].url.
2. As soon as the first HTTP response has a status code which is neither 502 (Bad Gateway) nor 503 (Service Unavailable), DevSpace assumes that the application is now started, stops sending any further requests and opens the provided URL in the browser.
3. If the URL is still returning status code 502 or 503 after 4min, DevSpace will stop trying to open it. To not disturb the log streaming or the interactive terminal session, DevSpace will not show an error when hitting the 4min timeout.

File: docs/pages/_partials/workflow-replace-tags.mdx Copy Chapter

After finishing the image building process, DevSpace searches your deployments for references to the images that are specified in the images section of the devspace.yaml. If DevSpace finds that an image is used by one of your deployments and the deployment does not explicitly define a tag for the image, DevSpace will append the tag that has been auto-generated as part of the automated image tagging during the image building process.

:::warning Prevent Hard-Coded Tags
To use automated tag replacement, make sure you do not specify image tags in the deployment configuration.
:::

Replacing or appending tags to images that are used in your deployments makes sure that your deployments are always started using the most recently pushed image tag. This automated process saves a lot of time compared to manually replacing image tags each time before you deploy something.

DevSpace will replace the following things:

• registry.url/repo/name that corresponds to a images.*.image, will be rewritten to registry.url/repo/name:generated_tag
• ${runtime.images.image-key.image} that corresponds to a images.* key, will be rewritten to registry.url/repo/name. You can also use dependency images here with ${runtime.dependencies.dep1.images.dep-image.image}
• ${runtime.images.image-key.tag} that corresponds to a images.* key, will be rewritten to generated_tag. You can also use dependency images here with ${runtime.dependencies.dep1.images.dep-image.tag}

File: docs/pages/cli/devspace_add.md Copy Chapter

title: "devspace add --help" sidebar_label: devspace add Copy Chapter

Adds something to devspace.yaml

Synopsis Copy Chapter

#######################################################
#################### devspace add #####################
#######################################################
Adds config sections to devspace.yaml

Flags Copy Chapter

-h, --help   help for add

Global & Inherited Flags Copy Chapter

--debug                        Prints the stack trace if an error occurs
      --disable-profile-activation   If true will ignore all profile activations
      --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
      --kube-context string          The kubernetes context to use
      --kubeconfig string            The kubeconfig path to use
  -n, --namespace string             The kubernetes namespace to use
      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
      --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
  -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
      --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
  -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
      --var strings                  Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

File: docs/pages/cli/devspace_add_plugin.md Copy Chapter

title: "devspace add plugin --help" sidebar_label: devspace add plugin Copy Chapter

Adds a plugin to devspace

Synopsis Copy Chapter

devspace add plugin [flags]

#######################################################
############### devspace add plugin ###################
#######################################################
Adds a new plugin to devspace

devspace add plugin https://github.com/my-plugin/plugin
#######################################################

Flags Copy Chapter

-h, --help             help for plugin
      --version string   The git tag to use

Global & Inherited Flags Copy Chapter

--debug                        Prints the stack trace if an error occurs
      --disable-profile-activation   If true will ignore all profile activations
      --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
      --kube-context string          The kubernetes context to use
      --kubeconfig string            The kubeconfig path to use
  -n, --namespace string             The kubernetes namespace to use
      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
      --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
  -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
      --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
  -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
      --var strings                  Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

File: docs/pages/cli/devspace_analyze.md Copy Chapter

title: "devspace analyze --help" sidebar_label: devspace analyze Copy Chapter

Analyzes a kubernetes namespace and checks for potential problems

Synopsis Copy Chapter

devspace analyze [flags]

#######################################################
################## devspace analyze ###################
#######################################################
Analyze checks a namespaces events, replicasets, services
and pods for potential problems

Example:
devspace analyze
devspace analyze --namespace=mynamespace
#######################################################

Flags Copy Chapter

-h, --help                  help for analyze
      --ignore-pod-restarts   If true, analyze will ignore the restart events of running pods
      --patient               If true, analyze will ignore failing pods and events until every deployment, statefulset, replicaset and pods are ready or the timeout is reached
      --timeout int           Timeout until analyze should stop waiting (default 120)
      --wait                  Wait for pods to get ready if they are just starting (default true)

Global & Inherited Flags Copy Chapter

--debug                        Prints the stack trace if an error occurs
      --disable-profile-activation   If true will ignore all profile activations
      --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
      --kube-context string          The kubernetes context to use
      --kubeconfig string            The kubeconfig path to use
  -n, --namespace string             The kubernetes namespace to use
      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
      --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
  -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
      --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
  -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
      --var strings                  Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

File: docs/pages/cli/devspace_attach.md Copy Chapter

title: "devspace attach --help" sidebar_label: devspace attach Copy Chapter

Attaches to a container

Synopsis Copy Chapter

devspace attach [flags]

#######################################################
################# devspace attach #####################
#######################################################
Attaches to a running container

devspace attach
devspace attach --pick # Select pod to enter
devspace attach -c my-container
devspace attach -n my-namespace
#######################################################

Flags Copy Chapter

-c, --container string        Container name within pod where to execute command
  -h, --help                    help for attach
      --image-selector string   The image to search a pod for (e.g. nginx, nginx:latest, ${runtime.images.app}, nginx:${runtime.images.app.tag})
  -l, --label-selector string   Comma separated key=value selector list (e.g. release=test)
      --pick                    Select a pod (default true)
      --pod string              Pod to open a shell to

Global & Inherited Flags Copy Chapter

--debug                        Prints the stack trace if an error occurs
      --disable-profile-activation   If true will ignore all profile activations
      --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
      --kube-context string          The kubernetes context to use
      --kubeconfig string            The kubeconfig path to use
  -n, --namespace string             The kubernetes namespace to use
      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
      --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
  -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
      --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
  -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
      --var strings                  Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

File: docs/pages/cli/devspace_build.md Copy Chapter

title: "devspace build --help" sidebar_label: devspace build Copy Chapter

Builds all defined images and pushes them

Synopsis Copy Chapter

devspace build [flags]

#######################################################
################## devspace build #####################
#######################################################
Builds all defined images and pushes them
#######################################################

Flags Copy Chapter

--build-sequential            Builds the images one after another instead of in parallel
      --dependency strings          Deploys only the specified named dependencies
  -b, --force-build                 Forces to build every image (default true)
  -d, --force-deploy                Forces to deploy every deployment
      --force-purge                 Forces to purge every deployment even though it might be in use by another DevSpace project
  -h, --help                        help for build
      --max-concurrent-builds int   The maximum number of image builds built in parallel (0 for infinite)
      --pipeline string             The pipeline to execute (default "build")
      --render                      If true will render manifests and print them instead of actually deploying them
      --sequential-dependencies     If set set true dependencies will run sequentially
      --show-ui                     Shows the ui server
      --skip-build                  Skips building of images
      --skip-dependency strings     Skips the following dependencies for deployment
      --skip-deploy                 If enabled will skip deploying
      --skip-push                   Skips image pushing, useful for minikube deployment
      --skip-push-local-kube        Skips image pushing, if a local kubernetes environment is detected (default true)
  -t, --tag strings                 Use the given tag for all built images

Global & Inherited Flags Copy Chapter

--debug                        Prints the stack trace if an error occurs
      --disable-profile-activation   If true will ignore all profile activations
      --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
      --kube-context string          The kubernetes context to use
      --kubeconfig string            The kubeconfig path to use
  -n, --namespace string             The kubernetes namespace to use
      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
      --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
  -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
      --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
  -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
      --var strings                  Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

File: docs/pages/cli/devspace_cleanup.md Copy Chapter

title: "devspace cleanup --help" sidebar_label: devspace cleanup Copy Chapter

Cleans up resources

Synopsis Copy Chapter

#######################################################
################## devspace cleanup ###################
#######################################################

Flags Copy Chapter

-h, --help   help for cleanup

Global & Inherited Flags Copy Chapter

--debug                        Prints the stack trace if an error occurs
      --disable-profile-activation   If true will ignore all profile activations
      --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
      --kube-context string          The kubernetes context to use
      --kubeconfig string            The kubeconfig path to use
  -n, --namespace string             The kubernetes namespace to use
      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
      --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
  -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
      --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
  -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
      --var strings                  Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

File: docs/pages/cli/devspace_cleanup_images.md Copy Chapter

title: "devspace cleanup images --help" sidebar_label: devspace cleanup images Copy Chapter

Deletes all locally created images from docker

Synopsis Copy Chapter

devspace cleanup images [flags]

#######################################################
############# devspace cleanup images #################
#######################################################
Deletes all locally created docker images from docker
#######################################################

Flags Copy Chapter

-h, --help   help for images

Global & Inherited Flags Copy Chapter

--debug                        Prints the stack trace if an error occurs
      --disable-profile-activation   If true will ignore all profile activations
      --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
      --kube-context string          The kubernetes context to use
      --kubeconfig string            The kubeconfig path to use
  -n, --namespace string             The kubernetes namespace to use
      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
      --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
  -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
      --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
  -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
      --var strings                  Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

File: docs/pages/cli/devspace_cleanup_local-registry.md Copy Chapter

title: "devspace cleanup local-registry --help" sidebar_label: devspace cleanup local-registry Copy Chapter

Deletes the local image registry

Synopsis Copy Chapter

devspace cleanup local-registry [flags]

#######################################################
######### devspace cleanup local-registry #############
#######################################################
Deletes the local image registry
#######################################################

Flags Copy Chapter

-h, --help   help for local-registry

Global & Inherited Flags Copy Chapter

--debug                        Prints the stack trace if an error occurs
      --disable-profile-activation   If true will ignore all profile activations
      --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
      --kube-context string          The kubernetes context to use
      --kubeconfig string            The kubeconfig path to use
  -n, --namespace string             The kubernetes namespace to use
      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
      --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
  -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
      --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
  -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
      --var strings                  Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

File: docs/pages/cli/devspace_completion.md Copy Chapter

title: "devspace completion --help" sidebar_label: devspace completion Copy Chapter

Outputs shell completion for the given shell (bash or zsh)

Synopsis Copy Chapter

```

devspace completion SHELL [flags]

Outputs shell completion for the given shell (bash or zsh)

This depends on the bash-completion binary.  Example installation instructions:
OS X:
	$ brew install bash-completion
	$ source $(brew --prefix)/etc/bash_completion
	$ devspace completion bash > ~/.devspace-completion  # for bash users
	$ devspace completion fish > ~/.devspace-completion  # for fish users
	$ devspace completion zsh > ~/.devspace-completion   # for zsh users
	$ source ~/.devspace-completion
Ubuntu:
	$ apt-get install bash-completion
	$ source /etc/bash-completion
	$ source <(devspace completion bash) # for bash users
	$ devspace completion fish | source # for fish users
	$ source <(devspace completion zsh)  # for zsh users

Additionally, you may want to output the completion to a file and source in your .bashrc

## Flags

-h, --help help for completion

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_deploy.md

---
title: "devspace deploy --help"
sidebar_label: devspace deploy
---


Deploys the project

## Synopsis

devspace deploy [flags]

#######################################################
################## devspace deploy ####################
#######################################################
Deploys the current project to a Space or namespace:

devspace deploy
devspace deploy -n some-namespace
devspace deploy --kube-context=deploy-context
#######################################################

## Flags

--build-sequential            Builds the images one after another instead of in parallel
  --dependency strings          Deploys only the specified named dependencies

-b, --force-build Forces to build every image
-d, --force-deploy Forces to deploy every deployment
--force-purge Forces to purge every deployment even though it might be in use by another DevSpace project
-h, --help help for deploy
--max-concurrent-builds int The maximum number of image builds built in parallel (0 for infinite)
--pipeline string The pipeline to execute (default "deploy")
--render If true will render manifests and print them instead of actually deploying them
--sequential-dependencies If set set true dependencies will run sequentially
--show-ui Shows the ui server
--skip-build Skips building of images
--skip-dependency strings Skips the following dependencies for deployment
--skip-deploy If enabled will skip deploying
--skip-push Skips image pushing, useful for minikube deployment
--skip-push-local-kube Skips image pushing, if a local kubernetes environment is detected (default true)
-t, --tag strings Use the given tag for all built images

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_dev.md

---
title: "devspace dev --help"
sidebar_label: devspace dev
---


Starts the development mode

## Synopsis

devspace dev [flags]

#######################################################
################### devspace dev ######################
#######################################################
Starts your project in development mode
#######################################################

## Flags

--build-sequential            Builds the images one after another instead of in parallel
  --dependency strings          Deploys only the specified named dependencies

-b, --force-build Forces to build every image
-d, --force-deploy Forces to deploy every deployment
--force-purge Forces to purge every deployment even though it might be in use by another DevSpace project
-h, --help help for dev
--max-concurrent-builds int The maximum number of image builds built in parallel (0 for infinite)
--pipeline string The pipeline to execute (default "dev")
--render If true will render manifests and print them instead of actually deploying them
--sequential-dependencies If set set true dependencies will run sequentially
--show-ui Shows the ui server
--skip-build Skips building of images
--skip-dependency strings Skips the following dependencies for deployment
--skip-deploy If enabled will skip deploying
--skip-push Skips image pushing, useful for minikube deployment
--skip-push-local-kube Skips image pushing, if a local kubernetes environment is detected (default true)
-t, --tag strings Use the given tag for all built images

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_enter.md

---
title: "devspace enter --help"
sidebar_label: devspace enter
---


Open a shell to a container

## Synopsis

devspace enter [flags]

#######################################################
################## devspace enter #####################
#######################################################
Execute a command or start a new terminal in your
devspace:

devspace enter
devspace enter --pick # Select pod to enter
devspace enter bash
devspace enter -c my-container
devspace enter bash -n my-namespace
devspace enter bash -l release=test
devspace enter bash --image-selector nginx:latest
devspace enter bash --image-selector "${runtime.images.app.image}:${runtime.images.app.tag}"
#######################################################

## Flags

-c, --container string Container name within pod where to execute command
-h, --help help for enter
--image-selector string The image to search a pod for (e.g. nginx, nginx:latest, ${runtime.images.app}, nginx:${runtime.images.app.tag})
-l, --label-selector string Comma separated key=value selector list (e.g. release=test)
--pick Select a pod / container if multiple are found (default true)
--pod string Pod to open a shell to
--reconnect Will reconnect the terminal if an unexpected return code is encountered
--screen Use a screen session to connect
--screen-session string The screen session to create or connect to (default "enter")
--tty If to use a tty to start the command (default true)
--wait Wait for the pod(s) to start if they are not running
--workdir string The working directory where to open the terminal or execute the command

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_init.md

---
title: "devspace init --help"
sidebar_label: devspace init
---


Initializes DevSpace in the current folder

## Synopsis

devspace init [flags]

#######################################################
#################### devspace init ####################
#######################################################
Initializes a new devspace project within the current
folder. Creates a devspace.yaml as a starting point.
#######################################################

## Flags

--context string      Context path to use for intialization
  --dockerfile string   Dockerfile to use for initialization (default "./Dockerfile")

-h, --help help for init
--provider string The cloud provider to use
-r, --reconfigure Change existing configuration

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_list.md

---
title: "devspace list --help"
sidebar_label: devspace list
---


Lists configuration

## Synopsis

#######################################################
#################### devspace list ####################
#######################################################

## Flags

-h, --help help for list

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_list_commands.md

---
title: "devspace list commands --help"
sidebar_label: devspace list commands
---


Lists all custom DevSpace commands

## Synopsis

devspace list commands [flags]

#######################################################
############## devspace list commands #################
#######################################################
Lists all DevSpace custom commands defined in the
devspace.yaml
#######################################################

## Flags

-h, --help help for commands

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_list_contexts.md

---
title: "devspace list contexts --help"
sidebar_label: devspace list contexts
---


Lists all kube contexts

## Synopsis

devspace list contexts [flags]

#######################################################
############## devspace list contexts #################
#######################################################
Lists all available kube contexts

Example:
devspace list contexts
#######################################################

## Flags

-h, --help help for contexts

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_list_deployments.md

---
title: "devspace list deployments --help"
sidebar_label: devspace list deployments
---


Lists and shows the status of all deployments

## Synopsis

devspace list deployments [flags]

#######################################################
############# devspace list deployments ###############
#######################################################
Lists the status of all deployments
#######################################################

## Flags

-h, --help help for deployments

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_list_namespaces.md

---
title: "devspace list namespaces --help"
sidebar_label: devspace list namespaces
---


Lists all namespaces in the current context

## Synopsis

devspace list namespaces [flags]

#######################################################
############ devspace list namespaces #################
#######################################################
Lists all namespaces in the selected kube context
#######################################################

## Flags

-h, --help help for namespaces

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_list_plugins.md

---
title: "devspace list plugins --help"
sidebar_label: devspace list plugins
---


Lists all installed devspace plugins

## Synopsis

devspace list plugins [flags]

#######################################################
############# devspace list plugins ##################
#######################################################
Lists all installed plugins

devspace list plugins
#######################################################

## Flags

-h, --help help for plugins

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_list_ports.md

---
title: "devspace list ports --help"
sidebar_label: devspace list ports
---


Lists port forwarding configurations

## Synopsis

devspace list ports [flags]

#######################################################
############### devspace list ports ###################
#######################################################
Lists the port forwarding configurations
#######################################################

## Flags

-h, --help help for ports
-o, --output string The output format of the command. Can be either empty or json

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_list_profiles.md

---
title: "devspace list profiles --help"
sidebar_label: devspace list profiles
---


Lists all DevSpace profiles

## Synopsis

devspace list profiles [flags]

#######################################################
############## devspace list profiles #################
#######################################################
Lists all DevSpace configurations for this project
#######################################################

## Flags

-h, --help help for profiles

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_list_sync.md

---
title: "devspace list sync --help"
sidebar_label: devspace list sync
---


Lists sync configuration

## Synopsis

devspace list sync [flags]

#######################################################
################# devspace list sync ##################
#######################################################
Lists the sync configuration
#######################################################

## Flags

-h, --help help for sync

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_list_vars.md

---
title: "devspace list vars --help"
sidebar_label: devspace list vars
---


Lists the vars in the active config

## Synopsis

devspace list vars [flags]

#######################################################
############### devspace list vars ####################
#######################################################
Lists the defined vars in the devspace config with their
values
#######################################################

## Flags

-h, --help help for vars
-o, --output string The output format of the command. Can be either empty, keyvalue or json

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_logs.md

---
title: "devspace logs --help"
sidebar_label: devspace logs
---


Prints the logs of a pod and attaches to it

## Synopsis

devspace logs [flags]

#######################################################
#################### devspace logs ####################
#######################################################
Prints the last log of a pod container and attachs
to it

Example:
devspace logs
devspace logs --namespace=mynamespace
#######################################################

## Flags

-c, --container string Container name within pod where to execute command
-f, --follow Attach to logs afterwards
-h, --help help for logs
--image-selector string The image to search a pod for (e.g. nginx, nginx:latest, ${runtime.images.app}, nginx:${runtime.images.app.tag})
-l, --label-selector string Comma separated key=value selector list (e.g. release=test)
--lines int Max amount of lines to print from the last log (default 200)
--pick Select a pod (default true)
--pod string Pod to print the logs of
--wait Wait for the pod(s) to start if they are not running

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_open.md

---
title: "devspace open --help"
sidebar_label: devspace open
---


Opens the space in the browser

## Synopsis

devspace open [flags]

#######################################################
#################### devspace open ####################
#######################################################
Opens the space domain in the browser

Example:
devspace open
#######################################################

## Flags

-h, --help help for open
--port int The port on the localhost to listen on
--provider string The cloud provider to use

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_print.md

---
title: "devspace print --help"
sidebar_label: devspace print
---


Prints displays the configuration

## Synopsis

devspace print [flags]

#######################################################
################## devspace print #####################
#######################################################
Prints the configuration for the current or given
profile after all patching and variable substitution
#######################################################

## Flags

--dependency string   The dependency to print the config from. Use dot to access nested dependencies (e.g. dep1.dep2)

-h, --help help for print
--skip-info When enabled, only prints the configuration without additional information

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_purge.md

---
title: "devspace purge --help"
sidebar_label: devspace purge
---


Deletes deployed resources

## Synopsis

devspace purge [flags]

#######################################################
################### devspace purge ####################
#######################################################
Deletes the deployed kubernetes resources:

devspace purge
#######################################################

## Flags

--build-sequential            Builds the images one after another instead of in parallel
  --dependency strings          Deploys only the specified named dependencies

-b, --force-build Forces to build every image
-d, --force-deploy Forces to deploy every deployment
--force-purge Forces to purge every deployment even though it might be in use by another DevSpace project
-h, --help help for purge
--max-concurrent-builds int The maximum number of image builds built in parallel (0 for infinite)
--pipeline string The pipeline to execute (default "purge")
--render If true will render manifests and print them instead of actually deploying them
--sequential-dependencies If set set true dependencies will run sequentially
--show-ui Shows the ui server
--skip-build Skips building of images
--skip-dependency strings Skips the following dependencies for deployment
--skip-deploy If enabled will skip deploying
--skip-push Skips image pushing, useful for minikube deployment
--skip-push-local-kube Skips image pushing, if a local kubernetes environment is detected (default true)
-t, --tag strings Use the given tag for all built images

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_remove.md

---
title: "devspace remove --help"
sidebar_label: devspace remove
---


Removes devspace configuration

## Synopsis

#######################################################
################## devspace remove ####################
#######################################################

## Flags

-h, --help help for remove

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_remove_context.md

---
title: "devspace remove context --help"
sidebar_label: devspace remove context
---


Removes a kubectl-context

## Synopsis

devspace remove context [flags]

#######################################################
############# devspace remove context #################
#######################################################
Removes a kubectl-context

Example:
devspace remove context myspace
#######################################################

## Flags

-h, --help help for context

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_remove_plugin.md

---
title: "devspace remove plugin --help"
sidebar_label: devspace remove plugin
---


Removes a devspace plugin

## Synopsis

devspace remove plugin [flags]

#######################################################
############# devspace remove plugin ##################
#######################################################
Removes a plugin

devspace remove plugin my-plugin
#######################################################

## Flags

-h, --help help for plugin

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_render.md

---
title: "devspace render --help"
sidebar_label: devspace render
---


Builds all defined images and shows the yamls that would be deployed

## Synopsis

devspace render [flags]

#######################################################
################## devspace render #####################
#######################################################
Builds all defined images and shows the yamls that would
be deployed via helm and kubectl, but skips actual
deployment.
#######################################################

## Flags

--build-sequential            Builds the images one after another instead of in parallel
  --dependency strings          Deploys only the specified named dependencies

-b, --force-build Forces to build every image
-d, --force-deploy Forces to deploy every deployment
--force-purge Forces to purge every deployment even though it might be in use by another DevSpace project
-h, --help help for render
--max-concurrent-builds int The maximum number of image builds built in parallel (0 for infinite)
--pipeline string The pipeline to execute (default "deploy")
--render If true will render manifests and print them instead of actually deploying them (default true)
--sequential-dependencies If set set true dependencies will run sequentially
--show-ui Shows the ui server
--skip-build Skips building of images
--skip-dependency strings Skips the following dependencies for deployment
--skip-deploy If enabled will skip deploying
--skip-push Skips image pushing, useful for minikube deployment
--skip-push-local-kube Skips image pushing, if a local kubernetes environment is detected (default true)
-t, --tag strings Use the given tag for all built images

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_reset.md

---
title: "devspace reset --help"
sidebar_label: devspace reset
---


Resets an cluster token

## Synopsis

#######################################################
################## devspace reset #####################
#######################################################

## Flags

-h, --help help for reset

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_reset_dependencies.md

---
title: "devspace reset dependencies --help"
sidebar_label: devspace reset dependencies
---


Resets the dependencies cache

## Synopsis

devspace reset dependencies [flags]

#######################################################
############ devspace reset dependencies ##############
#######################################################
Deletes the complete dependency cache

Examples:
devspace reset dependencies
#######################################################

## Flags

-h, --help help for dependencies

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_reset_pods.md

---
title: "devspace reset pods --help"
sidebar_label: devspace reset pods
---


Resets the replaced pods

## Synopsis

devspace reset pods [flags]

#######################################################
############### devspace reset pods ###################
#######################################################
Resets the replaced pods to its original state

Examples:
devspace reset pods
#######################################################

## Flags

--force   If true will force resetting pods even though they might be still used by other DevSpace projects

-h, --help help for pods

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_reset_vars.md

---
title: "devspace reset vars --help"
sidebar_label: devspace reset vars
---


Resets the current config vars

## Synopsis

devspace reset vars [flags]

#######################################################
############### devspace reset vars ###################
#######################################################
Resets the saved variables of the current config

Examples:
devspace reset vars
#######################################################

## Flags

-h, --help help for vars

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_restart.md

---
title: "devspace restart --help"
sidebar_label: devspace restart
---


Restarts containers where the sync restart helper is injected

## Synopsis

devspace restart [flags]

#######################################################
################## devspace restart ###################
#######################################################
Restarts containers where the sync restart helper
is injected:

devspace restart
devspace restart -n my-namespace
#######################################################

## Flags

-c, --container string Container name within pod to restart
-h, --help help for restart
-l, --label-selector string Comma separated key=value selector list (e.g. release=test)
--name string The sync path name to restart
--pick Select a pod (default true)
--pod string Pod to restart

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_run-pipeline.md

---
title: "devspace run-pipeline --help"
sidebar_label: devspace run-pipeline
---


Starts a DevSpace pipeline

## Synopsis

devspace run-pipeline [flags]

#######################################################
############## devspace run-pipeline ##################
#######################################################
Execute a pipeline:
devspace run-pipeline my-pipeline
devspace run-pipeline dev
#######################################################

## Flags

--build-sequential            Builds the images one after another instead of in parallel
  --dependency strings          Deploys only the specified named dependencies

-b, --force-build Forces to build every image
-d, --force-deploy Forces to deploy every deployment
--force-purge Forces to purge every deployment even though it might be in use by another DevSpace project
-h, --help help for run-pipeline
--max-concurrent-builds int The maximum number of image builds built in parallel (0 for infinite)
--pipeline string The pipeline to execute
--render If true will render manifests and print them instead of actually deploying them
--sequential-dependencies If set set true dependencies will run sequentially
--show-ui Shows the ui server
--skip-build Skips building of images
--skip-dependency strings Skips the following dependencies for deployment
--skip-deploy If enabled will skip deploying
--skip-push Skips image pushing, useful for minikube deployment
--skip-push-local-kube Skips image pushing, if a local kubernetes environment is detected (default true)
-t, --tag strings Use the given tag for all built images

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_run.md

---
title: "devspace run --help"
sidebar_label: devspace run
---


Executes a predefined command

## Synopsis

devspace run [flags]

#######################################################
##################### devspace run ####################
#######################################################
Executes a predefined command from the devspace.yaml

Examples:
devspace run mycommand --myarg 123
devspace run mycommand2 1 2 3
devspace --dependency my-dependency run any-command --any-command-flag
#######################################################

## Flags

--dependency string   Run a command from a specific dependency

-h, --help help for run

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_set.md

---
title: "devspace set --help"
sidebar_label: devspace set
---


Sets global configuration changes

## Synopsis

#######################################################
#################### devspace set #####################
#######################################################

## Flags

-h, --help help for set

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_set_var.md

---
title: "devspace set var --help"
sidebar_label: devspace set var
---


Sets a variable

## Synopsis

devspace set var [flags]

#######################################################
################# devspace set var ####################
#######################################################
Sets a specific variable

Examples:
devspace set var key=value
devspace set var key=value key2=value2
#######################################################

## Flags

-h, --help help for var
--overwrite If true will overwrite the variables value even if its set already (default true)

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_sync.md

---
title: "devspace sync --help"
sidebar_label: devspace sync
---


Starts a bi-directional sync between the target container and the local path

## Synopsis

devspace sync [flags]

#############################################################################
################### devspace sync ###########################################
#############################################################################
Starts a bi-directional(default) sync between the target container path
and local path:

devspace sync --path=.:/app # localPath is current dir and remotePath is /app
devspace sync --path=.:/app --image-selector nginx:latest
devspace sync --path=.:/app --exclude=node_modules,test
devspace sync --path=.:/app --pod=my-pod --container=my-container
#############################################################################

## Flags

-c, --container string Container name within pod where to sync to
--download-on-initial-sync DEPRECATED: Downloads all locally non existing remote files in the beginning (default true)
--download-only If set DevSpace will only download files
-e, --exclude strings Exclude directory from sync
-h, --help help for sync
--image-selector string The image to search a pod for (e.g. nginx, nginx:latest, ${runtime.images.app}, nginx:${runtime.images.app.tag})
--initial-sync string The initial sync strategy to use (mirrorLocal, mirrorRemote, preferLocal, preferRemote, preferNewest, keepAll)
-l, --label-selector string Comma separated key=value selector list (e.g. release=test)
--no-watch Synchronizes local and remote and then stops
--path string Path to use (Default is current directory). Example: ./local-path:/remote-path or local-path:.
--pick Select a pod (default true)
--pod string Pod to sync to
--polling If polling should be used to detect file changes in the container
--upload-only If set DevSpace will only upload files
--wait Wait for the pod(s) to start if they are not running (default true)

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_ui.md

---
title: "devspace ui --help"
sidebar_label: devspace ui
---


Opens the localhost UI in the browser

## Synopsis

devspace ui [flags]

#######################################################
##################### devspace ui #####################
#######################################################
Opens the localhost UI in the browser
#######################################################

## Flags

--dev           Ignore errors when downloading UI

-h, --help help for ui
--host string The host to use when opening the ui server (default "localhost")
--port int The port to use when opening the ui server
--server If enabled will force start a server (otherwise an existing UI server is searched)

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_update.md

---
title: "devspace update --help"
sidebar_label: devspace update
---


Updates the current config

## Synopsis

#######################################################
################## devspace update ####################
#######################################################

## Flags

-h, --help help for update

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_update_plugin.md

---
title: "devspace update plugin --help"
sidebar_label: devspace update plugin
---


Updates a devspace plugin

## Synopsis

devspace update plugin [flags]

#######################################################
############# devspace update plugin ##################
#######################################################
Updates a plugin

devspace update plugin my-plugin
#######################################################

## Flags

-h, --help help for plugin
--version string The git tag to use

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_upgrade.md

---
title: "devspace upgrade --help"
sidebar_label: devspace upgrade
---


Upgrades the DevSpace CLI to the newest version

## Synopsis

devspace upgrade [flags]

#######################################################
################## devspace upgrade ###################
#######################################################
Upgrades the DevSpace CLI to the newest version
#######################################################

## Flags

-h, --help help for upgrade
--version string The version to update devspace to. Defaults to the latest stable version available

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_use.md

---
title: "devspace use --help"
sidebar_label: devspace use
---


Uses specific config

## Synopsis

#######################################################
#################### devspace use #####################
#######################################################

## Flags

-h, --help help for use

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_use_context.md

---
title: "devspace use context --help"
sidebar_label: devspace use context
---


Tells DevSpace which kube context to use

## Synopsis

devspace use context [flags]

#######################################################
############### devspace use context ##################
#######################################################
Switches the current kube-context

Example:
devspace use context my-context
#######################################################

## Flags

-h, --help help for context

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_use_namespace.md

---
title: "devspace use namespace --help"
sidebar_label: devspace use namespace
---


Tells DevSpace which namespace to use

## Synopsis

devspace use namespace [flags]

#######################################################
############## devspace use namespace #################
#######################################################
Sets the default namespace to deploy to

Example:
devspace use namespace my-namespace
#######################################################

## Flags

--create   Create the namespace if it doesn't exist

-h, --help help for namespace
--reset Resets the default namespace of the current kube-context

## Global & Inherited Flags

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

---

## File: docs/pages/cli/devspace_version.md

---
title: "devspace version --help"
sidebar_label: devspace version
---

## devspace version

Prints version of devspace

devspace version [flags]

### Options

-h, --help help for version

### Options inherited from parent commands

--debug                        Prints the stack trace if an error occurs
  --disable-profile-activation   If true will ignore all profile activations
  --inactivity-timeout int       Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems
  --kube-context string          The kubernetes context to use
  --kubeconfig string            The kubeconfig path to use

-n, --namespace string The kubernetes namespace to use
--no-colors Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
--override-name string If specified will override the DevSpace project name provided in the devspace.yaml
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
--silent Run in silent mode and prevents any devspace log output except panics & fatals
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)

## Flags
## Global & Inherited Flags

---

## File: docs/pages/configuration/expressions.mdx

---
title: Config Expressions
sidebar_label: $(expressions)
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Config expressions are a powerful feature to load the `devspace.yaml` in a more dynamic way. A config expression works by specifying `$( my bash expression )` instead of a field and the stdout of the bash expression is taken as value for the option or complete section. Config expressions are evaluated after variables and profiles are applied to the config and can change parts of the config.

<Tabs
    defaultValue="file"
    values={[
        { label: 'Load From File', value: 'file', },
        { label: 'If Else', value: 'if', },
        { label: 'Only in dev', value: 'command', },
        { label: 'Generate Section', value: 'generate', },
        { label: 'Return JSON', value: 'json', },
        { label: 'Force String', value: 'forcestring', },
    ]
    }>
<TabItem value="file">

Load a deployment specification from file:
```yaml
deployments: $(cat deployment.yaml)

deployments:
    
  # Inline If-Else
  backend: $( [ ${DEVSPACE_NAMESPACE} == "test" ] && cat deployment.yaml || echo "" )

  # Multi-Line If-Else
  frontend: |-
    $(
      if [ ${DEVSPACE_CONTEXT} == "minikube" ]; then
        cat minikube.yaml
      else
        echo ""
      fi
    )

images:
  deploy:
    build:
      disabled: $( [ $1 == "dev" ] && echo "true" || echo "false" )

dev: $(./my-script.sh ${DEVSPACE_NAMESPACE} ${DEVSPACE_CONTEXT} ${DEVSPACE_PROFILE})

images:
  test:
    image: my-image/image
    build: '$( echo {"disabled": true} )'

deployments:
  backend:
    helm:
      chart: ...
      values:
        labels:
          test: '$!(echo true)'

:::info
Expressions are run in a golang shell that is syntax compatible to a regular POSIX shell and works on all operating systems. Check the github repository for a complete list of available commands
:::

:::info
Variables are resolved before and after applying expressions, which means that you can load a section from file within an expression that contains a variable which will still be resolved afterwards.
:::

Testing Config Expressions Copy Section

The command devspace print can be used to test your config expressions and shows the config after all profiles, variables and expressions were applied.

File: docs/pages/configuration/reference.mdx Copy Chapter

title: Config Reference sidebar_label: Config Reference Copy Chapter

import PartialConfig from "./_partials/v2beta1/reference.mdx"

Every project you want to use with DevSpace needs a devspace.yaml which defines how to build, deploy, debug and develop this project.

The devspace.yaml file supports the following fields:

File: docs/pages/configuration/runtime-variables.mdx Copy Chapter

title: Runtime Variables sidebar_label: ${runtime.variables} Copy Chapter

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Runtime variables are special variables that are only available in certain config areas and are filled during runtime. Those variables are useful to access certain runtime information, such as hook output or image tags.

<Tabs
defaultValue="var1"
values={[
{ label: 'Separate Repo & Tag', value: 'var1', },
{ label: 'Customize Helm Values', value: 'var2', },
{ label: 'Customize Kubernetes Manifests', value: 'var3', },
{ label: 'Dependency', value: 'var4', },
]
}>

images:
  app:
    image: registry.url/repo/image
deployments:
  backend:
    helm:
      chart:
        name: chart-name
        repo: https://my-charts.company.tld/
      values:
        # If registry.url/repo/image was found under images as well, will be
        # rewritten to registry.url/repo/image:generated_tag
        imageWithTag: registry.url/repo/image
        # If registry.url/repo/image was found under images.app as well, will be
        # rewritten to registry.url/repo/image
        imageWithoutTag: ${runtime.images.app.image}
        # If registry.url/repo/image was found under images.app as well, will be
        # rewritten to generated_tag
        onlyTag: ${runtime.images.app.tag}

images:
  app:
    image: myuser/image
hooks:
  - name: "image-digest"
    events: ["after:build:app"]
    command: |
      # This command prints the image digest
      echo $(docker inspect ${runtime.images.app.image}:${runtime.images.app.tag} --format='{{index .RepoDigests 0}}' | cut -d'@' -f2)
deployments:
  checkout:
    helm:
      chart:
        name: ./kubernetes/helm/app
      values:
        app:
          image:
            digest: ${runtime.hooks.image-digest.stdout}

images:
  your-image:
    image: localhost:5000/my/customalpine
    kaniko:
      insecure: true
      skipPullSecretMount: true

deployments:
  quickstart:
    kubectl:
      inlineManifest: |-
        kind: Deployment
        apiVersion: apps/v1
        metadata:
          name: devspace
        spec:
          replicas: 1
          selector:
            matchLabels:
              app.kubernetes.io/component: default
              app.kubernetes.io/name: devspace-app
          template:
            metadata:
              labels:
                app.kubernetes.io/component: default
                app.kubernetes.io/name: devspace-app
            spec:
              containers:
                - name: default
                  # The correct image tag will be inserted during devspace dev / devspace deploy
                  image: ${runtime.images.your-image}

dependencies:
  dep1:
    source:
      path: dep1
dev:
  my-dev:
    imageSelector: ${runtime.dependencies.dep1.images.image1}
    terminal: {}

Runtime variables can be used in the following DevSpace config sections:

/images/*/build/custom/command
/images/*/build/custom/commands/*/command
/images/*/build/custom/args/**
/images/*/build/custom/appendArgs/**
/deployments/*/helm/values/**
/deployments/*/kubectl/inlineManifest/**
/hooks/*/command
/hooks/*/args/*
/hooks/*/container/imageSelector
/dev/*/imageSelector
/dev/*/replaceImage
/dev/*/devImage
/dev/*/containers/*/replaceImage
/dev/*/containers/*/devImage
/pipelines/*
/pipelines/*/flags/**
/pipelines/*/run
/commands/*
/commands/*/command
/functions/**
/imports/**

:::info
If you try to use a runtime variable in a different config section, DevSpace will print an error and fail.
:::

The following runtime variables exist:

• runtime.images.IMAGE_NAME: Holds the image name (defined at images.*.image) and tag that was built by DevSpace (e.g. my-repo.com/image:latest)
• runtime.images.IMAGE_NAME.tag: Holds the image tag that was built by DevSpace (e.g. asdHTR or latest)
• runtime.images.IMAGE_NAME.image: Holds the image name (defined at images.*.image) that was used for building (e.g. my-repo.com/image)

Accessing runtime variables of dependencies Copy Chapter

You can also access runtime variables of an executed dependency by using runtime.dependencies.DEPENDENCY_NAME....

For example:

dependencies:
  dep1:
    source:
      path: dep1
dev:
  my-dev:
    imageSelector: ${runtime.dependencies.dep1.images.image1}
    terminal: {}

File: docs/pages/configuration/variables.mdx Copy Chapter

title: Config Variables sidebar_label: ${VARIABLES} Copy Chapter

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import ConfigPartial from './_partials/v2beta1/vars.mdx'
import FragmentVarsForceString from '../_partials/vars-force-string.mdx';

DevSpace allows you to make your configuration dynamic by using variables.

While there is no need to explicitly define a config variable, it allows you to customize the behavior of DevSpace when working with the variable. If you do not explicitly define a variable, DevSpace will try to load it from the user's local environment variables.

Built-In Variables Copy Chapter

DevSpace provides a set of built-in variables:

• ${DEVSPACE_CONTEXT} contains the name of the current kube-context (e.g. minikube)
• ${DEVSPACE_EXECUTABLE} contains the path to the devspace binary used
• ${DEVSPACE_GIT_BRANCH} contains the name of the local git branch that the user is currently on
• ${DEVSPACE_GIT_COMMIT} contains the hash of the latest git commit in the current repository
• ${DEVSPACE_KUBECTL_EXECUTABLE} contains the path to the kubectl binary
• ${DEVSPACE_NAME} contains the value of the name field of the current devspace.yaml file
• ${DEVSPACE_NAMESPACE} contains the current namespace
• ${DEVSPACE_PROFILE} contains the profile that is currently active in DevSpace (e.g. the string provided via -p / --profile in a command such as devspace dev -p my-profile)
• ${DEVSPACE_RANDOM} contains a random 6 character long string
• ${DEVSPACE_TIMESTAMP} contains the current UNIX timestamp
• ${DEVSPACE_TMPDIR} contains a path to a temporary folder that DevSpace cleans up after the devspace command terminates
• ${DEVSPACE_USER_HOME} contains the path to the current user's home directory
• ${DEVSPACE_VERSION} contains the version of DevSpace that is currently running

Custom Variables Copy Chapter

DevSpace lets you define custom varables inside devspace.yaml within the vars section.

:::tip Mix & Match Variable Types
You can define several types of variables in the same config file, e.g. one devspace.yaml can contain static variables, env variables and more.
:::

vars:
  MY_VAR: "some value"
  ANOTHER_VAR: "some value"

vars:
  MY_ENV_VAR:
    source: env
    default: my-default

vars:
  VAR_FROM_COMMAND: $(git rev-parse HEAD)
  ANOTHER_VAR_FROMCOMMAND:
    command: git
    args: ["rev-parse", "HEAD"]

images:
  database:
    image: "mysql:${MYSQL_VERSION}"
vars:
  MYSQL_VERSION: 
    question: Which mysql version do you want to use?
    default: "5.7"

images:
  database:
    image: "mysql:${MYSQL_VERSION}"
vars:
  MYSQL_VERSION: 
    question: Which mysql version do you want to use?
    default: "5.7"
    options:
    - "5.5"
    - "5.6"
    - "5.7"

images:
  database:
    image: "mysql:${MYSQL_VERSION}"
vars:
  MYSQL_VERSION: 
    question: Which mysql version do you want to use?
    password: true

images:
  database:
    image: "mysql:${MYSQL_VERSION}"
vars:
  MYSQL_VERSION: 
    question: Which mysql version do you want to use?
    noCache: true

vars:
  DEVSPACE_ENV_FILE: ".env"

DEVSPACE_CONFIG=my-other-devspace.yaml devspace dev

DEVSPACE_FLAGS=-s -n default-namespace
DEVSPACE_DEV_FLAGS=-s --verbose-dependencies

vars:
  DEVSPACE_FLAGS: '-n my-default-namespace'

devspace list vars

devspace reset vars

devspace print

$env:IMAGE_NAME = "some-value"

export IMAGE_NAME="some-value"

export IMAGE_NAME="some-value"