Dapr CLI reference

• 1: Dapr command line interface (CLI) reference
• 2: annotate CLI command reference
• 3: build-info CLI command reference
• 4: completion CLI command reference
• 5: components CLI command reference
• 6: configurations CLI command reference
• 7: dashboard CLI command reference
• 8: help CLI command reference
• 9: init CLI command reference
• 10: invoke CLI command reference
• 11: list CLI command reference
• 12: logs CLI command reference
• 13: mtls CLI command reference
• 13.1: mtls export CLI command reference
• 13.2: mtls expiry CLI command reference
• 13.3: mtls renew certificate CLI command reference
• 14: publish CLI command reference
• 15: run CLI command reference
• 16: status CLI command reference
• 17: stop CLI command reference
• 18: uninstall CLI command reference
• 19: upgrade CLI command reference
• 20: version CLI command reference

1 - Dapr command line interface (CLI) reference

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 annotate
• dapr build-info
• dapr completion
• dapr components
• dapr configurations
• dapr dashboard
• dapr help
• dapr init
• dapr invoke
• dapr list
• dapr logs
• dapr mtls
• dapr publish
• dapr run
• dapr status
• dapr stop
• dapr uninstall
• dapr upgrade
• dapr version

Environment Variables

Some Dapr flags can be set via environment variables (e.g. DAPR_NETWORK for the --network flag of the dapr init command). Note that specifying the flag on the command line overrides any set environment variable.

2 - annotate CLI command reference

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

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 -

3 - build-info CLI command reference

Description

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

Supported platforms

• Self-Hosted

Usage

dapr build-info

Related facts

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

4 - completion CLI command reference

Description

Generates shell completion scripts

Usage

dapr completion [flags]
dapr completion [command]

Flags

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.

Load the dapr completion code for bash into the current shell:

source <(dapr completion bash)

Write bash completion code to a file and source if from .bash_profile:

dapr completion bash > ~/.dapr/completion.bash.inc
printf "source '$HOME/.dapr/completion.bash.inc'" >> $HOME/.bash_profile
source $HOME/.bash_profile

Installing zsh completion on macOS using homebrew

If zsh-completion is not installed on macOS, please install the ‘zsh-completion’ package:

brew install zsh-completions

Set the dapr completion code for zsh[1] to autoload on startup:

dapr completion zsh > "${fpath[1]}/_dapr"
source ~/.zshrc

Installing zsh completion on Linux

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

Load the dapr completion code for zsh into the current shell:

source <(dapr completion zsh)

Set the dapr completion code for zsh[1] to autoload on startup:

dapr completion zsh > "${fpath[1]}/_dapr"

Installing Powershell completion on Windows

Create $PROFILE if it not exists:

if (!(Test-Path -Path $PROFILE )){ New-Item -Type File -Path $PROFILE -Force }

Add the completion to your profile:

dapr completion powershell >> $PROFILE

Available Commands

bash        Generates bash completion scripts
powershell  Generates powershell completion scripts
zsh         Generates zsh completion scripts

5 - components CLI command reference

Description

List all Dapr components.

Supported platforms

• Kubernetes

Usage

dapr components [flags]

Flags

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.

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:

Dapr root certificate of your Kubernetes cluster expires in <n> days. Expiry date: <date:time> UTC. 
Please see docs.dapr.io for certificate renewal instructions to avoid service interruptions.

6 - configurations CLI command reference

Description

List all Dapr configurations.

Supported platforms

• Kubernetes

Usage

dapr configurations [flags]

Flags

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.

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:

Dapr root certificate of your Kubernetes cluster expires in <n> days. Expiry date: <date:time> UTC. 
Please see docs.dapr.io for certificate renewal instructions to avoid service interruptions.

7 - dashboard CLI command reference

Description

Start Dapr dashboard.

Supported platforms

• Self-Hosted
• Kubernetes

Usage

dapr dashboard [flags]

Flags

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.

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:

Dapr root certificate of your Kubernetes cluster expires in <n> days. Expiry date: <date:time> UTC. 
Please see docs.dapr.io for certificate renewal instructions to avoid service interruptions.

8 - help CLI command reference

Description

Help provides help for any command in the application.

Usage

dapr help [command] [flags]

Flags

9 - init CLI command reference

Description

Install Dapr on supported hosting platforms.

Supported platforms

• Self-Hosted
• Kubernetes

Usage

dapr init [flags]

Flags

Examples

• Self-hosted
• Kubernetes

dapr init

dapr init -s

dapr init --runtime-version 1.13.4

dapr init --image-variant mariner

dapr init --from-dir <path-to-installer-bundle-directory>

dapr init -s --from-dir <path-to-installer-bundle-directory>

dapr init --image-registry docker.io/username

dapr init --container-runtime podman

docker network create mynet

dapr init --network mynet

docker ps 

dapr uninstall --all --network mynet

dapr init -k

dapr init -k --dev

dapr init -k --wait --timeout 600

dapr init -k --runtime-version 1.4.0

dapr init -k --set global.tag=1.0.0 --set dapr_operator.logLevel=error

dapr init -k --image-registry docker.io/username

dapr init -k --image-registry docker.io/username/<directory-name>

10 - invoke CLI command reference

Description

Invoke a method on a given Dapr application.

Supported platforms

• Self-Hosted

Usage

dapr invoke [flags]

Flags

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

11 - list CLI command reference

Description

List all Dapr instances.

Supported platforms

• Self-Hosted
• Kubernetes

Usage

dapr list [flags]

Flags

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.

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:

Dapr root certificate of your Kubernetes cluster expires in <n> days. Expiry date: <date:time> UTC. 
Please see docs.dapr.io for certificate renewal instructions to avoid service interruptions.

12 - logs CLI command reference

Description

