Dapr CLI reference on Dapr Docs

Dapr command line interface (CLI) reference

Mon, 01 Jan 0001 00:00:00 +0000

The Dapr CLI allows you to setup Dapr on your local dev machine or on a Kubernetes cluster, provides debugging support, and launches and manages Dapr instances.


 __
 ____/ /___ _____ _____
 / __ / __ '/ __ \/ ___/
 / /_/ / /_/ / /_/ / /
 \__,_/\__,_/ .___/_/
 /_/

===============================
Distributed Application Runtime

Usage:
 dapr [command]

Available Commands:
 annotate Add dapr annotations to a Kubernetes configuration. Supported platforms: Kubernetes
 build-info Print build info of Dapr CLI and runtime
 completion Generates shell completion scripts
 components List all Dapr components. Supported platforms: Kubernetes
 configurations List all Dapr configurations. Supported platforms: Kubernetes
 dashboard Start Dapr dashboard. Supported platforms: Kubernetes and self-hosted
 help Help about any command
 init Install Dapr on supported hosting platforms. Supported platforms: Kubernetes and self-hosted
 invoke Invoke a method on a given Dapr application. Supported platforms: Self-hosted
 list List all Dapr instances. Supported platforms: Kubernetes and self-hosted
 logs Get Dapr sidecar logs for an application. Supported platforms: Kubernetes
 mtls Check if mTLS is enabled. Supported platforms: Kubernetes
 publish Publish a pub-sub event. Supported platforms: Self-hosted
 run Run Dapr and (optionally) your application side by side. Supported platforms: Self-hosted
 status Show the health status of Dapr services. Supported platforms: Kubernetes
 stop Stop Dapr instances and their associated apps. Supported platforms: Self-hosted
 uninstall Uninstall Dapr runtime. Supported platforms: Kubernetes and self-hosted
 upgrade Upgrades a Dapr control plane installation in a cluster. Supported platforms: Kubernetes
 version Print the Dapr runtime and CLI version

Flags:
 -h, --help help for dapr
 --log-as-json Log output in JSON format
 -v, --version version for dapr

Use "dapr [command] --help" for more information about a command.

Command Reference

You can learn more about each Dapr command from the links below.

dapr scheduler

Mon, 01 Jan 0001 00:00:00 +0000

dapr scheduler

Manage scheduled jobs and reminders stored in the Dapr Scheduler.

dapr scheduler [command]

Aliases

scheduler
sched

Available Commands

list: List scheduled jobs
get: Get a scheduled job by key
delete: Delete a scheduled job by key
delete-all): Delete all scheduled jobs by key prefix
export: Export all scheduled jobs to a file
import: Import scheduled jobs from a file

Global Flags

annotate CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Add Dapr annotations to a Kubernetes configuration. This enables you to add/change the Dapr annotations on a deployment files. See Kubernetes annotations for a full description of each annotation available in the following list of flags.

Supported platforms

Kubernetes

Usage

dapr annotate [flags] CONFIG-FILE

Flags

