frogctl

Operational CLI tool for managing FrogDB.

frogctl [GLOBAL OPTIONS] <COMMAND>

Global Options

Option	Short	Type	Default	Description
--host <HOST>	-H	string	127.0.0.1	Server hostname or IP
--port <PORT>	-p	integer	6379	RESP port
--auth <PASSWORD>	-a	string		Password (AUTH)
--user <USER>	-u	string		ACL username
--tls		flag	false	Enable TLS for RESP connections
--tls-cert <PATH>		path		Client certificate (mTLS)
--tls-key <PATH>		path		Client private key (mTLS)
--tls-ca <PATH>		path		CA certificate
--admin-url <URL>		string		Admin HTTP base URL (e.g. http://127.0.0.1:6380)
--metrics-url <URL>		string		Metrics HTTP base URL (e.g. http://127.0.0.1:9090)
--output <FORMAT>	-o	enum	table	Output format: table, json, raw
--no-color		flag	false	Disable ANSI colors

Commands

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

Examples

# 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

frogdb-server Server command-line options

Commands Reference Redis command documentation

Configuration Reference All configuration options