Get Dapr sidecar logs for an application.

Supported platforms

• Kubernetes

Usage

dapr logs [flags]

Flags

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.

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:

Dapr root certificate of your Kubernetes cluster expires in <n> days. Expiry date: <date:time> UTC. 
Please see docs.dapr.io for certificate renewal instructions to avoid service interruptions.

13 - mtls CLI command reference

Description

Check if mTLS is enabled.

Supported platforms

• Kubernetes

Usage

dapr mtls [flags]
dapr mtls [command]

Flags

Available Commands

expiry              Checks the expiry of the root Certificate Authority (CA) certificate
export              Export the root Certificate Authority (CA), issuer cert and issuer key to local files
renew-certificate   Rotates the existing root Certificate Authority (CA), issuer cert and issuer key

Command Reference

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

• dapr mtls expiry
• dapr mtls export
• dapr mtls renew-certificate

Examples

# Check if mTLS is enabled on the Kubernetes cluster
dapr mtls -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:

Dapr root certificate of your Kubernetes cluster expires in <n> days. Expiry date: <date:time> UTC. 
Please see docs.dapr.io for certificate renewal instructions to avoid service interruptions.

13.1 - mtls export CLI command reference

Description

Export the root Certificate Authority (CA), issuer cert and issuer key to local files

Supported platforms

• Kubernetes

Usage

dapr mtls export [flags]

Flags

Examples

# Check expiry of Kubernetes certs
dapr mtls export -o ./certs

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:

Dapr root certificate of your Kubernetes cluster expires in <n> days. Expiry date: <date:time> UTC. 
Please see docs.dapr.io for certificate renewal instructions to avoid service interruptions.

13.2 - mtls expiry CLI command reference

Description

Checks the expiry of the root Certificate Authority (CA) certificate

Supported platforms

• Kubernetes

Usage

dapr mtls expiry [flags]

Flags

Examples

# Check expiry of Kubernetes certs
dapr mtls expiry

13.3 - mtls renew certificate CLI command reference

Description

This command can be used to renew expiring Dapr certificates. For example the Dapr Sentry service can generate default root and issuer certificates used by applications. For more information see secure Dapr to Dapr communication

Supported platforms

• Kubernetes

Usage

dapr mtls renew-certificate [flags]

Flags

Examples

Renew certificates by generating brand new certificates

Generates new root and issuer certificates for the Kubernetes cluster with a default validity of 365 days. The certificates are not applied to the Dapr control plane.

dapr mtls renew-certificate -k

Generates new root and issuer certificates for the Kubernetes cluster with a default validity of 365 days and restarts the Dapr control plane services.

dapr mtls renew-certificate -k --restart

Generates new root and issuer certificates for the Kubernetes cluster with a given validity time.

dapr mtls renew-certificate -k --valid-until <no of days>

Generates new root and issuer certificates for the Kubernetes cluster with a given validity time and restarts the Dapr control plane services.

dapr mtls renew-certificate -k --valid-until <no of days> --restart

Renew certificate by using user provided certificates

Rotates certificates for the Kubernetes cluster with the provided ca.pem, issuer.pem and issuer.key file paths and restarts the Dapr control plane services

dapr mtls renew-certificate -k --ca-root-certificate <ca.pem> --issuer-private-key <issuer.key> --issuer-public-certificate <issuer.pem> --restart

Rotates certificates for the Kubernetes cluster with the provided ca.pem, issuer.pem and issuer.key file paths.

dapr mtls renew-certificate -k --ca-root-certificate <ca.pem> --issuer-private-key <issuer.key> --issuer-public-certificate <issuer.pem>

Renew certificates by generating brand new certificates using the provided root private key

Uses existing private root.key to generate new root and issuer certificates for the Kubernetes cluster with a given validity time for created certs.

dapr mtls renew-certificate -k --private-key myprivatekey.key --valid-until <no of days>

Uses the existing private root.key to generate new root and issuer certificates for the Kubernetes cluster.

dapr mtls renew-certificate -k --private-key myprivatekey.key

14 - publish CLI command reference

Description

Publish a pub-sub event.

Supported platforms

• Self-Hosted

Usage

dapr publish [flags]

Flags

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"}'

15 - run CLI command reference

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

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

16 - status CLI command reference

Description

Show the health status of Dapr services.

Supported platforms

• Kubernetes

Usage

dapr status -k

Flags

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:

Dapr root certificate of your Kubernetes cluster expires in <n> days. Expiry date: <date:time> UTC. 
Please see docs.dapr.io for certificate renewal instructions to avoid service interruptions.

17 - stop CLI command reference

Description

Stop Dapr instances and their associated apps.

Supported platforms

• Self-Hosted

Usage

dapr stop [flags]

Flags

Examples

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

18 - uninstall CLI command reference

Description

Uninstall Dapr runtime.

Supported platforms

• Self-Hosted
• Kubernetes

Usage

dapr uninstall [flags]

Flags

Examples

Uninstall from self-hosted mode

dapr uninstall

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

dapr uninstall --all

You can specify a different container runtime while setting up Dapr. If you omit the --container-runtime flag, the default container runtime is Docker.

dapr uninstall --all --container-runtime podman

Uninstall from Kubernetes

dapr uninstall -k

19 - upgrade CLI command reference

Description

Upgrade or downgrade Dapr on supported hosting platforms.

Supported platforms

• Kubernetes

Usage

dapr upgrade [flags]

Flags

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.

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:

Dapr root certificate of your Kubernetes cluster expires in <n> days. Expiry date: <date:time> UTC. 
Please see docs.dapr.io for certificate renewal instructions to avoid service interruptions.

Related links

• Upgrade Dapr on a Kubernetes cluster

20 - version CLI command reference

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

Examples

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

Related facts

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

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