Name	Default	Description
`--kubernetes, -k`		Apply annotations to Kubernetes resources. Required
`--api-token-secret`		The secret to use for the API token
`--app-id, -a`		The app id to annotate
`--app-max-concurrency`	`-1`	The maximum number of concurrent requests to allow
`--app-port, -p`	`-1`	The port to expose the app on
`--app-protocol`		The protocol to use for the app: `http` (default), `grpc`, `https`, `grpcs`, `h2c`
`--app-token-secret`		The secret to use for the app token
`--config, -c`		The config file to annotate
`--cpu-limit`		The CPU limit to set for the sidecar. See valid values here.
`--cpu-request`		The CPU request to set for the sidecar. See valid values here.
`--dapr-image`		The image to use for the dapr sidecar container
`--enable-debug`	`false`	Enable debug
`--enable-metrics`	`false`	Enable metrics
`--enable-profile`	`false`	Enable profiling
`--env`		Environment variables to set (key value pairs, comma separated)
`--graceful-shutdown-seconds`	`-1`	The number of seconds to wait for the app to shutdown
`--help, -h`		help for annotate
`--listen-addresses`		The addresses for sidecar to listen on. To listen to all IPv4 addresses, use `0.0.0.0`. To listen to all IPv6 addresses, use `[::]`.
`--liveness-probe-delay`	`-1`	The delay for sidecar to use for the liveness probe. Read more here.
`--liveness-probe-period`	`-1`	The period used by the sidecar for the liveness probe. Read more here.
`--liveness-probe-threshold`	`-1`	The threshold used by the sidecar for the liveness probe. Read more here.
`--liveness-probe-timeout`	`-1`	The timeout used by the sidecar for the liveness probe. Read more here.
`--log-level`		The log level to use
`--max-request-body-size`	`-1`	The maximum request body size to use
`--http-read-buffer-size`	`-1`	The maximum size of HTTP header read buffer in kilobytes
`--memory-limit`		The memory limit to set for the sidecar. See valid values here
`--memory-request`		The memory request to set for the sidecar
`--metrics-port`	`-1`	The port to expose the metrics on
`--namespace, -n`		The namespace the resource target is in (can only be set if `--resource` is also set)
`--readiness-probe-delay`	`-1`	The delay to use for the readiness probe in the sidecar. Read more here.
`--readiness-probe-period`	`-1`	The period to use for the readiness probe in the sidecar. Read more here.
`--readiness-probe-threshold`	`-1`	The threshold to use for the readiness probe in the sidecar. Read more here.
`--readiness-probe-timeout`	`-1`	The timeout to use for the readiness probe in the sidecar. Read more here.
`--resource, -r`		The Kubernetes resource target to annotate
`--enable-api-logging`		Enable API logging for the Dapr sidecar
`--unix-domain-socket-path`		Linux domain socket path to use for communicating with the Dapr sidecar
`--volume-mounts`		List of pod volumes to be mounted to the sidecar container in read-only mode
`--volume-mounts-rw`		List of pod volumes to be mounted to the sidecar container in read-write mode
`--disable-builtin-k8s-secret-store`		Disable the built-in Kubernetes secret store
`--placement-host-address`		Comma separated list of addresses for Dapr actor placement servers

Warning

If an application ID is not provided using --app-id, -a, an ID is generated using the format <namespace>-<kind>-<name>.

Examples

# Annotate the first deployment found in the input
kubectl get deploy -l app=node -o yaml | dapr annotate -k - | kubectl apply -f -

# Annotate multiple deployments by name in a chain
kubectl get deploy -o yaml | dapr annotate -k -r nodeapp - | dapr annotate -k -r pythonapp - | kubectl apply -f -

# Annotate deployment in a specific namespace from file or directory by name
dapr annotate -k -r nodeapp -n namespace mydeploy.yaml | kubectl apply -f -

# Annotate deployment from url by name
dapr annotate -k -r nodeapp --log-level debug https://raw.githubusercontent.com/dapr/quickstarts/master/tutorials/hello-kubernetes/deploy/node.yaml | kubectl apply -f -

build-info CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Get the version and git commit data for dapr and daprd executables.

Supported platforms

Self-Hosted

Usage

dapr build-info

You can get daprd build information directly by invoking daprd --build-info command.

completion CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Generates shell completion scripts

Usage

dapr completion [flags]
dapr completion [command]

Flags

Name	Environment Variable	Default	Description
`--help`, `-h`			Prints this help message

Examples

Installing bash completion on macOS using Homebrew

If running Bash 3.2 included with macOS:

brew install bash-completion

Or, if running Bash 4.1+:

brew install bash-completion@2

Add the completion to your completion directory:

dapr completion bash > $(brew --prefix)/etc/bash_completion.d/dapr
source ~/.bash_profile

Installing bash completion on Linux

If bash-completion is not installed on Linux, please install the bash-completion’ package via your distribution’s package manager.

components CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

List all Dapr components.

Supported platforms

Kubernetes

Usage

dapr components [flags]

Flags

