Merge pull request #202 from joshrotenberg/docs/comprehensive-update

docs: comprehensive documentation update for async operations

Author: joshrotenberg

CHANGELOG.md

@@ -0,0 +1,78 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+#### Comprehensive Async Operation Support (#175-#201)
+- **Database Operations** - Added `--wait` flag support for all database operations including create, update, delete, import, backup, and migrate commands
+- **Subscription Management** - Full async support for regular and fixed subscription operations with progress tracking
+- **Active-Active Databases** - Complete async operation support for CRDB create, update, and delete operations
+- **Network Connectivity** - Implemented `--wait` flags for:
+  - VPC Peering operations (regular and Active-Active)
+  - Private Service Connect (PSC) operations (regular and Active-Active)
+  - Transit Gateway (TGW) operations including attach/detach (regular and Active-Active)
+- **ACL Management** - Added async support for all 9 ACL commands:
+  - Redis ACL Rules (create, update, delete)
+  - ACL Roles (create, update, delete)
+  - ACL Users (create, update, delete)
+- **User Management** - Added `--wait` flag support for user deletion operations
+- **Provider Accounts** - Full async support for cloud provider account operations (create, update, delete)
+- **Fixed Plans** - Implemented async operations for fixed databases and fixed subscriptions
+
+#### Wait Flag Options
+- `--wait` - Wait for operation to complete with default 600s timeout
+- `--wait-timeout <seconds>` - Configurable timeout duration for long operations
+- `--wait-interval <seconds>` - Customizable polling interval (default: 10s)
+
+### Changed
+
+#### Code Organization Improvements
+- **Parameter Grouping** - Introduced parameter structs to avoid `too_many_arguments` clippy warnings:
+  - `AsyncOperationArgs` for async operation parameters
+  - `ConnectivityOperationParams` for network connectivity operations
+  - `CloudAccountOperationParams` for provider account operations
+  - `AclOperationParams` for ACL management operations
+- **Module Consolidation** - Reorganized connectivity commands under unified module structure
+- **Centralized Async Handling** - All async operations now use the centralized `handle_async_response` function for consistency
+
+### Fixed
+- Fixed clippy warnings for functions with too many arguments
+- Improved error handling for async operations with better context
+- Enhanced progress indicators with animated spinners
+- Fixed task ID extraction from various API response formats
+
+### Documentation
+- Comprehensive README update with all new async operation examples
+- Updated CLAUDE.md with architectural changes and patterns
+- Created FEATURES.md documenting all async operations in detail
+- Added usage examples for all new `--wait` flag operations
+
+## [0.2.0] - Previous Release
+
+### Added
+- Basic Cloud API support
+- Enterprise API support
+- Profile management system
+- Multiple output formats (JSON, YAML, Table)
+- JMESPath query filtering
+
+### Changed
+- Improved error handling
+- Better configuration management
+
+### Fixed
+- Various bug fixes and improvements
+
+## [0.1.0] - Initial Release
+
+### Added
+- Initial implementation
+- Basic command structure
+- Authentication support
+- Raw API access

README.md

@@ -1,94 +1,157 @@
 # redisctl
 
