key: download

description: Download is the download limit in kilo bytes per second


key: upload

description: Upload is the upload limit in kilo bytes per second

type: integer


key: BuildKitConfig

description: BuildKitConfig tells the DevSpace CLI to

type: boolean

type: string

type: array

type: object


key: inCluster

description: InCluster if specified, DevSpace will use BuildKit to build the image within the cluster


key: preferMinikube

description: PreferMinikube if false, will not try to use the minikube docker daemon to build the image


key: args

description: Args are additional arguments to call docker buildx build with


key: command

description: Command to override the base command to create a builder and build images. Defaults to ["docker", "buildx"]


key: BuildKitInClusterConfig

description: BuildKitInClusterConfig holds the buildkit builder config


key: name

description:
Name is the name of the builder to use. If omitted, DevSpace will try to create
or reuse a builder in the form devspace-$NAMESPACE


key: namespace

description:
Namespace where to create the builder deployment in. Defaults to the current
active namespace.


key: rootless

description: Rootless if enabled will create a rootless builder deployment.


key: image

description: Image is the docker image to use for the BuildKit deployment


key: nodeSelector

description: NodeSelector is the node selector to use for the BuildKit deployment


key: noCreate

description:
NoCreate. By default, DevSpace will try to create a new builder if it cannot be found.
If this is true, DevSpace will fail if the specified builder cannot be found.


key: noRecreate

description:
NoRecreate. By default, DevSpace will try to recreate the builder if the builder configuration
in the devspace.yaml differs from the actual builder configuration. If this is
true, DevSpace will not try to do that.


key: noLoad

description:
NoLoad if enabled, DevSpace will not try to load the built image into the local docker
daemon if skip push is defined


key: createArgs

description: CreateArgs are additional args to create the builder with.


key: ChartConfig

description: ChartConfig defines the helm chart options

group: repo

group_name: Source: Helm Repository

group: path

group_name: Source: Local Filesystem

group: git

group_name: Source: Git Repository


description: Name is the name of the helm chart to deploy. Can also be a local path or an oci url


key: version

description: Version is the version of the helm chart to deploy


key: repo

description: RepoURL is the url of the repo to deploy the chart from


key: username

description: Username is the username to authenticate to the chart repo. When using an OCI chart, used for registry auth


key: password

description: Password is the password to authenticate to the chart repo, When using an OCI chart, used for registry auth


key: path

description:
Path is the local path where DevSpace can find the artifact.
This option is mutually exclusive with the git option.


key: git

description:
Git is the remote repository to download the artifact from. You can either use
https projects or ssh projects here, but need to make sure git can pull the project.
This option is mutually exclusive with the path option.


key: subPath

description: SubPath is a path within the git repository where the artifact lies in


key: branch

description: Branch is the git branch to pull


key: tag

description: Tag is the tag to pull


key: revision

description: Revision is the git revision to pull


key: cloneArgs

description: CloneArgs are additional arguments that should be supplied to the git CLI


key: disableShallow

description:
DisableShallow can be used to turn off shallow clones as these are the default used
by devspace


key: disablePull

description: DisablePull will disable pulling every time DevSpace is reevaluating this source


key: CommandConfig

description: CommandConfig defines the command specification


key: name

description: Name is the name of a command that is used via `devspace run NAME`


key: section

description: Section can be used to group similar commands together in `devspace list commands`


key: command

description: Command is the command that should be executed. For example: 'echo 123'


key: args

description:
Args are optional and if defined, command is not executed within a shell
and rather directly.


key: appendArgs

description:
AppendArgs will append arguments passed to the DevSpace command automatically to
the specified command.


key: description

description: Description describes what the command is doing and can be seen in `devspace list commands`


key: internal

description: Internal commands are not show in list and are usable through run_command


key: after

description:
After is executed after the command was run. It is executed also when
the command was interrupted which will set the env variable COMMAND_INTERRUPT
to true as well as when the command errored which will set the error string to
COMMAND_ERROR.


key: CustomConfig

description: CustomConfig tells the DevSpace CLI to build with a custom build script


description:
Command to execute to build the image. You can use ${runtime.images.my-image.image} and ${runtime.image.my-image.tag}
to reference the image and tag that should get built.


key: onChange

description: OnChange will determine when the command should be rerun


key: DependencyConfig

description: DependencyConfig defines the devspace dependency

default: deploy

group: execution

group_name: Execution


description: Name is used internally


key: disabled

description: Disabled excludes this dependency from variable resolution and pipeline runs


key: path

description:
Path is the local path where DevSpace can find the artifact.
This option is mutually exclusive with the git option.


key: git

description:
Git is the remote repository to download the artifact from. You can either use
https projects or ssh projects here, but need to make sure git can pull the project.
This option is mutually exclusive with the path option.


key: subPath

description: SubPath is a path within the git repository where the artifact lies in


key: branch

description: Branch is the git branch to pull


key: tag

description: Tag is the tag to pull


key: revision

description: Revision is the git revision to pull


key: cloneArgs

description: CloneArgs are additional arguments that should be supplied to the git CLI


key: disableShallow

description:
DisableShallow can be used to turn off shallow clones as these are the default used
by devspace


key: disablePull

description: DisablePull will disable pulling every time DevSpace is reevaluating this source


key: pipeline

description: Pipeline is the pipeline to deploy by default. Defaults to 'deploy'


key: vars

description: Vars are variables that should be passed to the dependency


key: overwriteVars

description: OverwriteVars specifies if DevSpace should pass the parent variables to the dependency


key: ignoreDependencies

description: IgnoreDependencies defines if dependencies of the dependency should be excluded


key: namespace

description: Namespace specifies the namespace this dependency should be deployed to


key: DeploymentConfig

description: DeploymentConfig defines the configuration how the devspace should be deployed


key: name

description: Name of the deployment


key: helm

description: Helm tells DevSpace to deploy this deployment via helm


key: kubectl

description: Kubectl tells DevSpace to deploy this deployment via kubectl or kustomize


key: updateImageTags

description:
UpdateImageTags lets you define if DevSpace should update the tags of the images defined in the
images section with their most recent built tag.


description: Namespace where to deploy this deployment


key: DevContainer

description: DevContainer holds options for dev services that should get started within a certain container of the selected pod

group: selector

group_name: Selector

group: modifications

group_name: Modifications

group: ports

group_name: Port Forwarding

group: sync

group_name: File Sync

group: workflows

group_name: Foreground Dev Workflows


key: container

description: Container is the container name these services should get started.


key: arch

description:
Target Container architecture to use for the devspacehelper (currently amd64 or arm64). Defaults to amd64, but
devspace tries to find out the architecture by itself by looking at the node this container runs on.


key: devImage

description:
DevImage is the image to use for this container and will replace the existing image
if necessary.


key: command

description: Command can be used to override the entrypoint of the container


key: args

description: Args can be used to override the args of the container


key: workingDir

description: WorkingDir can be used to override the working dir of the container


key: env

description:
Env can be used to add environment variables to the container. DevSpace will
not replace existing environment variables if an environment variable is defined here.


key: resources

description: Resources can be used to override the resource definitions of the container


key: reversePorts

description: ReversePorts are port mappings to make local ports available inside the container


key: sync

description: Sync allows you to sync certain local paths with paths inside the container


key: persistPaths

description: PersistPaths allows you to persist certain paths within this container with a persistent volume claim


key: terminal

description: Terminal allows you to tell DevSpace to open a terminal with screen support to this container


key: logs

description: Logs allows you to tell DevSpace to stream logs from this container to the console


key: attach

description: Attach allows you to tell DevSpace to attach to this container


key: ssh

description: SSH allows you to create an SSH tunnel to this container


key: proxyCommands

description: ProxyCommands allow you to proxy certain local commands to the container


key: restartHelper

description:
RestartHelper holds restart helper specific configuration. The restart helper is used to delay starting of
the container and restarting it and is injected via an annotation in the replaced pod.


key: DevPod

description: DevPod holds configurations for selecting a pod and starting dev services for that pod

group_name: Background Dev Workflows


key: name

description: Name of the dev configuration


key: imageSelector

description: ImageSelector to select a pod


key: labelSelector

description: LabelSelector to select a pod


key: namespace

description: Namespace where to select the pod


key: container

description: Container is the container name these services should get started.


key: arch

description:
Target Container architecture to use for the devspacehelper (currently amd64 or arm64). Defaults to amd64, but
devspace tries to find out the architecture by itself by looking at the node this container runs on.


key: devImage

description:
DevImage is the image to use for this container and will replace the existing image
if necessary.


key: command

description: Command can be used to override the entrypoint of the container


key: args

description: Args can be used to override the args of the container


key: workingDir

description: WorkingDir can be used to override the working dir of the container


key: env

description:
Env can be used to add environment variables to the container. DevSpace will
not replace existing environment variables if an environment variable is defined here.


key: resources

description: Resources can be used to override the resource definitions of the container


key: reversePorts

description: ReversePorts are port mappings to make local ports available inside the container


key: sync

description: Sync allows you to sync certain local paths with paths inside the container


key: persistPaths

description: PersistPaths allows you to persist certain paths within this container with a persistent volume claim


key: terminal

description: Terminal allows you to tell DevSpace to open a terminal with screen support to this container


key: logs

description: Logs allows you to tell DevSpace to stream logs from this container to the console


