{
  "id": "redis-di",
  "title": "redis-di",
  "url": "https://redis.io/docs/latest/integrate/write-behind/reference/cli/redis-di/",
  "summary": "A command line tool to manage & configure Write-behind",
  "tags": [
    "docs",
    "integrate",
    "rs",
    "rdi"
  ],
  "last_updated": "2026-04-01T08:10:08-05:00",
  "page_type": "content",
  "content_hash": "fcc3e8c729da2aecb5321b13d6b26a3dd7989198a118d385536803da4269b6ba",
  "sections": [
    {
      "id": "usage",
      "title": "Usage",
      "role": "syntax",
      "text": "[code example]"
    },
    {
      "id": "options",
      "title": "Options",
      "role": "parameters",
      "text": "- `version`:\n\n  - Type: BOOL\n  - Default: `false`\n  - Usage: `--version`\n\n  Show the version and exit.\n\n- `help`:\n\n  - Type: BOOL\n  - Default: `false`\n  - Usage: `--help`\n\n  Show this message and exit."
    },
    {
      "id": "cli-help",
      "title": "CLI help",
      "role": "content",
      "text": "[code example]"
    }
  ],
  "examples": [
    {
      "id": "usage-ex0",
      "language": "plaintext",
      "code": "Usage: redis-di [OPTIONS] COMMAND [ARGS]...",
      "section_id": "usage"
    },
    {
      "id": "cli-help-ex0",
      "language": "plaintext",
      "code": "Usage: redis-di [OPTIONS] COMMAND [ARGS]...\n\n  A command line tool to manage & configure Write-behind\n\nOptions:\n  --version  Show the version and exit.\n  --help     Show this message and exit.\n\nCommands:\n  add-context           Adds a new context\n  configure             Configures the Write-behind Database so it is ready to...\n  create                Creates the Write-behind Database instance\n  delete                Deletes Write-behind database permanently\n  delete-all-contexts   Deletes all contexts\n  delete-context        Deletes a context\n  deploy                Deploys the Write-behind configurations including target\n  describe-job          Describes a transformation engine's job\n  dump-support-package  Dumps Write-behind support package\n  get-rejected          Returns all the stored rejected entries\n  list-contexts         Lists all saved contexts\n  list-jobs             Lists transformation engine's jobs\n  monitor               Monitors Write-behind by collecting metrics and exporting...\n  reset                 Resets the pipeline into initial full sync mode\n  scaffold              Generates configuration files for Write-behind and...\n  set-context           Sets a context to be the active one\n  set-secret            Writes a secret to Redis secret store\n  start                 Starts the pipeline\n  status                Displays the status of the pipeline end to end\n  stop                  Stops the pipeline\n  trace                 Starts a trace session for troubleshooting data...\n  upgrade               Upgrades Write-behind Engine without losing data or downtime",
      "section_id": "cli-help"
    }
  ]
}