Name	Default	Description
`--kubernetes`, `-k`	`false`	List all Dapr components in a Kubernetes cluster (required)
`--all-namespaces`, `-A`	`true`	If true, list all Dapr components in all namespaces
`--help`, `-h`		Print this help message
`--name`, `-n`		The components name to be printed (optional)
`--namespace`		List all components in the specified namespace
`--output`, `-o`	`list`	Output format (options: json or yaml or list)

Examples

# List Dapr components in all namespaces in Kubernetes mode
dapr components -k

# List Dapr components in specific namespace in Kubernetes mode
dapr components -k --namespace default

# Print specific Dapr component in Kubernetes mode
dapr components -k -n mycomponent

# List Dapr components in all namespaces in Kubernetes mode
dapr components -k --all-namespaces

Warning messages

This command can issue warning messages.

configurations CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

List all Dapr configurations.

Supported platforms

Kubernetes

Usage

dapr configurations [flags]

Flags

Name	Default	Description
`--kubernetes`, `-k`	`false`	List all Dapr configurations in Kubernetes cluster (required).
`--all-namespaces`, `-A`	`true`	If true, list all Dapr configurations in all namespaces (optional)
`--namespace`		List Dapr configurations in specific namespace.
`--name`, `-n`		Print specific Dapr configuration. (optional)
`--output`, `-o`	`list`	Output format (options: json or yaml or list)
`--help`, `-h`		Print this help message

Examples

# List Dapr configurations in all namespaces in Kubernetes mode
dapr configurations -k

# List Dapr configurations in specific namespace in Kubernetes mode
dapr configurations -k --namespace default

# Print specific Dapr configuration in Kubernetes mode
dapr configurations -k -n appconfig

# List Dapr configurations in all namespaces in Kubernetes mode
dapr configurations -k --all-namespaces

Warning messages

This command can issue warning messages.

dashboard CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Start Dapr dashboard.

Supported platforms

Usage

dapr dashboard [flags]

Flags

Name	Default	Description
`--address`, `-a`	`localhost`	Address to listen on. Only accepts IP address or localhost as a value
`--help`, `-h`		Prints this help message
`--kubernetes`, `-k`	`false`	Opens Dapr dashboard in local browser via local proxy to Kubernetes cluster
`--namespace`, `-n`	`dapr-system`	The namespace where Dapr dashboard is running
`--port`, `-p`	`8080`	The local port on which to serve Dapr dashboard
`--version`, `-v`	`false`	Print the version for Dapr dashboard

Examples

# Start dashboard locally
dapr dashboard

# Start dashboard service locally on a specified port
dapr dashboard -p 9999

# Port forward to dashboard service running in Kubernetes
dapr dashboard -k

# Port forward to dashboard service running in Kubernetes on all addresses on a specified port
dapr dashboard -k -p 9999 --address 0.0.0.0

# Port forward to dashboard service running in Kubernetes on a specified port
dapr dashboard -k -p 9999

Warning messages - Kubernetes Mode

This command can issue warning messages.

help CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Help provides help for any command in the application.

Usage

dapr help [command] [flags]

Flags

Name	Environment Variable	Default	Description
`--help`, `-h`			Prints this help message

init CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Install Dapr on supported hosting platforms.

Supported platforms

Usage

dapr init [flags]

Flags

