From 198d7c0652965327e6ef5b1c7ae7d056b0da1275 Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Thu, 17 Dec 2020 10:31:16 -0800 Subject: [PATCH] Add CLI changes --- .../content/en/reference/cli/cli-overview.md | 56 +++++++++---------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/daprdocs/content/en/reference/cli/cli-overview.md b/daprdocs/content/en/reference/cli/cli-overview.md index 3b4d1b3a8..38c97bd8f 100644 --- a/daprdocs/content/en/reference/cli/cli-overview.md +++ b/daprdocs/content/en/reference/cli/cli-overview.md @@ -1,47 +1,47 @@ --- type: docs -title: "Dapr command line (CLI) reference" +title: "Dapr command line interface (CLI) reference" linkTitle: "Overview" -description: "Detailed information on the dapr CLI" +description: "Detailed information on the Dapr CLI" weight: 10 --- 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. ```bash - __ + ____/ /___ _____ _____ / __ / __ '/ __ \/ ___/ - / /_/ / /_/ / /_/ / / - \__,_/\__,_/ .___/_/ - /_/ - -====================================================== -A serverless runtime for hyperscale, distributed systems + / /_/ / /_/ / /_/ / / + \__,_/\__,_/ .___/_/ + /_/ + +=============================== +Distributed Application Runtime Usage: dapr [command] Available Commands: - components List all Dapr components - configurations List all Dapr configurations + 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 Setup dapr in Kubernetes or Standalone modes - invoke Invokes a Dapr app with an optional payload (deprecated, use invokePost) - invokeGet Issue HTTP GET to Dapr app - invokePost Issue HTTP POST to Dapr app with an optional payload - list List all Dapr instances - logs Gets Dapr sidecar logs for an app in Kubernetes - mtls Check if mTLS is enabled in a Kubernetes cluster - publish Publish an event to multiple consumers - run Launches Dapr and (optionally) your app side by side - status Shows the Dapr system services (control plane) health status. - stop Stops multiple running Dapr instances and their associated apps - uninstall Removes a Dapr installation + 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 Flags: - -h, --help help for Dapr - --version version for Dapr + -h, --help help for dapr + --version version for dapr Use "dapr [command] --help" for more information about a command. ``` @@ -50,16 +50,16 @@ Use "dapr [command] --help" for more information about a command. You can learn more about each Dapr command from the links below. + - [`dapr completion`]({{< ref dapr-completion.md >}}) - [`dapr components`]({{< ref dapr-components.md >}}) - [`dapr configurations`]({{< ref dapr-configurations.md >}}) + - [`dapr dashboard`]({{< ref dapr-dashboard.md >}}) - [`dapr help`]({{< ref dapr-help.md >}}) - [`dapr init`]({{< ref dapr-init.md >}}) - [`dapr invoke`]({{< ref dapr-invoke.md >}}) - - [`dapr invokeGet`]({{< ref dapr-invokeGet.md >}}) - - [`dapr invokePost`]({{< ref dapr-invokePost.md >}}) - [`dapr list`]({{< ref dapr-list.md >}}) - [`dapr logs`]({{< ref dapr-logs.md >}}) - - [`dapr mtls`]({{< ref dapr-mtls.md >}}) + - [`dapr mtls`]({{< ref dapr-mtls >}}) - [`dapr publish`]({{< ref dapr-publish.md >}}) - [`dapr run`]({{< ref dapr-run.md >}}) - [`dapr status`]({{< ref dapr-status.md >}})