# rpk shadow config generate

> For the complete documentation index, see [llms.txt](https://docs.redpanda.com/llms.txt). Component-specific: [streaming-full.txt](https://docs.redpanda.com/streaming-full.txt)

---
title: rpk shadow config generate
latest-redpanda-tag: v26.1.14
latest-console-tag: v3.10.0
latest-operator-version: v26.2.2
# EOL = End-of-Life (support lifecycle status)
page-is-nearing-eol: "false"
page-is-past-eol: "false"
page-eol-date: March 31, 2027
latest-connect-version: 4.105.0
docname: rpk/rpk-shadow/rpk-shadow-config-generate
page-component-name: streaming
page-version: "26.1"
page-component-version: "26.1"
page-component-title: Streaming
page-relative-src-path: rpk/rpk-shadow/rpk-shadow-config-generate.adoc
page-edit-url: https://github.com/redpanda-data/docs/edit/v/26.1/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc
description: Generate a configuration file for creating a Shadow Link. By default, this command creates a sample configuration file with placeholder values that you can customize for your environment.
page-git-created-date: "2025-11-19"
page-git-modified-date: "2026-07-17"
support-status: supported
---

<!-- Source: https://docs.redpanda.com/streaming/26.1/reference/rpk/rpk-shadow/rpk-shadow-config-generate.md -->

Generate a configuration file for creating a Shadow Link.

By default, this command creates a sample configuration file with placeholder values that you can customize for your environment. If you are generating a Shadow Link for Redpanda Cloud, use the `--for-cloud` flag.

Use the `--print-template` flag to generate a configuration template with detailed field documentations.

By default, this command prints the configuration to standard output. Use the `--output` flag to save the configuration to a file.

After you generate the configuration file, update the placeholder values with your actual connection details and settings. Then use `rpk shadow create` to create the Shadow Link.

## [](#usage)Usage

```bash
rpk shadow config generate [flags]
```

## [](#examples)Examples

This section provides examples of how to use `rpk shadow config generate`.

Generate a sample configuration and print it to standard output:

```bash
rpk shadow config generate
```

Generate a configuration template with all the field documentation:

```bash
rpk shadow config generate --print-template
```

Save the sample configuration to a file:

```bash
rpk shadow config generate -o `shadow-link.yaml`
```

Save the template with documentation to a file:

```bash
rpk shadow config generate --print-template -o `shadow-link.yaml`
```

## [](#flags)Flags

| Value | Type | Description |
| --- | --- | --- |
| --for-cloud | bool | Generate configuration suitable for Redpanda Cloud. |
| -o, --output | string | File path to save the generated configuration file. If not specified, prints to standard output. |
| --print-template | bool | Generate a configuration template with field descriptions instead of a sample configuration. |

## [](#global-flags)Global flags

| Value | Type | Description |
| --- | --- | --- |
| --config | string | Redpanda or rpk config file; default search paths are ~/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml. |
| -X, --config-opt | stringArray | Override rpk configuration settings; -X help for detail or -X list for terser detail. |
| --ignore-profile | bool | Ignore rpk.yaml and redpanda.yaml; use default settings. |
| --profile | string | rpk profile to use. |
| -v, --verbose | bool | Enable verbose logging. |

## [](#suggested-reading)Suggested reading

-   [`rpk shadow create`](https://docs.redpanda.com/streaming/26.1/reference/rpk/rpk-shadow/rpk-shadow-create/)