chore: cli docstrings

cli/src/main.rs

@@ -54,28 +54,28 @@ enum Commands {
         /// URL of the UpEnd instance to query.
         #[arg(short, long, default_value = "http://localhost:8093")]
         url: Url,
-        /// The query itself, in L-expression format.
+        /// The query itself, in L-expression format; prefix a filepath by `@=` to insert its hash in its place.
         query: String,
         /// Output format
         #[arg(short, long, default_value = "tsv")]
         format: OutputFormat,
     },
-    /// Insert an entry.
+    /// Insert an entry into an UpEnd server instance.
     Insert {
         /// URL of the UpEnd instance to query.
         #[arg(short, long)]
         url: Option<Url>,
-        /// The address of the entity.
+        /// The address of the entity; prefix a filepath by `@` to insert its hash.
         entity: String,
-        // The attribute.
+        /// The attribute of the entry.
         attribute: String,
-        // The value.
+        /// The value; its type will be heurestically determined.
         value: String,
         /// Output format
         #[arg(short, long, default_value = "tsv")]
         format: OutputFormat,
     },
-    /// Get the address of a file, attribute or URL.
+    /// Get the address of a file, attribute, or URL.
     Address {
         /// Type of input to be addressed
         _type: AddressType,
@@ -91,8 +91,11 @@ enum Commands {
 
 #[derive(Copy, Clone, PartialEq, Eq, Debug, ValueEnum)]
 enum OutputFormat {
+    /// JSON
     Json,
+    /// Tab Separated Values
     Tsv,
+    /// Raw, as received from the server
     Raw,
 }