feat: improve CLI help text accuracy and add comprehensive test coverage (#444)

* fix(redis-enterprise): remove non-existent database action methods

Remove three database action methods that call non-existent API endpoints:
- BdbHandler::start() - /v1/bdbs/{uid}/actions/start (404)
- BdbHandler::stop() - /v1/bdbs/{uid}/actions/stop (404)
- BdbHandler::restart() - /v1/bdbs/{uid}/actions/restart (404)

Testing against Docker cluster and comprehensive documentation search of
redis.io REST API docs confirms these endpoints do not exist. The complete
list of documented database action endpoints is:

- stop_traffic / resume_traffic (NOT the same as stop/start)
- export / import / recover
- optimize_shards_placement / rebalance
- backup_reset_status / import_reset_status / export_reset_status

Also removed associated tests and updated documentation to use correct
endpoints (stop_traffic/resume_traffic instead of restart).

Closes #421

* feat(cli): improve profile command clarity with --type flag

BREAKING CHANGE: Changed --deployment flag to --type for profile set command

- Renamed --deployment to --type for better clarity (cloud vs enterprise)
- Added --deployment as a visible alias for backward compatibility
- Updated all help text examples to use --type consistently
- Changed help text from 'Deployment type' to 'Platform type: cloud or enterprise'
- Fixed incorrect examples that showed positional argument syntax

The --type flag more clearly indicates this is selecting between Redis Cloud
and Redis Enterprise platforms, reducing confusion with deployment environments.
The --deployment alias maintains backward compatibility for existing scripts.

* fix(cli): standardize slow-log command help text and add comprehensive tests

- Fixed slow-log description inconsistency ('View' vs 'Get slow query log')
- Added default values (100, 0) for limit/offset in fixed-database slow-log
- Standardized offset description to 'Offset for pagination'
- Changed limit/offset from Option<i32> to i32 with defaults for consistency

Added comprehensive assert_cmd tests to ensure documentation accuracy:
- 14 new tests for profile --type flag and backward compatibility
- 8 new tests for slow-log command consistency
- Updated existing test to check for --type instead of --deployment
- All tests verify help text matches actual command behavior

These tests will catch documentation drift and ensure users can rely on
our help text and examples.

* test(cli): add comprehensive help text coverage for all major commands

Added 36 new help text tests to ensure documentation accuracy:

Files-key commands (4 tests):
- Verify all subcommands have accurate help text
- Covers set, get, remove operations

API command (2 tests):
- Verify examples show correct syntax
- Verify completions command help

Cloud subcommands (13 tests):
- account, subscription, database, user, acl operations
- task, connectivity, fixed-database, fixed-subscription
- workflow operations
- All verify help text matches actual command behavior

Enterprise subcommands (17 tests):
- cluster, database, node, user, role, acl operations
- license, support-package, workflow, crdb operations
- proxy, module management
- Covers most common user-facing commands

Total test count increased from 34 to 70 tests in cli_basic_tests.rs.
This ensures users can rely on --help output being accurate and prevents
documentation drift as commands evolve.

* chore: trigger CI re-run

* fix(clippy): use derive for Default impl on OutputFormat

Rust 1.91 introduced a new lint 'derivable_impls' that flags manual
Default implementations that can be derived. Changed OutputFormat to
use #[derive(Default)] with #[default] attribute on the Json variant.

Fixes CI clippy failure on Rust 1.91.0.

Author: joshrotenberg

crates/redisctl/src/cli.rs

@@ -20,10 +20,10 @@ Redis management CLI for Cloud and Enterprise deployments
 
 EXAMPLES:
     # Set up a Cloud profile
-    redisctl profile set mycloud cloud --api-key KEY --api-secret SECRET
+    redisctl profile set mycloud --type cloud --api-key KEY --api-secret SECRET
 
     # Set up an Enterprise profile
-    redisctl profile set myenterprise enterprise --url https://cluster:9443 --username admin
+    redisctl profile set myenterprise --type enterprise --url https://cluster:9443 --username admin
 
     # List databases
     redisctl cloud database list
@@ -102,7 +102,7 @@ pub enum Commands {
     redisctl api enterprise get /v1/bdbs -o json
 ")]
     Api {
-        /// Deployment type to target
+        /// Platform type (cloud or enterprise)
         #[arg(value_enum)]
         deployment: DeploymentType,
 
@@ -122,10 +122,10 @@ pub enum Commands {
     #[command(subcommand, visible_alias = "prof", visible_alias = "pr")]
     #[command(after_help = "EXAMPLES:
     # Create a Cloud profile
-    redisctl profile set mycloud cloud --api-key KEY --api-secret SECRET
+    redisctl profile set mycloud --type cloud --api-key KEY --api-secret SECRET
 
     # Create an Enterprise profile
-    redisctl profile set myenterprise enterprise --url https://cluster:9443 --username admin
+    redisctl profile set myenterprise --type enterprise --url https://cluster:9443 --username admin
 
     # List all profiles
     redisctl profile list
@@ -242,23 +242,23 @@ pub enum ProfileCommands {
     #[command(visible_alias = "add", visible_alias = "create")]
     #[command(after_help = "EXAMPLES:
     # Create a Cloud profile
-    redisctl profile set mycloud cloud \\
+    redisctl profile set mycloud --type cloud \\
         --api-key A3qcymrvqpn9rrgdt40sv5f9yfxob26vx64hwddh8vminqnkgfq \\
         --api-secret S3s8ecrrnaguqkvwfvealoe3sn25zqs4wc4lwgo4rb0ud3qm77c
 
     # Create an Enterprise profile (password will be prompted)
-    redisctl profile set prod enterprise \\
+    redisctl profile set prod --type enterprise \\
         --url https://cluster.example.com:9443 \\
         --username [email protected]
 
     # Create Enterprise profile with password
-    redisctl profile set staging enterprise \\
+    redisctl profile set staging --type enterprise \\
         --url https://staging:9443 \\
         --username admin \\
         --password mypassword
 
     # Create Enterprise profile allowing insecure connections
-    redisctl profile set local enterprise \\
+    redisctl profile set local --type enterprise \\
         --url https://localhost:9443 \\
         --username [email protected] \\
         --insecure
@@ -267,28 +267,28 @@ pub enum ProfileCommands {
         /// Profile name
         name: String,
 
-        /// Deployment type
-        #[arg(long, value_enum)]
-        deployment: DeploymentType,
+        /// Platform type: 'cloud' for Redis Cloud or 'enterprise' for Redis Enterprise
+        #[arg(long, value_enum, visible_alias = "deployment")]
+        r#type: DeploymentType,
 
         /// API key (for Cloud profiles)
-        #[arg(long, required_if_eq("deployment", "cloud"))]
+        #[arg(long, required_if_eq("type", "cloud"))]
         api_key: Option<String>,
 
         /// API secret (for Cloud profiles)
-        #[arg(long, required_if_eq("deployment", "cloud"))]
+        #[arg(long, required_if_eq("type", "cloud"))]
         api_secret: Option<String>,
 
         /// API URL (for Cloud profiles)
         #[arg(long, default_value = "https://api.redislabs.com/v1")]
         api_url: String,
 
         /// Enterprise URL (for Enterprise profiles)
-        #[arg(long, required_if_eq("deployment", "enterprise"))]
+        #[arg(long, required_if_eq("type", "enterprise"))]
         url: Option<String>,
 
         /// Username (for Enterprise profiles)
-        #[arg(long, required_if_eq("deployment", "enterprise"))]
+        #[arg(long, required_if_eq("type", "enterprise"))]
         username: Option<String>,
 
         /// Password (for Enterprise profiles)
@@ -984,17 +984,17 @@ pub enum CloudFixedDatabaseCommands {
         #[command(flatten)]
         async_ops: crate::commands::cloud::async_utils::AsyncOperationArgs,
     },
-    /// View slow query log
+    /// Get slow query log
     #[command(name = "slow-log")]
     SlowLog {
         /// Database ID (format: subscription_id:database_id)
         id: String,
         /// Maximum number of entries to return
-        #[arg(long)]
-        limit: Option<i32>,
-        /// Number of entries to skip
-        #[arg(long)]
-        offset: Option<i32>,
+        #[arg(long, default_value = "100")]
+        limit: i32,
+        /// Offset for pagination
+        #[arg(long, default_value = "0")]
+        offset: i32,
     },
     /// List tags for fixed database
     #[command(name = "list-tags")]

crates/redisctl/src/commands/profile.rs

@@ -24,7 +24,7 @@ pub async fn handle_profile_command(
         Show { name } => handle_show(conn_mgr, name, output_format).await,
         Set {
             name,
-            deployment,
+            r#type,
             api_key,
             api_secret,
             api_url,
@@ -38,7 +38,7 @@ pub async fn handle_profile_command(
             handle_set(
                 conn_mgr,
                 name,
-                deployment,
+                r#type,
                 api_key,
                 api_secret,
                 api_url,

crates/redisctl/src/output.rs

@@ -6,19 +6,14 @@ use jmespath::compile;
 use serde::Serialize;
 use serde_json::Value;
 
-#[derive(Debug, Clone, Copy, clap::ValueEnum)]
+#[derive(Debug, Clone, Copy, clap::ValueEnum, Default)]
 pub enum OutputFormat {
+    #[default]
     Json,
     Yaml,
     Table,
 }
 
-impl Default for OutputFormat {
-    fn default() -> Self {
-        Self::Json
-    }
-}
-
 impl OutputFormat {
     pub fn is_json(&self) -> bool {
         matches!(self, Self::Json)