key: attach

description: Attach allows you to tell DevSpace to attach to this container


key: ssh

description: SSH allows you to create an SSH tunnel to this container


key: proxyCommands

description: ProxyCommands allow you to proxy certain local commands to the container


key: restartHelper

description:
RestartHelper holds restart helper specific configuration. The restart helper is used to delay starting of
the container and restarting it and is injected via an annotation in the replaced pod.


key: ports

description:
Ports defines port mappings from the remote pod that should be forwarded to your local
computer


key: persistenceOptions

description: PersistenceOptions are additional options for persisting paths within this pod


key: patches

description: Patches are additional changes to the pod spec that should be applied


key: open

description: Open defines urls that should be opened as soon as they are reachable


key: DockerConfig

description: DockerConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost


key: disableFallback

description: DisableFallback allows you to turn off kaniko building if docker isn't installed


key: preferMinikube

description:
PreferMinikube allows you to turn off using the minikube docker daemon if the minikube
context is used.


key: useCli

description: UseCLI specifies if DevSpace should use the docker cli for building


key: args

description: Args are additional arguments to pass to the docker cli


key: name

description: Name of the environment variable


key: value

description: Value of the environment variable


key: HelmConfig

description: HelmConfig defines the specific helm options used during deployment


key: releaseName

description: ReleaseName of the helm configuration


key: chart

description: Chart holds the chart configuration and where DevSpace can find the chart


key: values

description: Values are additional values that should get passed to deploying this chart


key: valuesFiles

description: ValuesFiles are additional files that hold values for deploying this chart


key: displayOutput

description: DisplayOutput allows you to display the helm output to the console


key: upgradeArgs

description: UpgradeArgs are additional arguments to pass to `helm upgrade`


key: templateArgs

description: TemplateArgs are additional arguments to pass to `helm template`


key: disableDependencyUpdate

description: DisableDependencyUpdate disables helm dependencies update, default to false


key: Image

description: Image defines the image specification

default: ./Dockerfile

group: buildConfig

group: overwrites

group_name: In-Memory Overwrites

group_name: Build Configuration

enum: default always ignoreContextChanges

group: pushPull

group_name: Push & Pull

group: engines

group_name: Build Engines


description: Name of the image, will be filled automatically


key: image

description:
Image is the complete image name including registry and repository
for example myregistry.com/mynamespace/myimage


key: tags

description:
Tags is an array that specifies all tags that should be build during
the build process. If this is empty, devspace will generate a random tag


key: dockerfile

description: Dockerfile specifies a path (relative or absolute) to the dockerfile. Defaults to ./Dockerfile.


key: context

description: Context is the context path to build with. Defaults to the current working directory


key: entrypoint

description:
Entrypoint specifies an entrypoint that will be appended to the dockerfile during
image build in memory. Example: ["sleep", "99999"]


key: cmd

description:
Cmd specifies the arguments for the entrypoint that will be appended
during build in memory to the dockerfile


key: appendDockerfileInstructions

description:
AppendDockerfileInstructions are instructions that will be appended to the Dockerfile that is build
at the current build target and are appended before the entrypoint and cmd instructions


key: buildArgs

description: BuildArgs are the build args that are to the build


key: target

description: Target is the target that should get used during the build. Only works if the dockerfile supports this


key: network

description: Network is the network that should get used to build the image


key: rebuildStrategy

description:
RebuildStrategy is used to determine when DevSpace should rebuild an image. By default, devspace will
rebuild an image if one of the following conditions is true:
- The dockerfile has changed
- The configuration within the devspace.yaml for the image has changed
- A file within the docker context (excluding .dockerignore rules) has changed
This option is ignored for custom builds.


key: skipPush

description:
SkipPush will not push the image to a registry if enabled. Only works if docker or buildkit is chosen
as build method


key: createPullSecret

description:
CreatePullSecret specifies if a pull secret should be created for this image in the
target namespace. Defaults to true


key: buildKit

description: BuildKit if buildKit is specified, DevSpace will build the image either in-cluster or locally with BuildKit


key: docker

description: Docker if docker is specified, DevSpace will build the image using the local docker daemon


key: kaniko

description: Kaniko if kaniko is specified, DevSpace will build the image in-cluster with kaniko


key: custom

description:
Custom if custom is specified, DevSpace will build the image with the help of
a custom script.


key: Import

description: Import specifies the source of the devspace config to merge


key: enabled

description: Enabled specifies if the given import should be enabled


key: path

description:
Path is the local path where DevSpace can find the artifact.
This option is mutually exclusive with the git option.


key: git

description:
Git is the remote repository to download the artifact from. You can either use
https projects or ssh projects here, but need to make sure git can pull the project.
This option is mutually exclusive with the path option.


key: subPath

description: SubPath is a path within the git repository where the artifact lies in


key: branch

description: Branch is the git branch to pull


key: tag

description: Tag is the tag to pull


key: revision

description: Revision is the git revision to pull


key: cloneArgs

description: CloneArgs are additional arguments that should be supplied to the git CLI


key: disableShallow

description:
DisableShallow can be used to turn off shallow clones as these are the default used
by devspace


key: disablePull

description: DisablePull will disable pulling every time DevSpace is reevaluating this source


key: KanikoAdditionalMount

description: KanikoAdditionalMount tells devspace how the additional mount of the kaniko pod should look like


key: secret

description: The secret that should be mounted


key: configMap

description: The configMap that should be mounted


key: readOnly

description:
Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
+optional


key: mountPath

description:
Path within the container at which the volume should be mounted.  Must
not contain ':'.


description:
Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
+optional


key: name

description:
Name of the configmap
+optional


key: items

description:
If unspecified, each key-value pair in the Data field of the referenced
ConfigMap will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the ConfigMap,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'.
+optional


key: defaultMode

description:
Optional: mode bits to use on created files by default. Must be a
value between 0 and 0777. Defaults to 0644.
Directories within the path are not affected by this setting.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.
+optional


key: key

description: The key to project.


key: path

description:
The relative path of the file to map the key to.
May not be an absolute path.
May not contain the path element '..'.
May not start with the string '..'.


key: mode

description:
Optional: mode bits to use on this file, must be a value between 0
and 0777. If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.
+optional


description:
Name of the secret in the pod's namespace to use.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+optional


description:
If unspecified, each key-value pair in the Data field of the referenced
Secret will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the Secret,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'.
+optional


key: KanikoConfig

description: KanikoConfig tells the DevSpace CLI to build with Docker on Minikube or on localhost


key: cache

description: Cache tells DevSpace if a cache repository should be used. defaults to false


key: snapshotMode

description: SnapshotMode tells DevSpace which snapshot mode kaniko should use. defaults to time


key: image

description: Image is the image name of the kaniko pod to use


key: initImage

description: InitImage to override the init image of the kaniko pod


key: args

description: Args for additional arguments that should be passed to kaniko


key: command

description: Command to replace the starting command for the kaniko container


key: namespace

description: Namespace is the namespace where the kaniko pod should be run


key: insecure

description: Insecure allows pushing to insecure registries


key: pullSecret

description: PullSecret is the pull secret to mount by default


key: skipPullSecretMount

description: SkipPullSecretMount will skip mounting the pull secret


key: nodeSelector

description: NodeSelector is the node selector to use for the kaniko pod


key: tolerations

description: Tolerations is a tolerations list to use for the kaniko pod


key: serviceAccount

description: ServiceAccount the service account to use for the kaniko pod


key: generateName

description: GenerateName is the optional prefix that will be set to the generateName field of the build pod


key: annotations

description: Annotations are extra annotations that will be added to the build pod


key: labels

description: Labels are extra labels that will be added to the build pod


key: initEnv

description: InitEnv are extra environment variables that will be added to the build init container


key: env

description:
Env are extra environment variables that will be added to the build kaniko container
Will populate the env.value field.


key: envFrom

description:
EnvFrom are extra environment variables from configmap or secret that will be added to the build kaniko container
Will populate the env.valueFrom field.


key: additionalMounts

description: AdditionalMounts are additional mounts that will be added to the build pod


key: resources

description: Resources are the resources that should be set on the kaniko pod


key: KubectlConfig

description: KubectlConfig defines the specific kubectl options used during deployment

group: kustomize

group_name: Kustomize


key: manifests

description:
Manifests is a list of files or folders that will be deployed by DevSpace using kubectl
or kustomize


key: applyArgs

description: ApplyArgs are extra arguments for `kubectl apply`


key: createArgs

description: CreateArgs are extra arguments for `kubectl create` which will be run before `kubectl apply`


key: kubectlBinaryPath

description: KubectlBinaryPath is the optional path where to find the kubectl binary


key: inlineManifest

description: InlineManifests is a block containing the manifest to deploy


key: kustomize

description: Kustomize can be used to enable kustomize instead of kubectl


key: kustomizeArgs

description: KustomizeArgs are extra arguments for `kustomize build` which will be run before `kubectl apply`


key: kustomizeBinaryPath

description: KustomizeBinaryPath is the optional path where to find the kustomize binary


key: patches

description: Patches are additional changes to the pod spec that should be applied


key: LocalRegistryConfig

description: LocalRegistryConfig holds the configuration of the local image registry


key: enabled

