{
  "schema_version": 2,
  "id": "integrate/redis-data-integration/reference/cli/redis-di-describe",
  "title": "redis-di describe",
  "url": "https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-describe/",
  "summary": "Describes a pipeline with its status",
  "content": "\nDescribes a pipeline, combining its configuration with its runtime status, components, errors, and\nmetrics in a human-readable, sectioned layout. `status` is an alias for this command.\n\nThe RDI version is not shown here, because it is a property of the API connection rather than of the\npipeline; use [`info`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-info)\nto see it.\n\n## Usage\n\n```\nredis-di describe [pipeline] [flags]\n```\n\nThe pipeline name is an optional argument that defaults to `default`.\n\n## Options\n\nThis command takes only the\n[global options](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di#global-options).\n\n## Example\n\n```bash\nredis-di describe\nredis-di status my-pipeline\n```\n\nTo watch the status update live, pair the command with `watch`:\n\n```bash\nwatch -n 1 redis-di describe\n```\n\nThe output has a section for each part of the pipeline, for example:\n\n```\nName:     default\nActive:   yes\nStatus:   started\nCurrent:  yes\n\nSources:\n  Name   Type  Db Type  Connection        Sync Mode  Connected\n  ----   ----  -------  ----------        ---------  ---------\n  mysql  cdc   mysql    ${HOST_IP}:13000  streaming  yes\n\nTargets:\n  Name    Db Type   Connection        Connected\n  ----    -------   ----------        ---------\n  target  redis     ${HOST_IP}:12000  yes\n\nJobs:\n  Name                Source               Transformations  Outputs  Connections\n  ----                ------               ---------------  -------  -----------\n  address_job         inventory.addresses  1                1        target\n  customers_hash_job  inventory.customers  0                1        target\n\nComponents:\n  Name                Type                Version  Status\n  ----                ----                -------  ------\n  collector-api       collector-api       0.0.0    started\n  collector-source    debezium-collector  ...      started\n  processor           processor           0.0.0    started\n\nStatistics:\n  Name                       Total  Pending  Inserted  Updated  Deleted  Filtered  Rejected  Deduplicated  Last Arrival\n  ----                       -----  -------  --------  -------  -------  --------  --------  ------------  ------------\n  {rdi}:inventory.customers  4      0        4         0        0        0         0         0             2026-06-18T13:42:44Z\n```\n",
  "tags": ["redis-di"],
  "last_updated": "2026-09-19T17:55:58-07:00"
}