Name	Environment Variable	Default	Description
`--dashboard-version`		`latest`	The version of the Dapr dashboard to install, for example: `1.0.0`
`--enable-ha`		`false`	Enable high availability (HA) mode
`--enable-mtls`		`true`	Enable mTLS in your cluster
`--from-dir`			Path to a local directory containing a downloaded “Dapr Installer Bundle” release which is used to `init` the airgap environment
`--help`, `-h`			Print this help message
`--image-registry`			Pulls container images required by Dapr from the given image registry
`--kubernetes`, `-k`		`false`	Deploy Dapr to a Kubernetes cluster
`--namespace`, `-n`		`dapr-system`	The Kubernetes namespace to install Dapr in
`--network`			The Docker network on which to install and deploy the Dapr runtime
`--runtime-version`		`latest`	The version of the Dapr runtime to install, for example: `1.0.0`
`--image-variant`			The image variant to use for the Dapr runtime, for example: `mariner`
`--set`			Configure options on the command line to be passed to the Dapr Helm chart and the Kubernetes cluster upon install. Can specify multiple values in a comma-separated list, for example: `key1=val1,key2=val2`
`--slim`, `-s`		`false`	Exclude placement service, scheduler service, and the Redis and Zipkin containers from self-hosted installation
`--timeout`		`300`	The wait timeout for the Kubernetes installation
`--wait`		`false`	Wait for Kubernetes initialization to complete
N/A	DAPR_DEFAULT_IMAGE_REGISTRY		It is used to specify the default container registry to pull images from. When its value is set to `GHCR` or `ghcr` it pulls the required images from Github container registry. To default to Docker hub, unset the environment variable or leave it blank
N/A	DAPR_HELM_REPO_URL		Specifies a private Dapr Helm chart url
N/A	DAPR_HELM_REPO_USERNAME	A username for a private Helm chart	The username required to access the private Dapr Helm chart. If it can be accessed publicly, this env variable does not need to be set
N/A	DAPR_HELM_REPO_PASSWORD	A password for a private Helm chart	The password required to access the private Dapr Helm chart. If it can be accessed publicly, this env variable does not need to be set
`--container-runtime`		`docker`	Used to pass in a different container runtime other than Docker. Supported container runtimes are: `docker`, `podman`
`--dev`			Creates Redis and Zipkin deployments when run in Kubernetes.
`--scheduler-volume`			Self-hosted only. Optionally, you can specify a volume for the scheduler service data directory. By default, without this flag, scheduler data is not persisted and not resilient to restarts.
`--scheduler-override-broadcast-host-port`		localhost:50006 (6060 for Windows)	Self-hosted only. Specify the scheduler broadcast host and port, for example: 192.168.42.42:50006.

Examples

Install

invoke CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Invoke a method on a given Dapr application.

Supported platforms

Self-Hosted

Usage

dapr invoke [flags]

Flags

Name	Environment Variable	Default	Description
`--app-id`, `-a`	`APP_ID`		The application id to invoke
`--help`, `-h`			Print this help message
`--method`, `-m`			The method to invoke
`--data`, `-d`			The JSON serialized data string (optional)
`--data-file`, `-f`			A file containing the JSON serialized data (optional)
`--verb`, `-v`		`POST`	The HTTP verb to use

Examples

# Invoke a sample method on target app with POST Verb
dapr invoke --app-id target --method sample --data '{"key":"value"}'

# Invoke a sample method on target app with GET Verb
dapr invoke --app-id target --method sample --verb GET

list CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

List all Dapr instances.

Supported platforms

Usage

dapr list [flags]

Flags

Name	Default	Description
`--all-namespaces`, `-A`	`false`	List all Dapr pods in all namespaces (optional)
`--help`, `-h`		Print this help message
`--kubernetes`, `-k`	`false`	List all Dapr pods in a Kubernetes cluster (optional)
`--namespace`, `-n`	`default`	List the Dapr pods in the defined namespace in Kubernetes. Only with `-k` flag (optional)
`--output`, `-o`	`table`	The output format of the list. Valid values are: `json`, `yaml`, or `table`

Examples

# List Dapr instances in self-hosted mode
dapr list

# List Dapr instances in all namespaces in Kubernetes mode
dapr list -k

# List Dapr instances in JSON format
dapr list -o json

# List Dapr instances in a specific namespace in Kubernetes mode
dapr list -k --namespace default

# List Dapr instances in all namespaces in Kubernetes mode
dapr list -k --all-namespaces

Warning messages - Kubernetes Mode

This command can issue warning messages.

logs CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Get Dapr sidecar logs for an application.

Supported platforms

Kubernetes

Usage

dapr logs [flags]

Flags

