{
  "id": "redis-di-scaffold",
  "title": "redis-di scaffold",
  "url": "https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-scaffold/",
  "summary": "Generates configuration files for RDI",
  "tags": [
    "redis-di"
  ],
  "last_updated": "2026-04-01T08:10:08-05:00",
  "page_type": "content",
  "content_hash": "98a48ae11aa948d0d9f39b7114a195f17d5523034582125714c1ca8a3d8be81e",
  "sections": [
    {
      "id": "usage",
      "title": "Usage",
      "role": "syntax",
      "text": "[code example]"
    },
    {
      "id": "options",
      "title": "Options",
      "role": "parameters",
      "text": "- `log_level`:\n  - Type: Choice(['TRACE', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'])\n  - Default: `info`\n  - Usage: `--log-level\n-l`\n\n- `db_type` (REQUIRED):\n  - Type: Choice([<DbType.CASSANDRA: 'cassandra'>, <DbType.MARIADB: 'mariadb'>, <DbType.MONGODB: 'mongodb'>, <DbType.MYSQL: 'mysql'>, <DbType.ORACLE: 'oracle'>, <DbType.POSTGRESQL: 'postgresql'>, <DbType.SQLSERVER: 'sqlserver'>, <DbType.SPANNER: 'spanner'>])\n  - Default: `none`\n  - Usage: `--db-type`\n\n  DB type\n\n- `db_flavor`:\n  - Type: Choice([<DbFlavor.MONGODB_ATLAS: 'mongodb-atlas'>, <DbFlavor.MONGODB_REPLICA_SET: 'mongodb-replica-set'>, <DbFlavor.MONGODB_SHARDED_CLUSTER: 'mongodb-sharded-cluster'>])\n  - Default: `none`\n  - Usage: `--db-flavor`\n\n  DB flavor\n\n  Output to directory or stdout\n\n- `directory`:\n  - Type: STRING\n  - Default: `none`\n  - Usage: `--dir`\n\n  Directory containing RDI configuration\n\n- `preview`:\n  - Type: STRING\n  - Default: `none`\n  - Usage: `--preview`\n\n  Print the content of the scaffolded config file to CLI output\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 scaffold [OPTIONS]",
      "section_id": "usage"
    },
    {
      "id": "cli-help-ex0",
      "language": "plaintext",
      "code": "Usage: redis-di scaffold [OPTIONS]\n\n  Generates configuration files for RDI\n\nOptions:\n  -l, --log-level [TRACE|DEBUG|INFO|WARNING|ERROR|CRITICAL]\n                                  [default: INFO]\n  --db-type [cassandra|mariadb|mongodb|mysql|oracle|postgresql|sqlserver|spanner]\n                                  DB type  [required]\n  --db-flavor [mongodb-atlas|mongodb-replica-set|mongodb-sharded-cluster]\n                                  DB flavor\n  Output formats: [mutually_exclusive, required]\n                                  Output to directory or stdout\n    --dir TEXT                    Directory containing RDI configuration\n    --preview TEXT                Print the content of the scaffolded config\n                                  file to CLI output\n  --help                          Show this message and exit.",
      "section_id": "cli-help"
    }
  ]
}