Skip to content
FrogDB Logo FrogDB

frogctl

Operational CLI tool for managing FrogDB.

Terminal window
frogctl [GLOBAL OPTIONS] <COMMAND>

Global options

Section titled “Global options”

Generated from GlobalOpts in frogctl/src/cli.rs.

Option Short Type Default Description
--host -H <HOST> 127.0.0.1 Server hostname or IP
--port -p <PORT> 6379 RESP port
--auth -a <AUTH> — Password (AUTH <password>)
--user -u <USER> — ACL username (AUTH <user> <password>)
--tls flag false Enable TLS for RESP connections
--tls-cert <TLS_CERT> — Client certificate path (mTLS)
--tls-key <TLS_KEY> — Client private key path (mTLS)
--tls-ca <TLS_CA> — CA certificate path
--admin-url <ADMIN_URL> — Admin HTTP base URL (e.g. http://127.0.0.1:6380)
--metrics-url <METRICS_URL> — Metrics/observability HTTP base URL (e.g. http://127.0.0.1:9090)
--output -o <OUTPUT> table Output format
--no-color flag false Disable ANSI colors
--help -h flag — Print help
--version -V flag — Print version

Commands

Section titled “Commands”

Generated from the Commands enum in frogctl/src/cli.rs. This is the top-level command list; run frogctl <command> --help for a subcommand’s own flags.

Command Description
health Health checking
stat Real-time monitoring dashboard
config Configuration management
cluster Cluster operations
replication Replication management
debug Diagnostics & debugging
backup Backup & restore
data Data utilities
exec Execute a raw Redis command
acl ACL user management
client Client connection management
scan Scan the keyspace with optional enrichment
watch Stream live commands via MONITOR
subscribe Subscribe to Pub/Sub channels or patterns
search RediSearch operations (FT.* commands)
benchmark Lightweight built-in benchmark
upgrade Rolling upgrade management

Examples

Section titled “Examples”
Terminal window
# Health check
frogctl health


# Real-time stats dashboard
frogctl stat


# Execute a raw command
frogctl exec GET mykey


# Scan keys matching a pattern
frogctl scan --match "user:*"


# Watch live commands
frogctl watch


# Cluster info
frogctl cluster info


# Backup
frogctl backup snapshot


# Output as JSON
frogctl -o json health


# Connect with TLS
frogctl --tls --tls-ca ca.crt health


# Benchmark
frogctl benchmark

See also

Section titled “See also”
frogdb-server Server command-line options
Command matrix Redis command support status
Configuration Reference All configuration options