feat: Add auth test, config management, and interactive setup wizard#42
Merged
joshrotenberg merged 5 commits intomainfrom Aug 28, 2025
Merged
feat: Add auth test, config management, and interactive setup wizard#42joshrotenberg merged 5 commits intomainfrom
joshrotenberg merged 5 commits intomainfrom
Conversation
- Add 'auth test' command to verify credentials for any profile - Add 'auth setup' interactive wizard for easy profile creation - Add 'config show' to display current configuration and active profile - Add 'config path' to show configuration file location - Add 'config validate' to check profile configuration - Improve error messages with actionable suggestions - Support environment variable precedence for authentication - Add colored output and dialoguer for better UX Closes #33
The /account endpoint doesn't exist in Redis Cloud API v1. Using /subscriptions instead which is a documented endpoint that all Cloud accounts should have access to. Fixes authentication testing in the setup wizard.
… testing - Standardized environment variable names to use REDIS_CLOUD_API_SECRET (not REDIS_CLOUD_API_SECRET_KEY) across all modules for consistency - Updated auth.rs, config.rs to use consistent env var names - Enhanced auth test command to support testing credentials from environment variables even when no profiles are configured - Auto-detects deployment type from environment variables when no profile is available Fixes authentication testing with environment variables only.
- Updated README.md Quick Start section to highlight interactive setup wizard - Added new authentication and configuration verification sections - Updated scripts/generate-cli-docs.sh to include auth and config commands - Generated comprehensive CLI documentation for new commands: - auth/README.md, auth/test.md, auth/setup.md - config/README.md, config/show.md, config/path.md, config/validate.md - Updated CLI reference index with new command categories Makes authentication setup as easy as 'aws configure' experience.
- Fixed MD022, MD032, MD047 issues in introduction.md manually - Updated doc generation script to use proper code block syntax (text) - Fixed CLI reference documentation formatting issues - Created comprehensive bug report for mdbook-lint issues - Opened GitHub issue #175 on mdbook-lint repository for: - Configuration rules not being applied - --fix option not working - Improved CLI reference generation with better markdown formatting Most critical linting issues now resolved, remaining are due to mdbook-lint bugs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements comprehensive authentication and configuration management improvements for issue #33, making redisctl as easy to configure as
aws configure.✅ Complete Implementation
All requirements from issue #33 have been fully implemented and tested:
🔐 Authentication Commands
redisctl auth setup- Interactive setup wizard with guided credential inputredisctl auth test- Test authentication for any configurationredisctl auth test --profile mycloud⚙️ Configuration Management Commands
redisctl config show- Display current configuration--show-secretsredisctl config path- Show configuration file location and existenceredisctl config validate- Comprehensive profile validation🛠️ Environment Variable Standardization
REDIS_CLOUD_API_SECRET(notREDIS_CLOUD_API_SECRET_KEY)🎯 API Endpoint Fixes
/accountto documented/subscriptionsendpoint📚 Documentation Updates
/docs/cli-reference/auth/- Authentication command docs/docs/cli-reference/config/- Configuration management docs🚀 User Experience Improvements
Interactive Setup Experience
# One command setup (like aws configure) redisctl auth setupEasy Verification
Better Error Messages
🔧 Technical Implementation
Code Quality
anyhowfor CLI, proper error propagationArchitecture
Backwards Compatibility
📋 Testing & Validation
Manual Testing Completed
Build & Quality Checks
cargo build --release- All binaries compile successfullycargo test --lib --all-features- All tests passingcargo fmt --all -- --check- Code formatting correctcargo clippy --all-targets --all-features -- -D warnings- No linting issues📈 Impact & Benefits
Developer Experience
Operations & CI/CD
redisctl config validatecan be used in CI pipelinesMaintainability
📝 Usage Examples
First-Time Setup
Daily Operations
🎯 Completion Status
All requirements from issue #33 are COMPLETE:
config showand documentationauth setupcommandconfig validateand comprehensive error handlingAdditional improvements delivered:
🔗 Related Issues
Closes #33 - Configuration and authentication UX improvements
🚀 Ready for Production
This PR is ready for review and merge. All functionality has been tested with real Redis Cloud and Enterprise credentials, follows the established codebase patterns, and includes comprehensive documentation.
The authentication setup experience now matches the quality and ease-of-use of tools like
aws configure, achieving the primary goal of issue #33.