{
  "id": "redis-di",
  "title": "redis-di",
  "url": "https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di/",
  "summary": "A command line tool to manage & configure Redis Data Integration",
  "tags": [
    "redis-di"
  ],
  "last_updated": "2026-04-01T08:10:08-05:00",
  "page_type": "content",
  "content_hash": "837e4e0123578418412b82c9f1c8a82816f368599b645cd7c8bbaef131e1f483",
  "sections": [
    {
      "id": "usage",
      "title": "Usage",
      "role": "syntax",
      "text": "[code example]"
    },
    {
      "id": "options",
      "title": "Options",
      "role": "parameters",
      "text": "- `version`:\n  - Type: BOOL\n  - Default: `false`\n  - Usage: `--version`\n\n  Show the version and exit.\n\n- `help`:\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 Redis Data Integration\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-rdi         Configures RDI db connection credentials\n  delete-all-contexts   Deletes all contexts\n  delete-context        Deletes a context\n  deploy                Deploys the RDI configurations including target\n  describe-job          Describes a transformation engine's job\n  dump-support-package  Dumps RDI support package\n  get-rejected          Returns all the stored rejected entries\n  install               Installs RDI\n  list-contexts         Lists all saved contexts\n  list-jobs             Lists transformation engine's jobs\n  monitor               Monitors RDI by collecting metrics and exporting...\n  reset                 Resets the pipeline into initial full sync mode\n  scaffold              Generates configuration files for RDI\n  set-context           Sets a context to be the active one\n  set-secret            Creates a secret of a specified key\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 RDI without losing data or downtime",
      "section_id": "cli-help"
    }
  ]
}
