Skip to content

Commit 9b2a546

Browse files
committed
docs: update README and generate CLI docs for auth/config commands
- 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.
1 parent a098111 commit 9b2a546

File tree

11 files changed

+192
-20
lines changed

11 files changed

+192
-20
lines changed

README.md

Lines changed: 61 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -144,35 +144,76 @@ docker compose down -v
144144

145145
### 1. Configure Authentication
146146

147-
#### Redis Cloud
147+
#### Option 1: Interactive Setup Wizard (Recommended)
148148
```bash
149-
# Using environment variables
150-
export REDIS_CLOUD_API_KEY="your-api-key"
151-
export REDIS_CLOUD_API_SECRET="your-api-secret"
149+
# Launch guided setup for any deployment type
150+
redisctl auth setup
152151

153-
# Or using profiles
154-
redisctl profile set prod-cloud \
155-
--deployment-type cloud \
156-
--api-key YOUR_KEY \
157-
--api-secret YOUR_SECRET
152+
# Test your authentication
153+
redisctl auth test
158154
```
159155

160-
#### Redis Enterprise
156+
The interactive setup wizard will:
157+
- Guide you through credential collection
158+
- Test authentication during setup
159+
- Create and save working profiles
160+
- Set up your first profile as default
161+
162+
#### Option 2: Manual Profile Creation
163+
164+
##### Redis Cloud
161165
```bash
162-
# Using environment variables
166+
# Create a Cloud profile manually
167+
redisctl profile set prod-cloud cloud \
168+
--api-key "your-api-key" \
169+
--api-secret "your-api-secret"
170+
171+
# Set as default profile
172+
redisctl profile default prod-cloud
173+
```
174+
175+
##### Redis Enterprise
176+
```bash
177+
# Create an Enterprise profile manually
178+
redisctl profile set prod-enterprise enterprise \
179+
--url https://cluster:9443 \
180+
--username [email protected] \
181+
--password your-password
182+
```
183+
184+
#### Option 3: Environment Variables
185+
```bash
186+
# Redis Cloud
187+
export REDIS_CLOUD_API_KEY="your-api-key"
188+
export REDIS_CLOUD_API_SECRET="your-api-secret"
189+
190+
# Redis Enterprise
163191
export REDIS_ENTERPRISE_URL="https://cluster.example.com:9443"
164-
export REDIS_ENTERPRISE_USER="[email protected]"
192+
export REDIS_ENTERPRISE_USER="[email protected]"
165193
export REDIS_ENTERPRISE_PASSWORD="your-password"
166194

167-
# Or using profiles
168-
redisctl profile set prod-enterprise \
169-
--deployment-type enterprise \
170-
--url https://cluster:9443 \
171-
--username admin \
172-
--password secret
195+
# Test authentication works
196+
redisctl auth test
197+
```
198+
199+
### 2. Verify Your Setup
200+
201+
```bash
202+
# Test authentication for any profile or environment vars
203+
redisctl auth test
204+
redisctl auth test --profile prod-cloud
205+
206+
# View your configuration
207+
redisctl config show
208+
209+
# Validate all profiles
210+
redisctl config validate
211+
212+
# Find your config file location
213+
redisctl config path
173214
```
174215

175-
### 2. Basic Usage
216+
### 3. Basic Usage
176217

177218
```bash
178219
# List all profiles
@@ -194,7 +235,7 @@ redisctl database list -o json | jq '.[] | .name'
194235
redisctl database list -q "[?status=='active'].name" -o yaml
195236
```
196237

197-
### 3. Common Workflows
238+
### 4. Common Workflows
198239

199240
```bash
200241
# Initialize a new Enterprise cluster

docs/cli-reference/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Commands:
1313
cluster Cluster operations (smart routing)
1414
user User operations (smart routing)
1515
account Account operations (smart routing to Cloud subscriptions)
16+
auth Authentication testing and management
17+
config Configuration management
1618
help Print this message or the help of the given subcommand(s)
1719
1820
Options:

docs/cli-reference/auth/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Authentication Management Commands
2+
3+
```
4+
Authentication testing and management
5+
6+
Usage: redisctl auth <COMMAND>
7+
8+
Commands:
9+
test Test authentication credentials
10+
setup Interactive setup wizard for new profiles
11+
help Print this message or the help of the given subcommand(s)
12+
13+
Options:
14+
-h, --help Print help
15+
```
16+

docs/cli-reference/auth/setup.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Auth Setup Command
2+
3+
```
4+
Interactive setup wizard for new profiles
5+
6+
Usage: redisctl auth setup
7+
8+
Options:
9+
-h, --help Print help
10+
```
11+

docs/cli-reference/auth/test.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Auth Test Command
2+
3+
```
4+
Test authentication credentials
5+
6+
Usage: redisctl auth test [OPTIONS]
7+
8+
Options:
9+
--profile <PROFILE> Profile to test (defaults to current profile)
10+
--deployment <DEPLOYMENT> Test a specific deployment type [possible values: cloud, enterprise]
11+
-h, --help Print help
12+
```
13+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Configuration Management Commands
2+
3+
```
4+
Configuration management
5+
6+
Usage: redisctl config <COMMAND>
7+
8+
Commands:
9+
show Show current configuration and active profile
10+
path Show configuration file path
11+
validate Validate configuration
12+
help Print this message or the help of the given subcommand(s)
13+
14+
Options:
15+
-h, --help Print help
16+
```
17+

docs/cli-reference/config/path.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Config Path Command
2+
3+
```
4+
Show configuration file path
5+
6+
Usage: redisctl config path
7+
8+
Options:
9+
-h, --help Print help
10+
```
11+

docs/cli-reference/config/show.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Config Show Command
2+
3+
```
4+
Show current configuration and active profile
5+
6+
Usage: redisctl config show [OPTIONS]
7+
8+
Options:
9+
--show-secrets Show sensitive values (passwords, API keys)
10+
-h, --help Print help
11+
```
12+
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Config Validate Command
2+
3+
```
4+
Validate configuration
5+
6+
Usage: redisctl config validate [OPTIONS]
7+
8+
Options:
9+
--profile <PROFILE> Profile to validate (defaults to all profiles)
10+
-h, --help Print help
11+
```
12+

docs/cli-reference/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,17 @@ Commands for managing configuration profiles:
4747
- [Remove Profile](profile/remove.md)
4848
- [Set Default](profile/default.md)
4949

50+
### [Authentication Management](auth/README.md)
51+
Commands for testing and setting up authentication:
52+
- [Test Authentication](auth/test.md)
53+
- [Interactive Setup](auth/setup.md)
54+
55+
### [Configuration Management](config/README.md)
56+
Commands for inspecting and validating configuration:
57+
- [Show Configuration](config/show.md)
58+
- [Configuration Path](config/path.md)
59+
- [Validate Configuration](config/validate.md)
60+
5061
### [Smart-Routed Commands](smart/)
5162
Commands that automatically detect deployment type:
5263
- [Database Operations](smart/database.md)

0 commit comments

Comments
 (0)