{ "schema_version": 2, "id": "integrate/redis-data-integration/reference/cli/redis-di", "title": "redis-di", "url": "https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di/", "summary": "Command line tool to manage Redis Data Integration", "content": "\n`redis-di` is the command line tool that manages Redis Data Integration (RDI). It is a thin client\nover the RDI API and works the same way for VM, Kubernetes, and Redis Cloud installations. See the\n[CLI reference overview](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli) for an\nintroduction to connecting, authentication, and contexts.\n\n## Usage\n\n```\nredis-di [command]\n```\n\nRun `redis-di help` (or `redis-di --help`) to list every command, and `redis-di help \u003ccommand\u003e`\n(or `redis-di \u003ccommand\u003e --help`) to print the usage, flags, and arguments for a single command.\n\n## Global options\n\nThese options apply to every command. Each one can also be set through an `RDI_`-prefixed environment\nvariable, for example `RDI_API_URL`, `RDI_USER`, or `RDI_PASSWORD`. Setting a secret such as the\npassword through an environment variable keeps it out of your shell history.\n\n| Option | Environment variable | Description |\n| :---------------- | :------------------- | :-------------------------------------------------------------------------------------------------------------- |\n| `--api-url` | `RDI_API_URL` | RDI API base URL. |\n| `--user` | `RDI_USER` | User for API (JWT) authentication. |\n| `--password` | `RDI_PASSWORD` | Password for API (JWT) authentication. Prompted for if a user is set and no password is supplied. |\n| `--account-key` | `RDI_ACCOUNT_KEY` | Redis Cloud account key for API authentication. |\n| `--user-key` | `RDI_USER_KEY` | Redis Cloud user key for API authentication. Prompted for if an account key is set and no user key is supplied. |\n| `--cacert` | `RDI_CACERT` | CA certificate that verifies the API ingress. |\n| `--insecure` | `RDI_INSECURE` | Skip TLS verification of the API ingress (insecure). Mutually exclusive with `--cacert`. |\n| `--context` | `RDI_CONTEXT` | Context to use instead of the active one. |\n| `--log-level` | `RDI_LOG_LEVEL` | Log level: `TRACE`, `DEBUG`, `INFO`, `WARNING`, or `ERROR` (default `INFO`). |\n| `-v`, `--verbose` | | Enable verbose logging, equivalent to `--log-level DEBUG`. |\n| `--version` | | Print the version and build metadata and exit. |\n| `-h`, `--help` | | Print help for the CLI or a command. |\n\n\u003e [!NOTE]\n\u003e Setting both `--user` and `--account-key` is an error, because they select mutually exclusive\n\u003e authentication modes. Setting both `--cacert` and `--insecure` is also an error.\n\n## Commands\n\n| Command | Description |\n| :----------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------- |\n| [`info`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-info) | Displays information about the RDI deployment |\n| [`list`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-list) | Lists all pipelines |\n| [`get`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-get) | Gets a pipeline |\n| [`describe`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-describe) | Describes a pipeline with its status (alias `status`) |\n| [`deploy`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-deploy) | Deploys a pipeline with the specified configuration (alias `set`) |\n| [`delete`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-delete) | Deletes a pipeline |\n| [`start`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-start) | Starts a pipeline |\n| [`stop`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-stop) | Stops a pipeline |\n| [`reset`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-reset) | Resets a pipeline |\n| [`list-secrets`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-list-secrets) | Lists the secrets of a pipeline |\n| [`get-secret`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-get-secret) | Gets a secret of a pipeline |\n| [`describe-secret`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-describe-secret) | Describes a secret of a pipeline |\n| [`set-secret`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-set-secret) | Creates or updates a secret of a pipeline |\n| [`delete-secret`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-delete-secret) | Deletes a secret of a pipeline |\n| [`list-dlqs`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-list-dlqs) | Lists the dead-letter queues of a pipeline |\n| [`get-dlq`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-get-dlq) | Gets a dead-letter queue of a pipeline |\n| [`list-dlq-records`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-list-dlq-records) | Lists the rejected records of a dead-letter queue (alias `get-rejected`) |\n| [`list-jobs`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-list-jobs) | Lists the jobs of a pipeline |\n| [`get-job`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-get-job) | Gets a job of a pipeline |\n| [`describe-job`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-describe-job) | Describes a job of a pipeline |\n| [`list-metric-collections`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-list-metric-collections) | Lists the metric collections of a pipeline |\n| [`get-metric-collection`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-get-metric-collection) | Gets a metric collection of a pipeline |\n| [`scaffold`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-scaffold) | Generates pipeline configuration files |\n| [`list-contexts`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-list-contexts) | Lists all contexts |\n| [`describe-context`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-describe-context) | Describes a context |\n| [`set-context`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-set-context) | Creates or updates a context |\n| [`use-context`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-use-context) | Sets a context to be the active one |\n| [`delete-context`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-delete-context) | Deletes a context |\n| [`completion`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-completion) | Generates a shell autocompletion script |\n\nOn VM installations, the CLI also exposes the\n[`configure-rdi`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-configure-rdi),\n[`dump-support-package`](https://redis.io/docs/latest/integrate/redis-data-integration/1.19.1/reference/cli/redis-di-dump-support-package),\nand `admin` administration commands.\n", "tags": ["redis-di"], "last_updated": "2026-09-19T17:55:58-07:00" }