User-facing guide to create, connect, snapshot, and box Redis boxes quickly.

Quick Start

forkr-redis new my-cache
forkr-redis connect my-cache
You should see “ready to connect” after creation. The connect command will try to open a redis-cli session. When run inside a box, redis-cli -h <box>.<project> should just work.

Create

forkr-redis new my-cache
  • Creates a new Redis box quickly
  • Waits for port readiness, then prints a connect hint
  • Fails if the name already exists

Connect

forkr-redis connect my-cache
  • Uses redis-cli if available
  • When inside a box, direct DNS resolution works
  • From a local machine, DNS/ports may not resolve; forkr-redis will fall back to an in-box redis-cli session when needed
Pass additional redis-cli args after --:
forkr-redis connect my-cache -- --raw PING

Snapshot (Hard)

forkr-redis snapshot my-cache
forkr-redis snapshot my-cache my-snapshot
  • Hard snapshots by default (no stop)
  • Designed for instant boxes and crash-recovery startup

Box

forkr-redis box my-cache my-test-cache
forkr-redis connect my-test-cache
  • Creates a new box from a hard snapshot of my-cache
  • Keeps the source running
  • New instance is ready to connect quickly

Stop (Clean)

forkr-redis stop my-cache
  • Performs a clean stop (SHUTDOWN SAVE)

Defaults

  • Port: 6379
  • Persistence: AOF enabled