Radish alpha
h
Radicle Heartwood Protocol & Stack
Radicle
Git (anonymous pull)
Log in to clone via SSH
REVIEW: add to and edit the copy of the args
Fintan Halpenny committed 6 months ago
commit 000964b5d2878e7ddb0ff1ecb6f0902b1260630f
parent 8a9f77acc6c1958333ac54d6cdedb4a4de4ff985
1 file changed +37 -12
modified crates/radicle-cli/src/commands/config/args.rs
@@ -22,22 +22,47 @@ pub(crate) enum Command {
    Show,
    /// Initialize a new config file
    Init {
-
        /// Alias to use for the new config
+
        /// Alias to use for the new configuration
        #[arg(long)]
        alias: Alias,
    },
    /// Open the config in your editor
    Edit,
-
    /// Get a value from the current config
-
    Get { key: String },
-
    /// Show the config schema
+
    /// Get a value from the current configuration
+
    Get {
+
        /// The JSON key path to the value you want to get
+
        key: String,
+
    },
+
    /// Prints the JSON Schema of the Radicle configuration
    Schema,
-
    /// Set a key to a value in the current config
-
    Set { key: String, value: String },
-
    /// Unset a key in the current config
-
    Unset { key: String },
-
    /// Push a value to a key set in the current config
-
    Push { key: String, value: String },
-
    /// Remove a value from a key set in the current config
-
    Remove { key: String, value: String },
+
    /// Set a key to a value in the current configuration
+
    Set {
+
        /// The JSON key path to the value you want to set
+
        key: String,
+
        /// The JSON value used to set the field
+
        value: String,
+
    },
+
    /// Set a key in the current configuration to `null`
+
    Unset {
+
        /// The JSON key path to the value you want to unset
+
        key: String,
+
    },
+
    /// Push a value onto an array, which is identified by the key, in the
+
    /// current configuration
+
    Push {
+
        /// The JSON key path to the array you want to push to
+
        key: String,
+
        /// The JSON value being pushed onto the array
+
        value: String,
+
    },
+
    /// Remove a value from an array, which is identified by the key, in the
+
    /// current configuration
+
    ///
+
    /// All instances of the value in the array will be removed
+
    Remove {
+
        /// The JSON key path to the array you want to push to
+
        key: String,
+
        /// The JSON value being pushed onto the array
+
        value: String,
+
    },
}