description:
Enabled enables the local registry for pushing images.
When unset the local registry will be used as a fallback if there are no push permissions for the registry.
When `true` the local registry will always be used.
When `false` the local registry will never be used.


key: localbuild

description: LocalBuild enables use of local docker builder instead of building in the cluster


key: namespace

description: Namespace where the local registry is deployed. Default is the current context's namespace


key: name

description: Name of the deployment and service of the local registry. Default is `registry`


key: image

description: Image of the local registry. Default is `registry:2.8.1`


key: buildKitImage

description: BuildKitImage of the buildkit sidecar. Default is `moby/buildkit:master-rootless`


key: port

description: Port that the registry image listens on. Default is `5000`


key: persistence

description: Persistence settings for the local registry


key: LocalRegistryPersistence

description: LocalRegistryPersistence configures persistence settings for the local registry


description: Enable enables persistence for the local registry


key: size

description: Size of the persistent volume for local docker registry storage. Default is `5Gi`


key: storageClassName

description: StorageClassName of the persistent volume. Default is your cluster's configured default storage class


description: Enabled can be used to enable printing container logs


key: lastLines

description: LastLines is the amount of lines to print of the running container initially


key: OpenConfig

description: OpenConfig defines what to open after services have been started


key: url

description: URL is the url to open in the browser after it is available


key: PatchConfig

description: PatchConfig describes a config patch and how it should be applied

required: op path


key: op

description: Operation is the path operation to do. Can be either replace, add or remove


key: path

description: Path is the config path to apply the patch to


key: value

description: Value is the value to use for this patch.


key: PatchTarget

description: PatchTarget describes a config patch and how it should be applied

required: target op path


key: target

description: Target describes where to apply a config patch


key: PersistenceOptions

description: PersistenceOptions are general persistence options DevSpace should use for all persistent paths within a single dev configuration


description: Size is the size of the created persistent volume in Kubernetes size notation like 5Gi


description: StorageClassName is the storage type DevSpace should use for this persistent volume


key: accessModes

description: AccessModes are the access modes DevSpace should use for the persistent volume


key: readOnly

description: ReadOnly specifies if the volume should be read only


key: name

description:
Name is the name of the PVC that should be created. If a PVC with that name
already exists, DevSpace will use that PVC instead of creating one.


key: PersistentPath

description: PersistentPath holds options to configure persistence for DevSpace


description:
Path is the container path that should get persisted. By default, DevSpace will create an init container
that will copy over the contents of this folder from the existing image.


key: volumePath

description: VolumePath is the sub path on the volume that is mounted as persistent volume for this path


description: ReadOnly will make the persistent path read only to the user


key: skipPopulate

description: SkipPopulate will not create an init container to copy over the existing contents if true


key: initContainer

description: InitContainer holds additional options for the persistent path init container


key: PersistentPathInitContainer

description: PersistentPathInitContainer defines additional options for the persistent path init container


key: resources

description: Resources are the resources used by the persistent path init container


key: Pipeline

description: Pipeline defines what DevSpace should do.

enum: dev deploy build purge .*


description: Name of the pipeline, will be filled automatically


key: run

description: Run is the actual shell command that should be executed during this pipeline


key: flags

description:
Flags are extra flags that can be used for running the pipeline via
devspace run-pipeline.


key: continueOnError

description:
ContinueOnError will not fail the whole job and pipeline if
a call within the step fails.


key: PipelineFlag

description: PipelineFlag defines an extra pipeline flag

enum: bool int string stringArray


description: Name is the name of the flag


key: short

description: Short is optional and is the shorthand name for this flag. E.g. 'g' converts to '-g'


key: type

description: Type is the type of the flag. Defaults to `bool`


key: default

description: Default is the default value for this flag


key: description

description: Description is the description as shown in `devspace run-pipeline my-pipe -h`


key: PodResources

description: PodResources describes the resources section of the started kaniko pod


key: requests

description: Requests are the requests part of the resources


key: limits

description: Limits are the limits part of the resources


key: PortMapping

description: PortMapping defines the ports for a PortMapping


key: port

description:
Port is a port mapping that maps the localPort:remotePort. So if
you port forward the remote port will be available at the local port.
If you do reverse port forwarding, the local port will be available
at the remote port in the container. If only port is specified, local and
remote port are the same.


key: bindAddress

description:
BindAddress is the address DevSpace should listen on. Optional and defaults
to localhost.


key: gitCredentials

description: GitCredentials configures a git credentials helper inside the container that proxies local git credentials


key: command

description:
Command is the name of the command that should be available in the remote container. DevSpace
will create a small script for that inside the container that redirect command execution to
the local computer.


key: localCommand

description:
LocalCommand can be used to run a different command than specified via the command option. By
default, this will be assumed to be the same as command.


key: skipContainerEnv

description: SkipContainerEnv will not forward the container environment variables to the local command


key: env

description: Env are extra environment variables to set for the command


key: PullSecretConfig

description: PullSecretConfig defines a pull secret that should be created by DevSpace


key: name

description: Name is the pull secret name to deploy


key: registry

description:
The registry to create the image pull secret for.
Empty string == docker hub
e.g. gcr.io


key: username

description:
The username of the registry. If this is empty, devspace will try
to receive the auth data from the local docker


key: password

description:
The password to use for the registry. If this is empty, devspace will
try to receive the auth data from the local docker


key: email

description: The optional email to use


key: secret

description: The secret to create


key: serviceAccounts

description: The service account to add the secret to


description: Name is the name of the command that should be installed


key: versionArgs

description: VersionArgs are the arguments to retrieve the version of the command


key: versionRegEx

description: VersionRegEx is the regex that is used to parse the version


key: version

description: Version constraint of the command that should be installed


key: devspace

description: DevSpace specifies the DevSpace version constraint that is needed to use this config


key: commands

description: Commands specifies an array of commands that need to be installed locally to use this config


key: plugins

description: Plugins specifies an array of plugins that need to be installed locally


description: Name of the plugin that should be installed


description: Version constraint of the plugin that should be installed


key: path

description:
Path defines the path to the restart helper that might be used if certain config
options are enabled


key: inject

description: Inject signals DevSpace to inject the restart helper


key: enabled

description:
Enabled can be used to enable the ssh server within the container. By default,
DevSpace will generate the required keys and create an entry in your ~/.ssh/config
for this container that can be used via `ssh dev-config-name.dev-project-name.devspace`


key: localHostname

description: LocalHostname is the local ssh host to write to the ~/.ssh/config


key: localPort

description: LocalPort is the local port to forward from, if empty will be random


key: remoteAddress

description: RemoteAddress is the address to listen to inside the container


key: useInclude

description:
UseInclude tells DevSpace to use a the file ~/.ssh/devspace_config for its ssh entries. DevSpace
will also create an import for its own entries inside ~/.ssh/config, this is a cleaner way,
but unfortunately not all SSH clients support this.


key: SyncConfig

description: SyncConfig defines the paths for a SyncFolder

group: exclude

group_name: Exclude Paths From File Sync

group: actions

group_name: Sync-Triggered Actions

group_name: Initial Sync

group_name: One-Directional Sync


description:
Path is the path to sync. This can be defined in the form localPath:remotePath. You can also use '.'
to specify either the local or remote working directory. This is valid for example: .:.


key: excludePaths

description: ExcludePaths is an array of file patterns in gitignore format to exclude.


key: excludeFile

description: ExcludeFile loads the file patterns to exclude from a file.


key: downloadExcludePaths

description: DownloadExcludePaths is an array of file patterns in gitignore format to exclude from downloading


key: downloadExcludeFile

description: DownloadExcludeFile loads the file patterns to exclude from downloading from a file.


key: uploadExcludePaths

description: UploadExcludePaths is an array of file patterns in gitignore format to exclude from uploading


key: uploadExcludeFile

description: UploadExcludeFile loads the file patterns to exclude from uploading from a file.


key: startContainer

description:
StartContainer will start the container after initial sync is done. This will
inject a devspacehelper into the pod and you need to define dev.*.command for
this to work.


key: onUpload

description:
OnUpload can be used to execute certain commands on uploading either in the container or locally as
well as restart the container after a file changed has happened.


key: initialSync

description: InitialSync defines the initial sync strategy to use when this sync starts. Defaults to mirrorLocal


key: waitInitialSync

description: WaitInitialSync can be used to tell DevSpace to not wait until the initial sync is done


key: initialSyncCompareBy

description: InitialSyncCompareBy defines if the sync should only compare by the given type. Either mtime or size are possible


key: disableDownload

description: DisableDownload will disable downloading completely


key: disableUpload

description: DisableUpload will disable uploading completely


key: bandwidthLimits

description:
BandwidthLimits can be used to limit the amount of bytes that are transferred by DevSpace with this
sync configuration


key: polling

description: Polling will tell the remote container to use polling instead of inotify


key: noWatch

description: NoWatch will terminate the sync after the initial sync is done


key: file

description: File signals DevSpace that this is a single file that should get synced instead of a whole directory


key: name

description: Name is the name to show for this exec in the logs


key: command

description:
Command is the command to execute. If no args are specified this is executed
within a shell.


key: args

description: Args are arguments to pass to the command


key: failOnError

description: FailOnError specifies if the sync should fail if the command fails


key: local

description:
Local specifies if the command should be executed locally instead of within the
container


key: once