Name	Environment Variable	Default	Description
`--app-id`, `-a`	`APP_ID`		The application id for which logs are needed
`--help`, `-h`			Print this help message
`--kubernetes`, `-k`		`true`	Get logs from a Kubernetes cluster
`--namespace`, `-n`		`default`	The Kubernetes namespace in which your application is deployed
`--pod-name`, `-p`			The name of the pod in Kubernetes, in case your application has multiple pods (optional)

Examples

# Get logs of sample app from target pod in custom namespace
dapr logs -k --app-id sample --pod-name target --namespace custom

Warning messages

This command can issue warning messages.

publish CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Publish a pub-sub event.

Supported platforms

Self-Hosted

Usage

dapr publish [flags]

Flags

Name	Default	Description
`--publish-app-id`, `-i`	The ID that represents the app from which you are publishing
`--pubsub`, `-p`	The name of the pub/sub component
`--topic`, `-t`		The topic to be published to
`--data`, `-d`		The JSON serialized string (optional)
`--data-file`, `-f`		A file containing the JSON serialized data (optional)
`--help`, `-h`		Print this help message
`--metadata`, `-m`		A JSON serialized publish metadata (optional)
`--unix-domain-socket`, `-u`		The path to the unix domain socket (optional)

Examples

# Publish to sample topic in target pubsub via a publishing app
dapr publish --publish-app-id appId --topic sample --pubsub target --data '{"key":"value"}'

# Publish to sample topic in target pubsub via a publishing app using Unix domain socket
dapr publish --enable-domain-socket --publish-app-id myapp --pubsub target --topic sample --data '{"key":"value"}'

# Publish to sample topic in target pubsub via a publishing app without cloud event
dapr publish --publish-app-id myapp --pubsub target --topic sample --data '{"key":"value"}' --metadata '{"rawPayload":"true"}'

run CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Run Dapr and (optionally) your application side by side. A full list comparing daprd arguments, CLI arguments, and Kubernetes annotations can be found here.

Supported platforms

Self-Hosted

Usage

dapr run [flags] [command]

Flags

