Install the Dapr CLI

The Dapr CLI is the main tool you’ll be using for various Dapr related tasks. You can use it to run an application with a Dapr sidecar, as well as review sidecar logs, list running services, and run the Dapr dashboard. The Dapr CLI works with both self-hosted and Kubernetes environments.

Begin by downloading and installing the Dapr CLI:

This command installs the latest linux Dapr CLI to /usr/local/bin:

wget -q https://raw.githubusercontent.com/dapr/cli/master/install/install.sh -O - | /bin/bash

This Command Prompt command installs the latest windows Dapr cli to C:\dapr and adds this directory to User PATH environment variable.

powershell -Command "iwr -useb https://raw.githubusercontent.com/dapr/cli/master/install/install.ps1 | iex"

This command installs the latest darwin Dapr CLI to /usr/local/bin:

curl -fsSL https://raw.githubusercontent.com/dapr/cli/master/install/install.sh | /bin/bash

Or you can install via Homebrew:

brew install dapr/tap/dapr-cli

Note for M1 Macs

For M1 Macs, homebrew is not supported. You will need to use the dapr install script and have the rosetta amd64 compatibility layer installed. If you do not have it installed already, you can run the following:

softwareupdate --install-rosetta

Each release of Dapr CLI includes various OSes and architectures. These binary versions can be manually downloaded and installed.

Download the desired Dapr CLI from the latest Dapr Release
Unpack it (e.g. dapr_linux_amd64.tar.gz, dapr_windows_amd64.zip)
Move it to your desired location.
- For Linux/MacOS - /usr/local/bin
- For Windows, create a directory and add this to your System PATH. For example create a directory called C:\dapr and add this directory to your User PATH, by editing your system environment variable.

Step 2: Verify the installation

You can verify the CLI is installed by restarting your terminal/command prompt and running the following:

dapr

The output should look like this:

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

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

Usage:
  dapr [command]

Available Commands:
  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

Flags:
  -h, --help      help for dapr
  -v, --version   version for dapr

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

Next step: Initialize Dapr >>

Last modified May 22, 2021: docs: clean up white noise (#1491) (fe1ab8eb)