Getting started with Dapr on Dapr Docs

Install the Dapr CLI

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

You’ll use the Dapr CLI as the main tool for various Dapr-related tasks. You can use it to:

Run an application with a Dapr sidecar.
Review sidecar logs.
List running services.
Run the Dapr dashboard.

The Dapr CLI works with both self-hosted and Kubernetes environments.

Before you begin

In Docker Desktop’s advanced options, verify you’ve allowed the default Docker socket to be used. This option is not available if you are using WSL integration on Windows.

Step 1: Install the Dapr CLI

Install from Terminal

Install the latest Linux Dapr CLI to /usr/local/bin:

Initialize Dapr in your local environment

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

Now that you’ve installed the Dapr CLI, use the CLI to initialize Dapr on your local machine.

Dapr runs as a sidecar alongside your application. In self-hosted mode, this means it is a process on your local machine. By initializing Dapr, you:

Fetch and install the Dapr sidecar binaries locally.
Create a development environment that streamlines application development with Dapr.

Dapr initialization includes:

Running a Redis container instance to be used as a local state store and message broker.
Running a Zipkin container instance for observability.
Creating a default components folder with component definitions for the above.
Running a Dapr placement service container instance for local actor support.
Running a Dapr scheduler service container instance for job scheduling.

Kubernetes Development Environment

To initialize Dapr in your local or remote Kubernetes cluster for development (including the Redis and Zipkin containers listed above), see how to initialize Dapr for development on Kubernetes

Docker

The recommended development environment requires Docker. While you can initialize Dapr without a dependency on Docker, the next steps in this guide assume the recommended Docker development environment.

Use the Dapr API

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

In this guide, you’ll simulate an application by running the sidecar and calling the state management API directly. After running Dapr using the Dapr CLI, you’ll:

Save a state object.
Read/get the state object.
Delete the state object.

Learn more about the state building block and how it works in our concept docs.

Pre-requisites

Step 1: Run the Dapr sidecar

The dapr run command normally runs your application and a Dapr sidecar. In this case, it only runs the sidecar since you are interacting with the state management API directly.