Name	Environment Variable	Default	Description
`--app-id`, `-a`	`APP_ID`		The id for your application, used for service discovery. Cannot contain dots.
`--app-max-concurrency`		`unlimited`	The concurrency level of the application; default is unlimited
`--app-port`, `-p`	`APP_PORT`		The port your application is listening on
`--app-protocol`, `-P`		`http`	The protocol Dapr uses to talk to the application. Valid values are: `http`, `grpc`, `https` (HTTP with TLS), `grpcs` (gRPC with TLS), `h2c` (HTTP/2 Cleartext)
`--resources-path`, `-d`		Linux/Mac: `$HOME/.dapr/components` Windows: `%USERPROFILE%\.dapr\components`	The path for resources directory. If you’ve organized your resources into multiple folders (for example, components in one folder, resiliency policies in another), you can define multiple resource paths. See example below.
`--app-channel-address`		`127.0.0.1`	The network address the application listens on
`--runtime-path`			Dapr runtime install path
`--config`, `-c`		Linux/Mac: `$HOME/.dapr/config.yaml` Windows: `%USERPROFILE%\.dapr\config.yaml`	Dapr configuration file
`--dapr-grpc-port`, `-G`	`DAPR_GRPC_PORT`	`50001`	The gRPC port for Dapr to listen on
`--dapr-internal-grpc-port`, `-I`		`50002`	The gRPC port for the Dapr internal API to listen on. Set during development for apps experiencing temporary errors with service invocation failures due to mDNS caching, or configuring Dapr sidecars behind firewall. Can be any value greater than 1024 and must be different for each app.
`--dapr-http-port`, `-H`	`DAPR_HTTP_PORT`	`3500`	The HTTP port for Dapr to listen on
`--enable-profiling`		`false`	Enable “pprof” profiling via an HTTP endpoint
`--help`, `-h`			Print the help message
`--run-file`, `-f`		Linux/MacOS: `$HOME/.dapr/dapr.yaml`	Run multiple applications at once using a Multi-App Run template file. Currently in alpha and only available in Linux/MacOS
`--image`			Use a custom Docker image. Format is `repository/image` for Docker Hub, or `example.com/repository/image` for a custom registry.
`--log-level`		`info`	The log verbosity. Valid values are: `debug`, `info`, `warn`, `error`, `fatal`, or `panic`
`--enable-api-logging`		`false`	Enable the logging of all API calls from application to Dapr
`--metrics-port`	`DAPR_METRICS_PORT`	`9090`	The port that Dapr sends its metrics information to
`--profile-port`		`7777`	The port for the profile server to listen on
`--placement-host-address`		Linux/Mac: `$HOME/.dapr/components` Windows: `%USERPROFILE%\.dapr\components`	Run in any containers within your Docker network. Uses `<hostname>` or `<hostname>:<port>`. If the port is omitted, it will default to: Linux/MacOS: `50005` Windows: `6050`
`--scheduler-host-address`		Linux/Mac: `$HOME/.dapr/components` Windows: `%USERPROFILE%\.dapr\components`	Run in any containers within your Docker network. Uses `<hostname>` or `<hostname>:<port>`. If the port is omitted, it will default to: Linux/MacOS: `50006` Windows: `6060`
`--enable-app-health-check`		`false`	Enable health checks for the application using the protocol defined with app-protocol
`--app-health-check-path`			Path used for health checks; HTTP only
`--app-health-probe-interval`			Interval to probe for the health of the app in seconds
`--app-health-probe-timeout`			Timeout for app health probes in milliseconds
`--app-health-threshold`			Number of consecutive failures for the app to be considered unhealthy
`--unix-domain-socket`, `-u`			Path to a unix domain socket dir mount. If specified, communication with the Dapr sidecar uses unix domain sockets for lower latency and greater throughput when compared to using TCP ports. Not available on Windows.
`--dapr-http-max-request-size`		`4`	Max size of the request body in MB.
`--dapr-http-read-buffer-size`		`4`	Max size of the HTTP read buffer in KB. This also limits the maximum size of HTTP headers. The default 4 KB
`--kubernetes`, `-k`			Running Dapr on Kubernetes, and used for Multi-App Run template files on Kubernetes.
`--components-path`, `-d`		Linux/Mac: `$HOME/.dapr/components` Windows: `%USERPROFILE%\.dapr\components`	Deprecated in favor of `--resources-path`

Examples

# Run a .NET application
dapr run --app-id myapp --app-port 5000 -- dotnet run

# Run a .Net application with unix domain sockets
dapr run --app-id myapp --app-port 5000 --unix-domain-socket /tmp -- dotnet run

# Run a Java application
dapr run --app-id myapp -- java -jar myapp.jar

# Run a NodeJs application that listens to port 3000
dapr run --app-id myapp --app-port 3000 -- node myapp.js

# Run a Python application
dapr run --app-id myapp -- python myapp.py

# Run sidecar only
dapr run --app-id myapp

# Run a gRPC application written in Go (listening on port 3000)
dapr run --app-id myapp --app-port 5000 --app-protocol grpc -- go run main.go

# Run a NodeJs application that listens to port 3000 with API logging enabled
dapr run --app-id myapp --app-port 3000 --enable-api-logging -- node myapp.js

# Pass multiple resource paths
dapr run --app-id myapp --resources-path path1 --resources-path path2

# Run the multi-app run template file
dapr run -f dapr.yaml

# Run the multi-app run template file on Kubernetes
dapr run -k -f dapr.yaml

status CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Show the health status of Dapr services.

Supported platforms

Kubernetes

Usage

dapr status -k

Flags

Name	Environment Variable	Default	Description
`--help`, `-h`			Print this help message
`--kubernetes`, `-k`		`false`	Show the health status of Dapr services on Kubernetes cluster

Examples

# Get status of Dapr services from Kubernetes
dapr status -k

Warning messages

This command can issue warning messages.

Root certificate renewal warning

If the mtls root certificate deployed to the Kubernetes cluster expires in under 30 days the following warning message is displayed:

stop CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Stop Dapr instances and their associated apps.

Supported platforms