description:
Once executes this command only once in the container's life. Can be used to initialize
a container before starting it, but after everything was synced.


key: onChange

description: OnChange is an array of file patterns that trigger this command execution


key: SyncOnUpload

description: SyncOnUpload defines the struct for the command that should be executed when files / folders are uploaded


key: restartContainer

description:
If true restart container will try to restart the container after a change has been made. Make sure that
images.*.injectRestartHelper is enabled for the container that should be restarted or the devspace-restart-helper
script is present in the container root folder.


key: exec

description: Exec will execute the given commands in order after a sync operation


key: Target

description: Target describes where to apply a config patch

required: apiVersion kind name


key: apiVersion

description: ApiVersion is the Kubernetes api of the target resource


key: kind

description: Kind is the kind of the target resource (eg: Deployment, Service ...)


description: Name is the name of the target resource


key: Terminal

description: Terminal describes the terminal options


description:
Command is the command that should be executed on terminal start.
This command is executed within a shell.


key: workDir

description: WorkDir is the working directory that is used to execute the command in.


key: enabled

description:
If enabled is true, DevSpace will use the terminal. Can be also
used to disable the terminal if set to false. DevSpace makes sure
that within a pipeline only one dev configuration can open a terminal
at a time and subsequent dev terminals will fail.


key: disableReplace

description:
DisableReplace tells DevSpace to not replace the pod or adjust its settings
to make sure the pod is sleeping when opening a terminal


key: disableScreen

description:
DisableScreen will disable screen which is used by DevSpace by default to preserve
sessions if connections interrupt or the session is lost.


key: disableTTY

description: DisableTTY will disable a tty shell for terminal command execution


key: Variable

description: Variable describes the var definition

group: static

group_name: Static Value

group: question

group_name: Value From Command

enum: all env input command none


key: name

description: Name is the name of the variable


key: value

description: Value is a shortcut for using source: none and default: my-value


key: question

description: Question can be used to define a custom question if the variable was not yet used

group_name: Value From Input (Question)


key: default

description: Default is the default value the variable should have if not set by the user


key: options

description: Options are options that can be selected when the variable question is asked


key: password

description: Password signals that this variable should not be visible if entered


key: validationPattern

description: ValidationPattern can be used to verify the user input


key: validationMessage

description: ValidationMessage can be used to tell the user the format of the variable value


key: noCache

description: NoCache can be used to prompt the user on every run for this variable


key: command

description:
Command is the command how to retrieve the variable. If args is omitted, command is parsed as a shell
command.


key: args

description: Args are optional args that will be used for the command


key: commands

description:
Commands are additional commands that can be used to run a different command on a different operating
system.


key: alwaysResolve

description: AlwaysResolve makes sure this variable will always be resolved and not only if it is used somewhere. Defaults to false.


key: source

description: Source defines where the variable should be taken from


key: os

description:
OperatingSystem is optional and defines the operating system this
command should be executed on


description:
Command is the command to use to retrieve the value for this variable. If no
args are specified the command is run within a pseudo shell.


description: Args are optional arguments for the command


key: version

description:
Version holds the config version. DevSpace will always convert older configs to the current latest
config version, which makes it possible to use the newest DevSpace version also with older config
versions.


description:
Name specifies the name of the DevSpace project and uniquely identifies a project.
DevSpace will not allow multiple active projects with the same name in the same Kubernetes namespace.
If not provided, DevSpace will use the name of the current working directory.


key: imports

description:
Imports merges specified config files into this one. This is very useful to split up your DevSpace configuration
into multiple files and reuse those through git, a remote url or common local path.


key: functions

description:
Functions are POSIX functions that can be used within pipelines. Those functions can also be imported by
imports.


key: pipelines

description:
Pipelines are the work blocks that DevSpace should execute when devspace dev, devspace build, devspace deploy or devspace purge
is called. Pipelines are defined through a special POSIX script that allows you to use special commands
such as create_deployments, start_dev, build_images etc. to signal DevSpace you want to execute
a specific functionality. The pipelines dev, build, deploy and purge are special and will override
the default functionality of the respective command if defined. All other pipelines can be either run
via the devspace run-pipeline command or used within another pipeline through run_pipelines.


key: images

description:
Images holds configuration of how DevSpace should build images. By default, DevSpace will build all defined images.
If you are using a custom pipeline, you can dynamically define which image is built at which time during the
execution.


key: deployments

description:
Deployments holds configuration of how DevSpace should deploy resources to Kubernetes. By default, DevSpace will deploy all defined deployments.
If you are using a custom pipeline, you can dynamically define which deployment is deployed at which time during the
execution.


key: dev

description:
Dev holds development configuration. Each dev configuration targets a single pod and enables certain dev services on that pod
or even rewrites it if certain changes are requested, such as adding an environment variable or changing the entrypoint.
Dev allows you to:
- sync local folders to the Kubernetes pod
- port forward remote ports to your local computer
- forward local ports into the Kubernetes pod
- configure an ssh tunnel to the Kubernetes pod
- proxy local commands to the container
- restart the container on file changes


key: vars

description: Vars are config variables that can be used inside other config sections to replace certain values dynamically


description:
Commands are custom commands that can be executed via 'devspace run COMMAND'. These commands are run within a pseudo bash
that also allows executing special commands such as run_watch or is_equal.


key: dependencies

description:
Dependencies are sub devspace projects that lie in a local folder or remote git repository that can be executed
from within the pipeline. In contrast to imports, these projects pose as separate fully functional DevSpace projects
that typically lie including source code in a different folder and can be used to compose a full microservice
application that will be deployed by DevSpace. Each dependency name can only be used once and if you want to use
the same project multiple times, make sure to use a different name for each of those instances.


key: pullSecrets

description:
PullSecrets are image pull secrets that will be created by devspace in the target namespace
during devspace dev or devspace deploy. DevSpace will merge all defined pull secrets into a single
one or the one specified.


key: require

description:
Require defines what DevSpace, plugins and command versions are required to use this config and if a condition is not
fulfilled, DevSpace will fail.


key: localRegistry

description: LocalRegistry specifies the configuration for a local image registry


key: ca

description: A string or array of strings of trusted certificates in PEM format

type: array string


key: cert

description: Public x509 certificate to use


key: defaultSource

description: Override the default installation source (e.g., when doing 'typings install debug')

default: npm

enum: file npm github bitbucket bower http https


key: githubToken

description: Set your GitHub for resolving 'github:' locations


key: httpProxy

description: The proxy to use for HTTP requests


key: httpsProxy

description: The proxy to use for HTTPS requests


key: key

description: Private key to use for SSL


key: noProxy

description: A string of space-separated hosts to not proxy


key: proxy

description: A HTTP(s) proxy URI for outgoing requests


key: registryURL

description: Override the registry URL


key: rejectUnauthorized

description: Reject invalid SSL certificates


key: userAgent

description: Set the User-Agent for HTTP requests


key: Android

description: Configuration that is specific to the Android platform.

enum: light dark automatic

enum: cover contain native

enum: resize pan

enum: hermes jsc


key: publishManifestPath

description: The manifest for the Android version of your app will be written to this path during publish.


key: publishBundlePath

description: The bundle for the Android version of your app will be written to this path during publish.


key: package

