New: generated help markdown documentation

.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+---
+
+name: Docs
+
+on:
+  pull_request:
+  push:
+    branches:
+    - master
+
+jobs:
+  docs-help-md:
+    permissions:
+      contents: write
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+          target: x86_64-unknown-linux-gnu
+
+      - name: Generate documentation
+        run: cargo run -- print-help-markdown > /tmp/CommandLineHelp.md
+
+      - name: Compare documentation
+        run: |
+          output=$(diff /tmp/CommandLineHelp.md docs/CommandLineHelp.md)
+          if [ -n "$output" ]; then
+            echo "::error::$output"
+            echo "::error::Documentation is out of date. Please run 'cargo run -- print-help-markdown > docs/CommandLineHelp.md' and commit the changes."
+            exit 1
+          fi

Cargo.toml

@@ -12,16 +12,23 @@ path = "src/main.rs"
 [dependencies]
 anyhow = "1.0.65"
 clap = { version = "4.0.17", features = ["derive", "cargo"] }
+clap-markdown = "0.1.4"
 dirs = "4.0.0"
+futures = "0.3.28"
+glob = "0.3.1"
 hex = "0.4.3"
 http-auth-basic = "0.3.3"
 indicatif = "0.17.2"
 log = { version = "0.4.17", features = ["release_max_level_info", "max_level_debug"] }
 openssl = { version = '0.10', features = ["vendored"] }
 prettytable-rs = "0.10.0"
 protobuf = "3.3.0"
+rayon = "1.7.0"
+regex = "1.9.3"
 reqwest = { version = "0.11.12", features = ["json", "blocking", "multipart"] }
 rpassword = "7.2.0"
+sentry = "0.31.5"
+sentry-anyhow = "0.31.5"
 serde = { version = "1.0.147", features = ["derive"] }
 serde_json = "1.0.87"
 serde_yaml = "0.9.17"
@@ -32,18 +39,12 @@ strum = "0.25"
 strum_macros = "0.25"
 term = "0.7.0"
 thiserror = "1.0.37"
-sentry = "0.31.5"
-sentry-anyhow = "0.31.5"
-rayon = "1.7.0"
-warp = "0.3.5"
 tokio = "1.32.0"
 tokio-stream = "0.1.14"
-regex = "1.9.3"
 walkdir = "2.3.3"
-glob = "0.3.1"
-futures = "0.3.28"
+warp = "0.3.5"
 
 [dev-dependencies]
-httpmock = "0.6"
 envtestkit = "1.1.2"
+httpmock = "0.6"
 tempfile = "3.8"