Add help text to client CLI options

Author: tpoliaw

Cargo.lock

@@ -20,7 +20,7 @@ async-graphql-axum = "7.0.16"
 axum = "0.8.4"
 axum-extra = { version = "0.10.1", features = ["typed-header"] }
 chrono = "0.4.41"
-clap = { version = "4.5.38", features = ["cargo", "derive", "env", "string"] }
+clap = { version = "4.5.38", features = ["cargo", "derive", "env", "string", "wrap_help"] }
 derive_more = { version = "2.0.1", features = ["error", "display", "from", "deref"] }
 futures = "0.3.31"
 opentelemetry = "0.29.1"

Cargo.toml

@@ -2,6 +2,7 @@ use clap::{Parser, Subcommand};
 use url::Url;
 
 #[derive(Debug, Parser)]
+#[clap(max_term_width = 100)]
 pub struct ClientOptions {
     #[clap(flatten)]
     pub connection: ConnectionOptions,
@@ -11,8 +12,18 @@ pub struct ClientOptions {
 
 #[derive(Debug, Parser)]
 pub struct ConnectionOptions {
+    /// The host address of the numtracker service
+    ///
+    /// This should be the root of the service address including the scheme and
+    /// port (if non-standard) but not including the graphql path,
+    /// eg https://numtracker.example.com
     #[clap(long, short = 'H', env = "NUMTRACKER_SERVICE_HOST")]
     pub host: Option<Url>,
+    /// The host address of the authorisation provider
+    ///
+    /// This should be the domain that has the .well-known/openid-configuration
+    /// endpoint including scheme and port (if non-standard).
+    /// eg https://authn.example.com/realms/master
     #[clap(long, env = "NUMTRACKER_AUTH_HOST")]
     pub auth: Option<Url>,
 }