description: The package name for your Android standalone app. You make it up, but it needs to be unique on the Play Store. See [this StackOverflow question](http://stackoverflow.com/questions/6273892/android-package-name-convention).


key: versionCode

description: Version number required by Google Play. Increment by one for each release. Must be a positive integer. [Learn more](https://developer.android.com/studio/publish/versioning.html)


key: backgroundColor

description: The background color for your Android app, behind any of your React views. Overrides the top-level `backgroundColor` key if it is present.


key: userInterfaceStyle

description: Configuration to force the app to always use the light or dark user-interface appearance, such as "dark mode", or make it automatically adapt to the system preferences. If not provided, defaults to `light`.


key: useNextNotificationsApi

description: @deprecated A Boolean value that indicates whether the app should use the new notifications API.


key: icon

description: Local path or remote URL to an image to use for your app's icon on Android. If specified, this overrides the top-level `icon` key. We recommend that you use a 1024x1024 png file (transparency is recommended for the Google Play Store). This icon will appear on the home screen and within the Expo app.


key: adaptiveIcon

description: Settings for an Adaptive Launcher Icon on Android. [Learn more](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive)


key: foregroundImage

description: Local path or remote URL to an image to use for your app's icon on Android. If specified, this overrides the top-level `icon` and the `android.icon` keys. Should follow the [specified guidelines](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive). This icon will appear on the home screen.


key: backgroundImage

description: Local path or remote URL to a background image for your app's Adaptive Icon on Android. If specified, this overrides the `backgroundColor` key. Must have the same dimensions as  foregroundImage`, and has no effect if `foregroundImage` is not specified. Should follow the [specified guidelines](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive).


description: Color to use as the background for your app's Adaptive Icon on Android. Defaults to white, `#FFFFFF`. Has no effect if `foregroundImage` is not specified.


key: playStoreUrl

description: URL to your app on the Google Play Store, if you have deployed it there. This is used to link to your store page from your Expo project page if your app is public.


key: permissions

description:
List of permissions used by the standalone app.

 To use ONLY the following minimum necessary permissions and none of the extras supported by Expo in a default managed app, set `permissions` to `[]`. The minimum necessary permissions do not require a Privacy Policy when uploading to Google Play Store and are:
• receive data from Internet
• view network connections
• full network access
• change your audio settings
• prevent device from sleeping

 To use ALL permissions supported by Expo by default, do not specify the `permissions` key.

  To use the minimum necessary permissions ALONG with certain additional permissions, specify those extras in `permissions`, e.g.

 `[ "CAMERA", "ACCESS_FINE_LOCATION" ]`.

  You can specify the following permissions depending on what you need:

- `ACCESS_COARSE_LOCATION`
- `ACCESS_FINE_LOCATION`
- `ACCESS_BACKGROUND_LOCATION`
- `CAMERA`
- `RECORD_AUDIO`
- `READ_CONTACTS`
- `WRITE_CONTACTS`
- `READ_CALENDAR`
- `WRITE_CALENDAR`
- `READ_EXTERNAL_STORAGE`
- `WRITE_EXTERNAL_STORAGE`
- `USE_FINGERPRINT`
- `USE_BIOMETRIC`
- `WRITE_SETTINGS`
- `VIBRATE`
- `READ_PHONE_STATE`
- `com.anddoes.launcher.permission.UPDATE_COUNT`
- `com.android.launcher.permission.INSTALL_SHORTCUT`
- `com.google.android.c2dm.permission.RECEIVE`
- `com.google.android.gms.permission.ACTIVITY_RECOGNITION`
- `com.google.android.providers.gsf.permission.READ_GSERVICES`
- `com.htc.launcher.permission.READ_SETTINGS`
- `com.htc.launcher.permission.UPDATE_SHORTCUT`
- `com.majeur.launcher.permission.UPDATE_BADGE`
- `com.sec.android.provider.badge.permission.READ`
- `com.sec.android.provider.badge.permission.WRITE`
- `com.sonyericsson.home.permission.BROADCAST_BADGE`


key: googleServicesFile

description: [Firebase Configuration File](https://support.google.com/firebase/answer/7015592) Location of the `GoogleService-Info.plist` file for configuring Firebase. Including this key automatically enables FCM in your standalone app.


key: config

description: Note: This property key is not included in the production manifest and will evaluate to `undefined`. It is used internally only in the build process, because it contains API keys that some may want to keep private.


key: branch

description: [Branch](https://branch.io/) key to hook up Branch linking services.


key: apiKey

description: Your Branch API key


key: googleMaps

description: [Google Maps Android SDK](https://developers.google.com/maps/documentation/android-api/signup) configuration for your standalone app.


description: Your Google Maps Android SDK API key


key: googleMobileAdsAppId

description: [Google Mobile Ads App ID](https://support.google.com/admob/answer/6232340) Google AdMob App ID.


key: googleMobileAdsAutoInit

description: A boolean indicating whether to initialize Google App Measurement and begin sending user-level event data to Google immediately when the app starts. The default in Expo (Client and in standalone apps) is `false`. [Sets the opposite of the given value to the following key in `Info.plist`](https://developers.google.com/admob/ios/eu-consent#delay_app_measurement_optional)


key: googleSignIn

description: @deprecated Use `googleServicesFile` instead. [Google Sign-In Android SDK](https://developers.google.com/identity/sign-in/android/start-integrating) keys for your standalone app.


description: The Android API key. Can be found in the credentials section of the developer console or in `google-services.json`.


key: certificateHash

description: The SHA-1 hash of the signing certificate used to build the APK without any separator (`:`). Can be found in `google-services.json`. https://developers.google.com/android/guides/client-auth


key: splash

description: Configuration for loading and splash screen for managed and standalone Android apps.


key: backgroundColor

description: Color to fill the loading screen background


key: resizeMode

description: Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover`, `contain` or `native`, defaults to `contain`.


key: image

description: Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.


key: mdpi

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Natural sized image (baseline)`


key: hdpi

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Scale 1.5x`


key: xhdpi

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Scale 2x`


key: xxhdpi

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Scale 3x`


key: xxxhdpi

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Scale 4x`


key: intentFilters

description: Configuration for setting an array of custom intent filters in Android manifest. [Learn more](https://developer.android.com/guide/components/intents-filters)


key: autoVerify

description: You may also use an intent filter to set your app as the default handler for links (without showing the user a dialog with options). To do so use `true` and then configure your server to serve a JSON file verifying that you own the domain. [Learn more](developer.android.com/training/app-links)


key: scheme

description: the scheme of the URL, e.g. `https`


key: host

description: the hostname, e.g. `myapp.io`


key: port

description: the port, e.g. `3000`


key: path

description: an exact path for URLs that should be matched by the filter, e.g. `/records`


key: pathPattern

description: a regex for paths that should be matched by the filter, e.g. `.*`


key: pathPrefix

description: a prefix for paths that should be matched by the filter, e.g. `/records/` will match `/records/123`


key: mimeType

description: a MIME type for URLs that should be matched by the filter


key: allowBackup

description: Allows your user's app data to be automatically backed up to their Google Drive. If this is set to false, no backup or restore of the application will ever be performed (this is useful if your app deals with sensitive information). Defaults to the Android default, which is `true`.


key: softwareKeyboardLayoutMode

description: Determines how the software keyboard will impact the layout of your application. This maps to the `android:windowSoftInputMode` property. Defaults to `resize`. Valid values: `resize`, `pan`.


key: jsEngine

description: Specifies the JavaScript engine. Supported only on EAS Build. Defaults to `jsc`. Valid values: `hermes`, `jsc`.


key: IOS

description: Configuration that is specific to the iOS platform.

enum: cover contain


key: publishManifestPath

description: The manifest for the iOS version of your app will be written to this path during publish.


key: publishBundlePath

description: The bundle for the iOS version of your app will be written to this path during publish.


key: bundleIdentifier

description: The bundle identifier for your iOS standalone app. You make it up, but it needs to be unique on the App Store. See [this StackOverflow question](http://stackoverflow.com/questions/11347470/what-does-bundle-identifier-mean-in-the-ios-project).


key: buildNumber

description: Build number for your iOS standalone app. Corresponds to `CFBundleVersion` and must match Apple's [specified format](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364). (Note: Transporter will pull the value for `Version Number` from `expo.version` and NOT from `expo.ios.buildNumber`.)


key: backgroundColor

description: The background color for your iOS app, behind any of your React views. Overrides the top-level `backgroundColor` key if it is present.


key: icon

description:
Local path or remote URL to an image to use for your app's icon on iOS. If specified, this overrides the top-level `icon` key. Use a 1024x1024 icon which follows Apple's interface guidelines for icons, including color profile and transparency.

 Expo will generate the other required sizes. This icon will appear on the home screen and within the Expo app.


key: merchantId

description: Merchant ID for use with Apple Pay in your standalone app.


key: appStoreUrl

description: URL to your app on the Apple App Store, if you have deployed it there. This is used to link to your store page from your Expo project page if your app is public.


key: config

description: Note: This property key is not included in the production manifest and will evaluate to `undefined`. It is used internally only in the build process, because it contains API keys that some may want to keep private.


key: branch

description: [Branch](https://branch.io/) key to hook up Branch linking services.


key: apiKey

description: Your Branch API key


key: usesNonExemptEncryption

description: Sets `ITSAppUsesNonExemptEncryption` in the standalone ipa's Info.plist to the given boolean value.


key: googleMapsApiKey

description: [Google Maps iOS SDK](https://developers.google.com/maps/documentation/ios-sdk/start) key for your standalone app.


key: googleMobileAdsAppId

description: [Google Mobile Ads App ID](https://support.google.com/admob/answer/6232340) Google AdMob App ID.


key: googleMobileAdsAutoInit

description: A boolean indicating whether to initialize Google App Measurement and begin sending user-level event data to Google immediately when the app starts. The default in Expo (Go and in standalone apps) is `false`. [Sets the opposite of the given value to the following key in `Info.plist`.](https://developers.google.com/admob/ios/eu-consent#delay_app_measurement_optional)


key: googleSignIn

description: [Google Sign-In iOS SDK](https://developers.google.com/identity/sign-in/ios/start-integrating) keys for your standalone app.


key: reservedClientId

description: The reserved client ID URL scheme. Can be found in `GoogleService-Info.plist`.


key: googleServicesFile

description: [Firebase Configuration File](https://support.google.com/firebase/answer/7015592) Location of the `GoogleService-Info.plist` file for configuring Firebase.


key: supportsTablet

description: Whether your standalone iOS app supports tablet screen sizes. Defaults to `false`.


key: isTabletOnly

description: If true, indicates that your standalone iOS app does not support handsets, and only supports tablets.


key: requireFullScreen

description: If true, indicates that your standalone iOS app does not support Slide Over and Split View on iPad. Defaults to `true` currently, but will change to `false` in a future SDK version.


key: userInterfaceStyle

description: Configuration to force the app to always use the light or dark user-interface appearance, such as "dark mode", or make it automatically adapt to the system preferences. If not provided, defaults to `light`.


key: infoPlist

description: Dictionary of arbitrary configuration to add to your standalone app's native Info.plist. Applied prior to all other Expo-specific configuration. No other validation is performed, so use this at your own risk of rejection from the App Store.


key: entitlements

description: Dictionary of arbitrary configuration to add to your standalone app's native *.entitlements (plist). Applied prior to all other Expo-specific configuration. No other validation is performed, so use this at your own risk of rejection from the App Store.


key: associatedDomains

description: An array that contains Associated Domains for the standalone app. [Learn more](https://developer.apple.com/documentation/safariservices/supporting_associated_domains).


key: usesIcloudStorage

description: A boolean indicating if the app uses iCloud Storage for `DocumentPicker`. See `DocumentPicker` docs for details.


key: usesAppleSignIn

description: A boolean indicating if the app uses Apple Sign-In. See `AppleAuthentication` docs for details.


key: accessesContactNotes

description: A Boolean value that indicates whether the app may access the notes stored in contacts. You must [receive permission from Apple](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_contacts_notes) before you can submit your app for review with this capability.


key: splash

description: Configuration for loading and splash screen for standalone iOS apps.


key: xib

description: @deprecated Apple has deprecated `.xib` splash screens in favor of `.storyboard` files. Local path to a XIB file as the loading screen. It overrides other loading screen options. Note: This will only be used in the standalone app (i.e., after you build the app). It will not be used in the Expo Go.


key: backgroundColor

description: Color to fill the loading screen background


key: resizeMode

description: Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`.


key: image

description: Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.


key: tabletImage


key: Splash

description: Configuration for loading and splash screen for standalone apps.


key: Web

description: Configuration that is specific to the web platform.

enum: auto ltr rtl

enum: fullscreen standalone minimal-ui browser

enum: any natural landscape landscape-primary landscape-secondary portrait portrait-primary portrait-secondary

enum: default black black-translucent


key: favicon

description: Relative path of an image to use for your app's favicon.


key: name

description: Defines the title of the document, defaults to the outer level name


key: shortName

description: A short version of the app's name, 12 characters or fewer. Used in app launcher and new tab pages. Maps to `short_name` in the PWA manifest.json. Defaults to the `name` property.


key: lang

description: Specifies the primary language for the values in the name and short_name members. This value is a string containing a single language tag.


key: scope

description: Defines the navigation scope of this website's context. This restricts what web pages can be viewed while the manifest is applied. If the user navigates outside the scope, it returns to a normal web page inside a browser tab/window. If the scope is a relative URL, the base URL will be the URL of the manifest.


key: themeColor

description: Defines the color of the Android tool bar, and may be reflected in the app's preview in task switchers.


key: description

description: Provides a general description of what the pinned website does.


key: dir

description: Specifies the primary text direction for the name, short_name, and description members. Together with the lang member, it helps the correct display of right-to-left languages.


key: display

description: Defines the developers' preferred display mode for the website.


key: startUrl

description: The URL that loads when a user launches the application (e.g., when added to home screen), typically the index. Note: This has to be a relative URL, relative to the manifest URL.


key: orientation

description: Defines the default orientation for all the website's top level browsing contexts.


key: backgroundColor

description: Defines the expected "background color" for the website. This value repeats what is already available in the site's CSS, but can be used by browsers to draw the background color of a shortcut when the manifest is available before the stylesheet has loaded. This creates a smooth transition between launching the web application and loading the site's content.


key: barStyle

description: If content is set to default, the status bar appears normal. If set to black, the status bar has a black background. If set to black-translucent, the status bar is black and translucent. If set to default or black, the web content is displayed below the status bar. If set to black-translucent, the web content is displayed on the entire screen, partially obscured by the status bar.


key: preferRelatedApplications

description: Hints for the user agent to indicate to the user that the specified native applications (defined in expo.ios and expo.android) are recommended over the website.


key: dangerous

description: Experimental features. These will break without deprecation notice.


key: splash

description: Configuration for PWA splash screens.


description: Color to fill the loading screen background


key: resizeMode

description: Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`.


key: image

description: Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.


key: config

description: Firebase web configuration. Used by the expo-firebase packages on both web and native. [Learn more](https://firebase.google.com/docs/reference/js/firebase.html#initializeapp)


key: name

description: The name of your app as it appears both within Expo Go and on your home screen as a standalone app.


description: A short description of what your app is and why it is great.


key: slug

description: The friendly URL name for publishing. For example, `myAppName` will refer to the `expo.io/@project-owner/myAppName` project.


key: owner

description: The Expo account name of the team owner, only applicable if you are enrolled in the EAS Priority Plan. If not provided, defaults to the username of the current user.


key: currentFullName

description: The auto generated Expo account name and slug used for display purposes. Formatted like `@username/slug`. When unauthenticated, the username is `@anonymous`. For published projects, this value may change when a project is transferred between accounts or renamed.


key: originalFullName

description: The auto generated Expo account name and slug used for services like Notifications and AuthSession proxy. Formatted like `@username/slug`. When unauthenticated, the username is `@anonymous`. For published projects, this value will not change when a project is transferred between accounts or renamed.


key: privacy

description: Defaults to `unlisted`. `unlisted` hides the project from search results. `hidden` restricts access to the project page to only the owner and other users that have been granted access. Valid values: `public`, `unlisted`, `hidden`.

enum: public unlisted hidden


key: sdkVersion

description: The Expo sdkVersion to run the project on. This should line up with the version specified in your package.json.


key: runtimeVersion

description: Runtime versions are a property that guarantees compatibility between a build's native code and an update. When a project is made into a build, the build will contain some native code that cannot be changed with an update. Therefore, an update must be compatible with a build's native code to run on the build.

enum: appVersion nativeVersion sdkVersion


key: version

description: Your app version. In addition to this field, you'll also use `ios.buildNumber` and `android.versionCode` — read more about how to version your app [here](https://docs.expo.io/distribution/app-stores/#versioning-your-app). On iOS this corresponds to `CFBundleShortVersionString`, and on Android, this corresponds to `versionName`. The required format can be found [here](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleshortversionstring).


key: platforms

description: Platforms that your project explicitly supports. If not specified, it defaults to `["ios", "android"]`.

enum: android ios web


key: githubUrl

description: If you would like to share the source code of your app on Github, enter the URL for the repository here and it will be linked to from your Expo project page.


key: orientation

description: Locks your app to a specific orientation with portrait or landscape. Defaults to no lock. Valid values: `default`, `portrait`, `landscape`

enum: default portrait landscape


key: userInterfaceStyle

description: Configuration to force the app to always use the light or dark user-interface appearance, such as "dark mode", or make it automatically adapt to the system preferences. If not provided, defaults to `light`.


key: backgroundColor

description: The background color for your app, behind any of your React views. This is also known as the root view background color.


key: primaryColor

description: On Android, this will determine the color of your app in the multitasker. Currently this is not used on iOS, but it may be used for other purposes in the future.


key: icon

description: Local path or remote URL to an image to use for your app's icon. We recommend that you use a 1024x1024 png file. This icon will appear on the home screen and within the Expo app.


key: notification

description: Configuration for remote (push) notifications.

enum: default collapse


description: (Android only) Local path or remote URL to an image to use as the icon for push notifications. 96x96 png grayscale with transparency. We recommend following [Google's design guidelines](https://material.io/design/iconography/product-icons.html#design-principles). If not provided, defaults to your app icon.


key: color

description: (Android only) Tint color for the push notification image when it appears in the notification tray. Defaults to `#ffffff`


key: iosDisplayInForeground

description: Whether or not to display notifications when the app is in the foreground on iOS. `_displayInForeground` option in the individual push notification message overrides this option. [Learn more.](https://docs.expo.io/push-notifications/receiving-notifications/#foreground-notification-behavior) Defaults to `false`.


key: androidMode

description: Show each push notification individually (`default`) or collapse into one (`collapse`).


key: androidCollapsedTitle

description: If `androidMode` is set to `collapse`, this title is used for the collapsed notification message. For example, `'#{unread_notifications} new interactions'`.


key: appKey

description: By default, Expo looks for the application registered with the AppRegistry as `main`. If you would like to change this, you can specify the name in this property.


key: androidStatusBar

description: Configuration for the status bar on Android. For more details please navigate to [Configuring StatusBar](https://docs.expo.io/guides/configuring-statusbar/).

enum: light-content dark-content


key: barStyle

description: Configures the status bar icons to have a light or dark color. Valid values: `light-content`, `dark-content`. Defaults to `dark-content`


description: Specifies the background color of the status bar. Defaults to `#00000000` (transparent) for `dark-content` bar style and `#00000088` (semi-transparent black) for `light-content` bar style


key: hidden

description: Instructs the system whether the status bar should be visible or not. Defaults to `false`


key: translucent

description: Sets `android:windowTranslucentStatus` in `styles.xml`. When false, the system status bar pushes the content of your app down (similar to `position: relative`). When true, the status bar floats above the content in your app (similar to `position: absolute`). Defaults to `true` to match the iOS status bar behavior (which can only float above content).


key: androidNavigationBar

description: Configuration for the bottom navigation bar on Android.

enum: leanback immersive sticky-immersive


key: visible

description:
Determines how and when the navigation bar is shown. [Learn more](https://developer.android.com/training/system-ui/immersive). Valid values: `leanback`, `immersive`, `sticky-immersive`

 `leanback` results in the navigation bar being hidden until the first touch gesture is registered.

 `immersive` results in the navigation bar being hidden until the user swipes up from the edge where the navigation bar is hidden.

 `sticky-immersive` is identical to `'immersive'` except that the navigation bar will be semi-transparent and will be hidden again after a short period of time


description: Configure the navigation bar icons to have a light or dark color. Supported on Android Oreo and newer. Valid values: `'light-content'`, `'dark-content'`


description: Specifies the background color of the navigation bar.


key: developmentClient

description: Settings that apply specifically to running this app in a development client


key: silentLaunch

description: If true, the app will launch in a development client with no additional dialogs or progress indicators, just like in a standalone app.


key: scheme

description: **Standalone Apps Only**. URL scheme to link into your app. For example, if we set this to `'demo'`, then demo:// URLs would open your app when tapped.


key: entryPoint

description: The relative path to your main JavaScript file.


key: extra

description: Any extra fields you want to pass to your experience. Values are accessible via `Expo.Constants.manifest.extra` ([Learn more](https://docs.expo.io/versions/latest/sdk/constants/#constantsmanifest))


key: packagerOpts

description: @deprecated Use a `metro.config.js` file instead. [Learn more](https://docs.expo.io/guides/customizing-metro/)


key: updates

description: Configuration for how and when the app should request OTA JavaScript updates

type: number


key: enabled

description: If set to false, your standalone app will never download any code, and will only use code bundled locally on the device. In that case, all updates to your app must be submitted through app store review. Defaults to true. (Note: This will not work out of the box with ExpoKit projects)


key: checkAutomatically

description: By default, Expo will check for updates every time the app is loaded. Set this to `ON_ERROR_RECOVERY` to disable automatic checking unless recovering from an error. Must be one of `ON_LOAD` or `ON_ERROR_RECOVERY`


key: fallbackToCacheTimeout

description: How long (in ms) to allow for fetching OTA updates before falling back to a cached version of the app. Defaults to 0. Must be between 0 and 300000 (5 minutes).


key: url

description: URL from which expo-updates will fetch update manifests


key: locales

description: Provide overrides by locale for System Dialog prompts like Permissions Boxes

type: string object


key: facebookAppId

description: Used for all Facebook libraries. Set up your Facebook App ID at https://developers.facebook.com.


key: facebookAutoInitEnabled

description: Whether the Facebook SDK should be initialized automatically. The default in Expo (Client and in standalone apps) is `false`.


key: facebookAutoLogAppEventsEnabled

description: Whether the Facebook SDK log app events automatically. If you don't set this property, Facebook's default will be used. (Applicable only to standalone apps.) Note: The Facebook SDK must be initialized for app events to work. You may autoinitialize Facebook SDK by setting `facebookAutoInitEnabled` to `true`


key: facebookAdvertiserIDCollectionEnabled

description: Whether the Facebook SDK should collect advertiser ID properties, like the Apple IDFA and Android Advertising ID, automatically. If you don't set this property, Facebook's default policy will be used. (Applicable only to standalone apps.)


key: facebookDisplayName

description: Used for native Facebook login.


key: facebookScheme

description: Used for Facebook native login. Starts with 'fb' and followed by a string of digits, like 'fb1234567890'. You can find your scheme [here](https://developers.facebook.com/docs/facebook-login/ios)in the 'Configuring Your info.plist' section (only applicable to standalone apps and custom Expo Go apps).


key: isDetached

description: Is app detached


key: detach

description: Extra fields needed by detached apps


key: assetBundlePatterns

description: An array of file glob strings which point to assets that will be bundled within your standalone app binary. Read more in the [Offline Support guide](https://docs.expo.io/guides/offline-support/)


key: plugins

description: Config plugins for adding extra functionality to your project. [Learn more](https://docs.expo.io/guides/config-plugins/).


key: splash

description: Configuration for loading and splash screen for standalone apps.


key: backgroundColor

description: Color to fill the loading screen background


key: resizeMode

description: Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`.


key: image

description: Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.


key: ios

description: Configuration that is specific to the iOS platform.


key: publishManifestPath

description: The manifest for the iOS version of your app will be written to this path during publish.


key: publishBundlePath

description: The bundle for the iOS version of your app will be written to this path during publish.


key: bundleIdentifier

description: The bundle identifier for your iOS standalone app. You make it up, but it needs to be unique on the App Store. See [this StackOverflow question](http://stackoverflow.com/questions/11347470/what-does-bundle-identifier-mean-in-the-ios-project).


key: buildNumber

description: Build number for your iOS standalone app. Corresponds to `CFBundleVersion` and must match Apple's [specified format](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102364). (Note: Transporter will pull the value for `Version Number` from `expo.version` and NOT from `expo.ios.buildNumber`.)


description: The background color for your iOS app, behind any of your React views. Overrides the top-level `backgroundColor` key if it is present.


key: icon

description:
Local path or remote URL to an image to use for your app's icon on iOS. If specified, this overrides the top-level `icon` key. Use a 1024x1024 icon which follows Apple's interface guidelines for icons, including color profile and transparency.

 Expo will generate the other required sizes. This icon will appear on the home screen and within the Expo app.


key: merchantId

description: Merchant ID for use with Apple Pay in your standalone app.


key: appStoreUrl

description: URL to your app on the Apple App Store, if you have deployed it there. This is used to link to your store page from your Expo project page if your app is public.


key: config

description: Note: This property key is not included in the production manifest and will evaluate to `undefined`. It is used internally only in the build process, because it contains API keys that some may want to keep private.


key: branch

description: [Branch](https://branch.io/) key to hook up Branch linking services.


key: apiKey

description: Your Branch API key


key: usesNonExemptEncryption

description: Sets `ITSAppUsesNonExemptEncryption` in the standalone ipa's Info.plist to the given boolean value.


key: googleMapsApiKey

description: [Google Maps iOS SDK](https://developers.google.com/maps/documentation/ios-sdk/start) key for your standalone app.


key: googleMobileAdsAppId

description: [Google Mobile Ads App ID](https://support.google.com/admob/answer/6232340) Google AdMob App ID.


key: googleMobileAdsAutoInit

description: A boolean indicating whether to initialize Google App Measurement and begin sending user-level event data to Google immediately when the app starts. The default in Expo (Go and in standalone apps) is `false`. [Sets the opposite of the given value to the following key in `Info.plist`.](https://developers.google.com/admob/ios/eu-consent#delay_app_measurement_optional)


key: googleSignIn

description: [Google Sign-In iOS SDK](https://developers.google.com/identity/sign-in/ios/start-integrating) keys for your standalone app.


key: reservedClientId

description: The reserved client ID URL scheme. Can be found in `GoogleService-Info.plist`.


key: googleServicesFile

description: [Firebase Configuration File](https://support.google.com/firebase/answer/7015592) Location of the `GoogleService-Info.plist` file for configuring Firebase.


key: supportsTablet

description: Whether your standalone iOS app supports tablet screen sizes. Defaults to `false`.


key: isTabletOnly

description: If true, indicates that your standalone iOS app does not support handsets, and only supports tablets.


key: requireFullScreen

description: If true, indicates that your standalone iOS app does not support Slide Over and Split View on iPad. Defaults to `true` currently, but will change to `false` in a future SDK version.


key: userInterfaceStyle

description: Configuration to force the app to always use the light or dark user-interface appearance, such as "dark mode", or make it automatically adapt to the system preferences. If not provided, defaults to `light`.


key: infoPlist

description: Dictionary of arbitrary configuration to add to your standalone app's native Info.plist. Applied prior to all other Expo-specific configuration. No other validation is performed, so use this at your own risk of rejection from the App Store.


key: entitlements

description: Dictionary of arbitrary configuration to add to your standalone app's native *.entitlements (plist). Applied prior to all other Expo-specific configuration. No other validation is performed, so use this at your own risk of rejection from the App Store.


key: associatedDomains

description: An array that contains Associated Domains for the standalone app. [Learn more](https://developer.apple.com/documentation/safariservices/supporting_associated_domains).


key: usesIcloudStorage

description: A boolean indicating if the app uses iCloud Storage for `DocumentPicker`. See `DocumentPicker` docs for details.


key: usesAppleSignIn

description: A boolean indicating if the app uses Apple Sign-In. See `AppleAuthentication` docs for details.


key: accessesContactNotes

description: A Boolean value that indicates whether the app may access the notes stored in contacts. You must [receive permission from Apple](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_contacts_notes) before you can submit your app for review with this capability.


key: splash

description: Configuration for loading and splash screen for standalone iOS apps.


key: xib

description: @deprecated Apple has deprecated `.xib` splash screens in favor of `.storyboard` files. Local path to a XIB file as the loading screen. It overrides other loading screen options. Note: This will only be used in the standalone app (i.e., after you build the app). It will not be used in the Expo Go.


key: backgroundColor

description: Color to fill the loading screen background


key: resizeMode

description: Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`.


key: image

description: Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.


key: tabletImage


key: android

description: Configuration that is specific to the Android platform.


key: publishManifestPath

description: The manifest for the Android version of your app will be written to this path during publish.


key: publishBundlePath

description: The bundle for the Android version of your app will be written to this path during publish.


key: package

description: The package name for your Android standalone app. You make it up, but it needs to be unique on the Play Store. See [this StackOverflow question](http://stackoverflow.com/questions/6273892/android-package-name-convention).


key: versionCode

description: Version number required by Google Play. Increment by one for each release. Must be a positive integer. [Learn more](https://developer.android.com/studio/publish/versioning.html)


description: The background color for your Android app, behind any of your React views. Overrides the top-level `backgroundColor` key if it is present.


key: userInterfaceStyle

description: Configuration to force the app to always use the light or dark user-interface appearance, such as "dark mode", or make it automatically adapt to the system preferences. If not provided, defaults to `light`.


key: useNextNotificationsApi

description: @deprecated A Boolean value that indicates whether the app should use the new notifications API.


key: icon

description: Local path or remote URL to an image to use for your app's icon on Android. If specified, this overrides the top-level `icon` key. We recommend that you use a 1024x1024 png file (transparency is recommended for the Google Play Store). This icon will appear on the home screen and within the Expo app.


key: adaptiveIcon

description: Settings for an Adaptive Launcher Icon on Android. [Learn more](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive)


key: foregroundImage

description: Local path or remote URL to an image to use for your app's icon on Android. If specified, this overrides the top-level `icon` and the `android.icon` keys. Should follow the [specified guidelines](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive). This icon will appear on the home screen.


key: backgroundImage

description: Local path or remote URL to a background image for your app's Adaptive Icon on Android. If specified, this overrides the `backgroundColor` key. Must have the same dimensions as  foregroundImage`, and has no effect if `foregroundImage` is not specified. Should follow the [specified guidelines](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive).


description: Color to use as the background for your app's Adaptive Icon on Android. Defaults to white, `#FFFFFF`. Has no effect if `foregroundImage` is not specified.


key: playStoreUrl

description: URL to your app on the Google Play Store, if you have deployed it there. This is used to link to your store page from your Expo project page if your app is public.


key: permissions

description:
List of permissions used by the standalone app.

 To use ONLY the following minimum necessary permissions and none of the extras supported by Expo in a default managed app, set `permissions` to `[]`. The minimum necessary permissions do not require a Privacy Policy when uploading to Google Play Store and are:
• receive data from Internet
• view network connections
• full network access
• change your audio settings
• prevent device from sleeping

 To use ALL permissions supported by Expo by default, do not specify the `permissions` key.

  To use the minimum necessary permissions ALONG with certain additional permissions, specify those extras in `permissions`, e.g.

 `[ "CAMERA", "ACCESS_FINE_LOCATION" ]`.

  You can specify the following permissions depending on what you need:

- `ACCESS_COARSE_LOCATION`
- `ACCESS_FINE_LOCATION`
- `ACCESS_BACKGROUND_LOCATION`
- `CAMERA`
- `RECORD_AUDIO`
- `READ_CONTACTS`
- `WRITE_CONTACTS`
- `READ_CALENDAR`
- `WRITE_CALENDAR`
- `READ_EXTERNAL_STORAGE`
- `WRITE_EXTERNAL_STORAGE`
- `USE_FINGERPRINT`
- `USE_BIOMETRIC`
- `WRITE_SETTINGS`
- `VIBRATE`
- `READ_PHONE_STATE`
- `com.anddoes.launcher.permission.UPDATE_COUNT`
- `com.android.launcher.permission.INSTALL_SHORTCUT`
- `com.google.android.c2dm.permission.RECEIVE`
- `com.google.android.gms.permission.ACTIVITY_RECOGNITION`
- `com.google.android.providers.gsf.permission.READ_GSERVICES`
- `com.htc.launcher.permission.READ_SETTINGS`
- `com.htc.launcher.permission.UPDATE_SHORTCUT`
- `com.majeur.launcher.permission.UPDATE_BADGE`
- `com.sec.android.provider.badge.permission.READ`
- `com.sec.android.provider.badge.permission.WRITE`
- `com.sonyericsson.home.permission.BROADCAST_BADGE`


key: googleServicesFile

description: [Firebase Configuration File](https://support.google.com/firebase/answer/7015592) Location of the `GoogleService-Info.plist` file for configuring Firebase. Including this key automatically enables FCM in your standalone app.


key: config

description: Note: This property key is not included in the production manifest and will evaluate to `undefined`. It is used internally only in the build process, because it contains API keys that some may want to keep private.


key: branch

description: [Branch](https://branch.io/) key to hook up Branch linking services.


key: apiKey

description: Your Branch API key


key: googleMaps

description: [Google Maps Android SDK](https://developers.google.com/maps/documentation/android-api/signup) configuration for your standalone app.


description: Your Google Maps Android SDK API key


key: googleMobileAdsAppId

description: [Google Mobile Ads App ID](https://support.google.com/admob/answer/6232340) Google AdMob App ID.


key: googleMobileAdsAutoInit

description: A boolean indicating whether to initialize Google App Measurement and begin sending user-level event data to Google immediately when the app starts. The default in Expo (Client and in standalone apps) is `false`. [Sets the opposite of the given value to the following key in `Info.plist`](https://developers.google.com/admob/ios/eu-consent#delay_app_measurement_optional)


key: googleSignIn

description: @deprecated Use `googleServicesFile` instead. [Google Sign-In Android SDK](https://developers.google.com/identity/sign-in/android/start-integrating) keys for your standalone app.


description: The Android API key. Can be found in the credentials section of the developer console or in `google-services.json`.


key: certificateHash

description: The SHA-1 hash of the signing certificate used to build the APK without any separator (`:`). Can be found in `google-services.json`. https://developers.google.com/android/guides/client-auth


key: splash

description: Configuration for loading and splash screen for managed and standalone Android apps.


key: backgroundColor

description: Color to fill the loading screen background


key: resizeMode

description: Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover`, `contain` or `native`, defaults to `contain`.


key: image

description: Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png.


key: mdpi

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Natural sized image (baseline)`


key: hdpi

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Scale 1.5x`


key: xhdpi

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Scale 2x`


key: xxhdpi

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Scale 3x`


key: xxxhdpi

description:
Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities)

 `Scale 4x`


key: intentFilters

description: Configuration for setting an array of custom intent filters in Android manifest. [Learn more](https://developer.android.com/guide/components/intents-filters)


key: autoVerify

description: You may also use an intent filter to set your app as the default handler for links (without showing the user a dialog with options). To do so use `true` and then configure your server to serve a JSON file verifying that you own the domain. [Learn more](developer.android.com/training/app-links)


key: scheme

description: the scheme of the URL, e.g. `https`


key: host

description: the hostname, e.g. `myapp.io`


key: port

description: the port, e.g. `3000`


key: path

description: an exact path for URLs that should be matched by the filter, e.g. `/records`


key: pathPattern

description: a regex for paths that should be matched by the filter, e.g. `.*`


key: pathPrefix

description: a prefix for paths that should be matched by the filter, e.g. `/records/` will match `/records/123`


key: mimeType

description: a MIME type for URLs that should be matched by the filter


key: allowBackup

description: Allows your user's app data to be automatically backed up to their Google Drive. If this is set to false, no backup or restore of the application will ever be performed (this is useful if your app deals with sensitive information). Defaults to the Android default, which is `true`.


key: softwareKeyboardLayoutMode

description: Determines how the software keyboard will impact the layout of your application. This maps to the `android:windowSoftInputMode` property. Defaults to `resize`. Valid values: `resize`, `pan`.


key: jsEngine

description: Specifies the JavaScript engine. Supported only on EAS Build. Defaults to `jsc`. Valid values: `hermes`, `jsc`.


key: web

description: Configuration that is specific to the web platform.


key: favicon

description: Relative path of an image to use for your app's favicon.


key: name

description: Defines the title of the document, defaults to the outer level name


key: shortName

description: A short version of the app's name, 12 characters or fewer. Used in app launcher and new tab pages. Maps to `short_name` in the PWA manifest.json. Defaults to the `name` property.


key: lang

description: Specifies the primary language for the values in the name and short_name members. This value is a string containing a single language tag.


key: scope

description: Defines the navigation scope of this website's context. This restricts what web pages can be viewed while the manifest is applied. If the user navigates outside the scope, it returns to a normal web page inside a browser tab/window. If the scope is a relative URL, the base URL will be the URL of the manifest.


key: themeColor

description: Defines the color of the Android tool bar, and may be reflected in the app's preview in task switchers.


key: description

description: Provides a general description of what the pinned website does.


key: dir

description: Specifies the primary text direction for the name, short_name, and description members. Together with the lang member, it helps the correct display of right-to-left languages.


key: display

description: Defines the developers' preferred display mode for the website.


key: startUrl

description: The URL that loads when a user launches the application (e.g., when added to home screen), typically the index. Note: This has to be a relative URL, relative to the manifest URL.


key: orientation

description: Defines the default orientation for all the website's top level browsing contexts.


key: backgroundColor

description: Defines the expected "background color" for the website. This value repeats what is already available in the site's CSS, but can be used by browsers to draw the background color of a shortcut when the manifest is available before the stylesheet has loaded. This creates a smooth transition between launching the web application and loading the site's content.


key: barStyle

description: If content is set to default, the status bar appears normal. If set to black, the status bar has a black background. If set to black-translucent, the status bar is black and translucent. If set to default or black, the web content is displayed below the status bar. If set to black-translucent, the web content is displayed on the entire screen, partially obscured by the status bar.


key: preferRelatedApplications

description: Hints for the user agent to indicate to the user that the specified native applications (defined in expo.ios and expo.android) are recommended over the website.


key: dangerous

description: Experimental features. These will break without deprecation notice.


key: splash

description: Configuration for PWA splash screens.