Skip to content

Commit ecd5298

Browse files
joshrotenbergjoshrotenberg
committed
docs: add comprehensive CLI documentation and examples
- Add automated documentation generation script - Generate complete command reference for all CLI commands - Create extensive examples document with common workflows - Document authentication, database ops, clustering, backups, monitoring - Add troubleshooting guide and Docker usage examples - 46 reference docs + comprehensive examples guide
1 parent c42addc commit ecd5298

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1718
-0
lines changed

‎docs/EXAMPLES.md‎

Lines changed: 555 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/cli-reference/README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# redisctl Command Reference
2+
3+
```
4+
Unified Redis CLI for Cloud and Enterprise
5+
6+
Usage: redisctl [OPTIONS] <COMMAND>
7+
8+
Commands:
9+
cloud Redis Cloud commands
10+
enterprise Redis Enterprise commands
11+
profile Profile management
12+
database Database operations (smart routing)
13+
cluster Cluster operations (smart routing)
14+
user User operations (smart routing)
15+
account Account operations (smart routing to Cloud subscriptions)
16+
help Print this message or the help of the given subcommand(s)
17+
18+
Options:
19+
-o, --output <OUTPUT> Output format [default: json] [possible values: json, yaml, table]
20+
-q, --query <QUERY> JMESPath query to filter output
21+
-p, --profile <PROFILE> Profile name to use (overrides REDISCTL_PROFILE env var)
22+
-d, --deployment <DEPLOYMENT> Deployment type (auto-detected from profile if not specified) [possible values: cloud, enterprise]
23+
-v, --verbose... Verbose logging
24+
-h, --help Print help
25+
-V, --version Print version
26+
```
27+

‎docs/cli-reference/cloud/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Redis Cloud Commands
2+
3+
```
4+
Redis Cloud commands
5+
6+
Usage: redisctl cloud <COMMAND>
7+
8+
Commands:
9+
api Raw API access
10+
subscription Subscription management
11+
database Database management
12+
account Account management
13+
user User management
14+
region Region information
15+
task Task monitoring
16+
acl ACL management
17+
peering VPC Peering management
18+
transit-gateway Transit Gateway management
19+
backup Backup management
20+
crdb Active-Active database management
21+
api-key API Keys management
22+
metrics Metrics and monitoring
23+
logs Logs and audit trails
24+
cloud-account Cloud account management
25+
fixed-plan Fixed plan management
26+
flexible-plan Flexible plan management
27+
private-service-connect Private Service Connect
28+
sso SSO/SAML management
29+
billing Billing and payment management
30+
help Print this message or the help of the given subcommand(s)
31+
32+
Options:
33+
-h, --help Print help
34+
```
35+

‎docs/cli-reference/cloud/account.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Cloud Account Commands
2+
3+
```
4+
Account management
5+
6+
Usage: redisctl cloud account <COMMAND>
7+
8+
Commands:
9+
list List accounts/subscriptions
10+
show Show account/subscription details
11+
info Show account information (different from show)
12+
owner Show account owner information
13+
users List users for this account
14+
payment-methods List payment methods
15+
help Print this message or the help of the given subcommand(s)
16+
17+
Options:
18+
-h, --help Print help
19+
```
20+

‎docs/cli-reference/cloud/acl.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Cloud ACL Commands
2+
3+
```
4+
ACL management
5+
6+
Usage: redisctl cloud acl <COMMAND>
7+
8+
Commands:
9+
list List ACL rules
10+
show Show ACL rule details
11+
create Create ACL rule
12+
update Update ACL rule
13+
delete Delete ACL rule
14+
help Print this message or the help of the given subcommand(s)
15+
16+
Options:
17+
-h, --help Print help
18+
```
19+

‎docs/cli-reference/cloud/api-key.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Cloud API Key Commands
2+
3+
```
4+
API Keys management
5+
6+
Usage: redisctl cloud api-key <COMMAND>
7+
8+
Commands:
9+
list List API keys
10+
show Show API key details
11+
create Create API key
12+
update Update API key
13+
delete Delete API key
14+
regenerate Regenerate API key
15+
enable Enable API key
16+
disable Disable API key
17+
help Print this message or the help of the given subcommand(s)
18+
19+
Options:
20+
-h, --help Print help
21+
```
22+

‎docs/cli-reference/cloud/api.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Cloud API Commands
2+
3+
```
4+
Raw API access
5+
6+
Usage: redisctl cloud api <COMMAND>
7+
8+
Commands:
9+
GET Execute GET request
10+
POST Execute POST request
11+
PUT Execute PUT request
12+
PATCH Execute PATCH request
13+
DELETE Execute DELETE request
14+
help Print this message or the help of the given subcommand(s)
15+
16+
Options:
17+
-h, --help Print help
18+
```
19+

‎docs/cli-reference/cloud/backup.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Cloud Backup Commands
2+
3+
```
4+
Backup management
5+
6+
Usage: redisctl cloud backup <COMMAND>
7+
8+
Commands:
9+
list List backups
10+
show Show backup details
11+
create Create backup
12+
restore Restore from backup
13+
delete Delete backup
14+
help Print this message or the help of the given subcommand(s)
15+
16+
Options:
17+
-h, --help Print help
18+
```
19+

‎docs/cli-reference/cloud/billing.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Cloud Billing Commands
2+
3+
```
4+
Billing and payment management
5+
6+
Usage: redisctl cloud billing <COMMAND>
7+
8+
Commands:
9+
info Get billing information
10+
invoice-list List invoices
11+
invoice-get Get invoice details
12+
invoice-download Download invoice PDF
13+
invoice-current Get current month invoice
14+
payment-method-list List payment methods
15+
payment-method-get Get payment method details
16+
payment-method-add Add payment method
17+
payment-method-update Update payment method
18+
payment-method-delete Delete payment method
19+
payment-method-default Set default payment method
20+
cost-breakdown Get cost breakdown
21+
usage Get usage report
22+
history Get billing history
23+
credits Get available credits
24+
promo-apply Apply promo code
25+
alert-list Get billing alerts
26+
alert-update Update billing alerts
27+
help Print this message or the help of the given subcommand(s)
28+
29+
Options:
30+
-h, --help Print help
31+
```
32+

‎docs/cli-reference/cloud/cloud-account.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Cloud Provider Account Commands
2+
3+
```
4+
Cloud account management
5+
6+
Usage: redisctl cloud cloud-account <COMMAND>
7+
8+
Commands:
9+
list List cloud accounts
10+
show Show cloud account details
11+
create Create cloud account
12+
update Update cloud account
13+
delete Delete cloud account
14+
help Print this message or the help of the given subcommand(s)
15+
16+
Options:
17+
-h, --help Print help
18+
```
19+

0 commit comments

Comments
 (0)