-A unified CLI for Redis Cloud and Redis Enterprise REST APIs.
+A unified CLI for Redis Cloud and Redis Enterprise REST APIs with comprehensive async operation support.
+
+## Features
+
+- 🚀 **Unified Interface** - Single CLI for both Redis Cloud and Redis Enterprise
+- ⏳ **Async Operations** - Full support for long-running operations with `--wait` flags
+- 🔄 **Smart Routing** - Automatically detects which API to use based on context
+- 📊 **Multiple Output Formats** - JSON, YAML, and Table output with JMESPath filtering
+- 🔐 **Secure Configuration** - Profile-based auth with environment variable support
+- 🌐 **Comprehensive Coverage** - Full API coverage for both platforms
+A unified CLI for Redis Cloud and Redis Enterprise REST APIs with comprehensive async operation support.
+
+## Features
+
+- 🚀 **Unified Interface** - Single CLI for both Redis Cloud and Redis Enterprise
+- ⏳ **Async Operations** - Full support for long-running operations with `--wait` flags
+- 🔄 **Smart Routing** - Automatically detects which API to use based on context
+- 📊 **Multiple Output Formats** - JSON, YAML, and Table output with JMESPath filtering
+- 🔐 **Secure Configuration** - Profile-based auth with environment variable support
 
 ## Installation
 
 ```bash
-# Install from source
-cargo install --path crates/redisctl
-
-# Or install from crates.io (coming soon)
+# Install from crates.io
 cargo install redisctl
+
+# Or build from source
+git clone https://github.com/joshrotenberg/redisctl.git
+cd redisctl
+cargo install --path crates/redisctl
 ```
 
-## Quick Configuration
+## Quick Start
+
+### Configure Authentication
 
 Create `~/.config/redisctl/config.toml`:
 
 ```toml
-# Redis Cloud Profile
 [profiles.cloud]
 deployment_type = "cloud"
-api_key = "your-account-key"          # From Redis Cloud console
-api_secret = "your-secret-key"        # Keep this secret!
+api_key = "your-api-key"
+api_secret = "your-secret-key"
 
-# Redis Enterprise Profile  
 [profiles.enterprise]
 deployment_type = "enterprise"
-url = "https://your-cluster:9443"
+url = "https://cluster:9443"
 username = "[email protected]"
 password = "your-password"
-insecure = true                       # For self-signed certificates
 
-# Set your default
 default_profile = "cloud"
 ```
 
 Or use environment variables:
 
 ```bash
-# For Redis Cloud
+# Redis Cloud
 export REDIS_CLOUD_API_KEY="your-key"
 export REDIS_CLOUD_API_SECRET="your-secret"
 
-# For Redis Enterprise
+# Redis Enterprise
 export REDIS_ENTERPRISE_URL="https://cluster:9443"
 export REDIS_ENTERPRISE_USER="[email protected]"
 export REDIS_ENTERPRISE_PASSWORD="your-password"
 ```
 
-## Basic Usage
+### Basic Usage
+
+### Database Operations
 
 ```bash
 # List databases
 redisctl database list
 
-# Get specific database
-redisctl database get 12345
+# Create database with async wait
+redisctl cloud database create --data @database.json --wait
 
-# Direct API access
-redisctl api cloud get /subscriptions
-redisctl api enterprise get /v1/cluster
+# Create database with async wait
+redisctl cloud database create
+# UpdateDifferent output
+redisctl Deletedatabaselist-o yaml | yq '.[] | select(.name == "prod")' database with force and wait
+redisctl cloud database delete 12345 --force --wait
+```
 
-# Output formats
+## Output Formats
+
+```bash
+# JSON output (default)
 redisctl database list -o json
+
+# YAML output
 redisctl database list -o yaml
+
+# Human-readable table
 redisctl database list -o table
 
 # Filter with JMESPath
-redisctl database list -q "[?status=='active'].name"
+redisctl database list -q "[?status=='active'].{name: name, memory: memoryLimitInGb}"
+
+# Combine with jq for advanced processing
+redisctl database list -o json | jq '.[] | select(.name | contains("prod"))'
 ```
 
-## Command Structure
+## Profile Management
 
+```bash
+# List all profiles
+redisctl profile list
+
+# Set default profile
+redisctl profile default cloud-prod
+
+# Get specific profile settings
+redisctl profile get enterprise-dev
+
+# Set profile values
+redisctl profile set cloud-staging api_key "new-key"
+redisctl profile set cloud-staging api_secret "new-secret"
+
+# Remove profile
+redisctl profile remove old-profile
+
+# Use specific profile for a command
+redisctl database list --profile cloud-staging
 ```
