redis-di
Command line tool to manage Redis Data Integration
redis-di is the command line tool that manages Redis Data Integration (RDI). It is a thin client
over the RDI API and works the same way for VM, Kubernetes, and Redis Cloud installations. See the
CLI reference overview for an
introduction to connecting, authentication, and contexts.
Usage
redis-di [command]
Run redis-di help (or redis-di --help) to list every command, and redis-di help <command>
(or redis-di <command> --help) to print the usage, flags, and arguments for a single command.
Global options
These options apply to every command. Each one can also be set through an RDI_-prefixed environment
variable, for example RDI_API_URL, RDI_USER, or RDI_PASSWORD. Setting a secret such as the
password through an environment variable keeps it out of your shell history.
| Option | Environment variable | Description |
|---|---|---|
--api-url |
RDI_API_URL |
RDI API base URL. |
--user |
RDI_USER |
User for API (JWT) authentication. |
--password |
RDI_PASSWORD |
Password for API (JWT) authentication. Prompted for if a user is set and no password is supplied. |
--account-key |
RDI_ACCOUNT_KEY |
Redis Cloud account key for API authentication. |
--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. |
--cacert |
RDI_CACERT |
CA certificate that verifies the API ingress. |
--insecure |
RDI_INSECURE |
Skip TLS verification of the API ingress (insecure). Mutually exclusive with --cacert. |
--context |
RDI_CONTEXT |
Context to use instead of the active one. |
--log-level |
RDI_LOG_LEVEL |
Log level: TRACE, DEBUG, INFO, WARNING, or ERROR (default INFO). |
-v, --verbose |
Enable verbose logging, equivalent to --log-level DEBUG. |
|
--version |
Print the version and build metadata and exit. | |
-h, --help |
Print help for the CLI or a command. |
--user and --account-key is an error, because they select mutually exclusive
authentication modes. Setting both --cacert and --insecure is also an error.Commands
| Command | Description |
|---|---|
info |
Displays information about the RDI deployment |
list |
Lists all pipelines |
get |
Gets a pipeline |
describe |
Describes a pipeline with its status (alias status) |
deploy |
Deploys a pipeline with the specified configuration (alias set) |
delete |
Deletes a pipeline |
start |
Starts a pipeline |
stop |
Stops a pipeline |
reset |
Resets a pipeline |
list-secrets |
Lists the secrets of a pipeline |
get-secret |
Gets a secret of a pipeline |
describe-secret |
Describes a secret of a pipeline |
set-secret |
Creates or updates a secret of a pipeline |
delete-secret |
Deletes a secret of a pipeline |
list-dlqs |
Lists the dead-letter queues of a pipeline |
get-dlq |
Gets a dead-letter queue of a pipeline |
list-dlq-records |
Lists the rejected records of a dead-letter queue (alias get-rejected) |
list-jobs |
Lists the jobs of a pipeline |
get-job |
Gets a job of a pipeline |
describe-job |
Describes a job of a pipeline |
list-metric-collections |
Lists the metric collections of a pipeline |
get-metric-collection |
Gets a metric collection of a pipeline |
scaffold |
Generates pipeline configuration files |
list-contexts |
Lists all contexts |
describe-context |
Describes a context |
set-context |
Creates or updates a context |
use-context |
Sets a context to be the active one |
delete-context |
Deletes a context |
completion |
Generates a shell autocompletion script |
On VM installations, the CLI also exposes the
configure-rdi,
dump-support-package,
and admin administration commands.