Better cli documentation

raffomania · Dec 12, 2023 · c931439 · c931439
1 parent 1cf5f2d
commit c931439
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/Justfile b/Justfile
@@ -1,4 +1,4 @@
-run: 
+watch: 
     systemfd --no-pid -s http::4040 -- cargo watch -- cargo run start
 
 ci-dev: 

diff --git a/src/cli.rs b/src/cli.rs
@@ -1,3 +1,5 @@
+use std::net::SocketAddr;
+
 use clap::{Parser, Subcommand};
 
 use crate::server;
@@ -12,7 +14,8 @@ struct Cli {
 enum Command {
     Start {
         #[clap(long)]
-        listen: Option<String>,
+        /// Format: `ip:port`. If omitted, try to obtain a port via the listenfd interface.
+        listen: Option<SocketAddr>,
     },
 }
 

diff --git a/src/server.rs b/src/server.rs
@@ -1,10 +1,12 @@
+use std::net::SocketAddr;
+
 use askama::Template;
 use axum::{debug_handler, routing::get, Router};
 use listenfd::ListenFd;
 use tower_http::trace::TraceLayer;
 use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt, EnvFilter};
 
-pub async fn start(listen_address: Option<String>) {
+pub async fn start(listen_address: Option<SocketAddr>) {
     tracing_subscriber::registry()
         .with(EnvFilter::from(
             "linkblocks=debug,tower_http=debug,axum::rejection=trace",
-Original file line number
+Diff line change
@@ -1,4 +1,4 @@
-    run:
+    watch:
         systemfd --no-pid -s http::4040 -- cargo watch -- cargo run start
     ci-dev:
@@ Expand Down @@