Self-Hosted

Usage

dapr stop [flags]

Flags

Name	Environment Variable	Description
`--app-id`, `-a`	`APP_ID`	The application id to be stopped
`--help`, `-h`		Print this help message
`--run-file`, `-f`		Stop running multiple applications at once using a Multi-App Run template file. Currently in alpha and only available in Linux/MacOS

Examples

# Stop Dapr application
dapr stop --app-id <ID>

uninstall CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Uninstall Dapr runtime.

Supported platforms

Usage

dapr uninstall [flags]

Flags

Name	Default	Description
`--all`	`false`	Remove Redis, Zipkin containers in addition to the Scheduler service and the actor Placement service containers. Remove default Dapr dir located at `$HOME/.dapr or %USERPROFILE%\.dapr\`.
`--help`, `-h`		Print this help message
`--kubernetes`, `-k`	`false`	Uninstall Dapr from a Kubernetes cluster
`--namespace`, `-n`	`dapr-system`	The Kubernetes namespace from which Dapr is uninstalled
`--container-runtime`	`docker`	Used to pass in a different container runtime other than Docker. Supported container runtimes are: `docker`, `podman`

Examples

Uninstall from self-hosted mode

dapr uninstall

You can also use option --all to remove .dapr directory, Redis, Placement, Scheduler, and Zipkin containers

upgrade CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Upgrade or downgrade Dapr on supported hosting platforms.

Warning

Version steps should be done incrementally, including minor versions as you upgrade or downgrade.

Prior to downgrading, confirm components are backwards compatible and application code does ultilize APIs that are not supported in previous versions of Dapr.

Supported platforms

Kubernetes

Usage

dapr upgrade [flags]

Flags

Name	Default	Description
`--help`, `-h`		Print this help message
`--kubernetes`, `-k`	`false`	Upgrade/Downgrade Dapr in a Kubernetes cluster
`--runtime-version`	`latest`	The version of the Dapr runtime to upgrade/downgrade to, for example: `1.0.0`
`--set`		Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
`--image-registry`		Pulls container images required by Dapr from the given image registry

Examples

# Upgrade Dapr in Kubernetes to latest version
dapr upgrade -k

# Upgrade or downgrade to a specified version of Dapr runtime in Kubernetes
dapr upgrade -k --runtime-version 1.2

# Upgrade or downgrade to a specified version of Dapr runtime in Kubernetes with value set
dapr upgrade -k --runtime-version 1.2 --set global.logAsJson=true

# Upgrade or downgrade using private registry, if you are using private registry for hosting dapr images and have used it while doing `dapr init -k`
# Scenario 1 : dapr image hosted directly under root folder in private registry - 
dapr init -k --image-registry docker.io/username
# Scenario 2 : dapr image hosted under a new/different directory in private registry - 
dapr init -k --image-registry docker.io/username/<directory-name>

Warning messages

This command can issue warning messages.

version CLI command reference

Mon, 01 Jan 0001 00:00:00 +0000

Description

Print the version for dapr CLI and daprd executables either in normal or JSON formats.

Supported platforms

Self-Hosted

Usage

dapr version [flags]

Flags

Name	Environment Variable	Default	Description
`--help`, `-h`			Print this help message
`--output`, `-o`			Output format (options: json)

Examples

# Version for Dapr CLI and runtime
dapr version --output json

You can get daprd version directly by invoking daprd --version command.

You can also get the normal version output by running dapr --version flag.

workflow CLI command

Mon, 01 Jan 0001 00:00:00 +0000

Manage Dapr workflow instances.

Commands

Command	Description
dapr workflow run	Start a new workflow instance
dapr workflow list	List workflow instances
dapr workflow history	Get workflow execution history
dapr workflow purge	Purge workflow instances
dapr workflow suspend	Suspend a workflow
dapr workflow resume	Resume a workflow
dapr workflow terminate	Terminate a workflow
dapr workflow raise-event	Raise an external event
dapr workflow rerun	Re-run a workflow

Flags

 -a, --app-id string The app ID owner of the workflow instance
 -h, --help help for workflow
 -k, --kubernetes Target a Kubernetes dapr installation
 -n, --namespace string Namespace to perform workflow operation on (default "default")

Examples

List workflows

dapr workflow list --app-id myapp

Start a workflow

dapr workflow run MyWorkflow --app-id myapp --input '{"key": "value"}'

Kubernetes mode

dapr workflow list -k -n production --app-id myapp

List workflow instances for a given application.

Usage

dapr workflow list [flags]

Flags

Name	Type	Description
`--app-id`, `-a`	string	(Required) The app ID owner of the workflow instances
`--filter-name`, `-w`	string	Filter workflows by name
`--filter-status`, `-s`	string	Filter by status: RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED, PENDING, SUSPENDED
`--filter-max-age`, `-m`	string	Filter workflows started within duration or timestamp (e.g., “300ms”, “1.5h”, “2023-01-02T15:04:05”)
`--output`, `-o`	string	Output format: short, wide, yaml, json (default “short”)
`--kubernetes`, `-k`	bool	Target a Kubernetes Dapr installation
`--namespace`, `-n`	string	Kubernetes namespace (default “default”)

Examples

Basic usage

dapr workflow list --app-id myapp

Filter by status

dapr workflow list --app-id myapp --filter-status RUNNING

Filter by workflow name

dapr workflow list --app-id myapp --filter-name OrderProcessing

Filter by age

# Workflows from last 24 hours
dapr workflow list --app-id myapp --filter-max-age 24h

# Workflows after specific date
dapr workflow list --app-id myapp --filter-max-age 2024-01-01T00:00:00Z

JSON output

dapr workflow list --app-id myapp --output json

Purge workflow instances with terminal states (COMPLETED, FAILED, TERMINATED).

Usage

dapr workflow purge [instance-id] [flags]

Flags

Name	Type	Description
`--app-id`, `-a`	string	(Required) The app ID owner of the workflow instances
`--all`	bool	Purge all terminal workflow instances (use with caution)
`--all-older-than`	string	Purge instances older than duration or timestamp (e.g., “24h”, “2023-01-02T15:04:05Z”)
`--kubernetes`, `-k`	bool	Target a Kubernetes Dapr installation
`--namespace`, `-n`	string	Kubernetes namespace (default “default”)

Examples

Purge a specific instance

dapr workflow purge wf-12345 --app-id myapp

Purge instances older than 30 days

dapr workflow purge --app-id myapp --all-older-than 720h

Purge instances older than specific date

dapr workflow purge --app-id myapp --all-older-than 2023-12-01T00:00:00Z

Purge all terminal instances (dangerous!)

dapr workflow purge --app-id myapp --all

Purge force (no workflow runtime, dangerous!)

dapr workflow purge wf-12345 --app-id myapp --force

Dapr CLI reference on Dapr Docs

Dapr command line interface (CLI) reference

Command Reference

dapr scheduler

dapr scheduler

Aliases

Available Commands

Global Flags

annotate CLI command reference

Description

Supported platforms

Usage

Flags

Warning

Examples

build-info CLI command reference

Description

Supported platforms

Usage

Related facts

completion CLI command reference

Description

Usage

Flags

Examples

Installing bash completion on macOS using Homebrew

Installing bash completion on Linux

components CLI command reference

Description

Supported platforms

Usage

Flags

Examples

Warning messages

configurations CLI command reference

Description

Supported platforms

Usage

Flags

Examples

Warning messages

dashboard CLI command reference

Description

Supported platforms

Usage

Flags

Examples

Warning messages - Kubernetes Mode

help CLI command reference

Description

Usage

Flags

init CLI command reference

Description

Supported platforms

Usage

Flags

Examples

invoke CLI command reference

Description

Supported platforms

Usage

Flags

Examples

list CLI command reference

Description

Supported platforms

Usage

Flags

Examples

Warning messages - Kubernetes Mode

logs CLI command reference

Description

Supported platforms

Usage

Flags

Examples

Warning messages

publish CLI command reference

Description