From 4c137f85053c07d575d29862cd3f1db837e0a7e1 Mon Sep 17 00:00:00 2001
From: haixuanTao <tao.xavier@outlook.com>
Date: Fri, 17 Mar 2023 20:26:57 +0800
Subject: [PATCH] Add documentation to the cli within the helper mode.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This commit add documentation to the cli. The cli will now show the
following documentation when prompted without arguments:

```bash
(dora3.10) ~/D/C/dora ❯❯❯ dora-cli                                                         (dora3.10) cli-documentation ✭ ✱
dora-rs cli client

Usage: dora-cli <COMMAND>

Commands:
  check    Check if the coordinator and the daemon is running
  graph    Generate a visualization of the given graph using mermaid.js. Use --open to open browser
  build    Run build commands provided in the given dataflow
  new      Generate a new project, node or operator. Choose the language between Rust, Python, C or C++
  up       Spawn a coordinator and a daemon
  destroy  Destroy running coordinator and daemon. If some dataflows are still running, they will be stopped first
  start    Start the given dataflow path. Attach a name to the running dataflow by using --name
  stop     Stop the given dataflow UUID. If no id is provided, you will be able to choose between the running dataflows
  list     List running dataflows
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help information
  -V, --version  Print version information
```
---
 binaries/cli/src/main.rs | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/binaries/cli/src/main.rs b/binaries/cli/src/main.rs
index 0d3bcb43..ead79b8c 100644
--- a/binaries/cli/src/main.rs
+++ b/binaries/cli/src/main.rs
@@ -18,14 +18,17 @@ struct Args {
     command: Command,
 }
 
+/// dora-rs cli client
 #[derive(Debug, clap::Subcommand)]
 enum Command {
+    /// Check if the coordinator and the daemon is running.
     Check {
         #[clap(long)]
         dataflow: Option<PathBuf>,
         #[clap(long)]
         runtime_path: Option<PathBuf>,
     },
+    /// Generate a visualization of the given graph using mermaid.js. Use --open to open browser.
     Graph {
         dataflow: PathBuf,
         #[clap(long, action)]
@@ -33,15 +36,16 @@ enum Command {
         #[clap(long, action)]
         open: bool,
     },
-    Build {
-        dataflow: PathBuf,
-    },
+    /// Run build commands provided in the given dataflow.
+    Build { dataflow: PathBuf },
+    /// Generate a new project, node or operator. Choose the language between Rust, Python, C or C++.
     New {
         #[clap(flatten)]
         args: CommandNew,
         #[clap(hide = true, long)]
         internal_create_with_path_dependencies: bool,
     },
+    /// Spawn a coordinator and a daemon.
     Up {
         #[clap(long)]
         config: Option<PathBuf>,
@@ -50,20 +54,24 @@ enum Command {
         #[clap(long)]
         daemon_path: Option<PathBuf>,
     },
+    /// Destroy running coordinator and daemon. If some dataflows are still running, they will be stopped first.
     Destroy {
         #[clap(long)]
         config: Option<PathBuf>,
     },
+    /// Start the given dataflow path. Attach a name to the running dataflow by using --name.
     Start {
         dataflow: PathBuf,
         #[clap(long)]
         name: Option<String>,
     },
+    /// Stop the given dataflow UUID. If no id is provided, you will be able to choose between the running dataflows.
     Stop {
         uuid: Option<Uuid>,
         #[clap(long)]
         name: Option<String>,
     },
+    /// List running dataflows.
     List,
     // Planned for future releases:
     // Dashboard,