docs/daprdocs/content/en/reference/cli/dapr-dashboard.md

53 lines
1.3 KiB
Markdown

---
type: docs
title: "dashboard CLI command reference"
linkTitle: "dashboard"
description: "Detailed information on the dashboard CLI command"
---
## Description
Start [Dapr dashboard](https://github.com/dapr/dashboard).
## Supported platforms
- [Self-Hosted]({{< ref self-hosted >}})
- [Kubernetes]({{< ref kubernetes >}})
## Usage
```bash
dapr dashboard [flags]
```
## Flags
| Name | Environment Variable | Default | Description |
|------|----------------------|---------|-------------|
| `--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
```bash
dapr dashboard
```
### Start dashboard service locally on a specified port
```bash
dapr dashboard -p 9999
```
### Port forward to dashboard service running in Kubernetes
```bash
dapr dashboard -k
```
### Port forward to dashboard service running in Kubernetes on a specified port
```bash
dapr dashboard -k -p 9999
```