-redisctl
-├── api          # Raw API access (any endpoint)
-├── cloud        # Cloud-specific commands
-├── enterprise   # Enterprise-specific commands
-├── database     # Smart commands (work with both)
-└── profile      # Manage configuration profiles
-```
+
+## Environment Variables
+
+### Cloud Configuration
+- `REDIS_CLOUD_API_KEY` - API key for authentication
+- `REDIS_CLOUD_API_SECRET` - API secret for authentication
+- `REDIS_CLOUD_API_URL` - Custom API URL (optional)
+
+### Enterprise Configuration
+- `REDIS_ENTERPRISE_URL` - Cluster API URL
+- `REDIS_ENTERPRISE_USER` - Username for authentication
+- `REDIS_ENTERPRISE_PASSWORD` - Password for authentication
+- `REDIS_ENTERPRISE_INSECURE` - Allow insecure TLS (true/false)
+
+### General Configuration
+- `REDISCTL_PROFILE` - Default profile to use
+- `RUST_LOG` - Logging level (error, warn, info, debug, trace)
 
 ## Documentation
 
-For comprehensive documentation, see the [User Guide](https://docs.rs/redisctl).
+For comprehensive documentation, see the [mdBook documentation](docs/):
 
-- **Getting Started** - Installation, configuration, first commands
-- **Redis Cloud** - Cloud-specific operations and API reference
-- **Redis Enterprise** - Enterprise-specific operations and API reference
-- **Examples** - Common use cases and patterns
+- [Getting Started](docs/src/getting-started/index.md) - Installation and configuration
+- [CLI Reference](docs/src/cli-reference/index.md) - Complete command reference
+- [Async Operations](docs/src/features/async-operations.md) - Using `--wait` flags  
+- [Examples](docs/src/examples/index.md) - Common use cases and patterns
+- **API Reference** - Complete command reference
 
 ## Development
 
@@ -100,6 +163,8 @@ redis-cloud = "0.2"       # Redis Cloud API client
 redis-enterprise = "0.2"  # Redis Enterprise API client
 ```
 
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines.
+
 ## License
 
-MIT
+This project is licensed under the MIT License - see [LICENSE](LICENSE) file for details.

docs/src/SUMMARY.md

@@ -8,6 +8,17 @@
 - [Configuration](./getting-started/configuration.md)
 - [Quick Start](./getting-started/quickstart.md)
 
+# Features
+
+- [Async Operations](./features/async-operations.md)
+  - [Database Operations](./features/database-operations.md)
+  - [Subscription Management](./features/subscription-management.md)
+  - [Network Connectivity](./features/network-connectivity.md)
+  - [ACL Management](./features/acl-management.md)
+  - [User & Account Management](./features/user-management.md)
+- [Output Formats](./features/output-formats.md)
+- [Profile Management](./features/profiles.md)
+
 # Redis Cloud
 
 - [Overview](./cloud/overview.md)
@@ -26,15 +37,24 @@
   - [Workflows (Coming Soon)]()
 - [Examples](./enterprise/examples.md)
 
+# CLI Reference
+
+- [Global Options](./cli-reference/global-options.md)
+- [Cloud Commands](./cli-reference/cloud-commands.md)
+- [Enterprise Commands](./cli-reference/enterprise-commands.md)
+- [Smart Commands](./cli-reference/smart-commands.md)
+- [Profile Commands](./cli-reference/profile-commands.md)
+
 # Reference
 
 - [Environment Variables](./reference/environment-variables.md)
 - [Configuration File](./reference/config-file.md)
-- [Output Formats](./reference/output-formats.md)
 - [Troubleshooting](./reference/troubleshooting.md)
+- [Best Practices](./reference/best-practices.md)
 
 # Developer Guide
 
 - [Architecture](./developer/architecture.md)
 - [Using the Libraries](./developer/libraries.md)
-- [Contributing](./developer/contributing.md)
+- [Contributing](./developer/contributing.md)
+- [Adding Commands](./developer/adding-commands.md)