# 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.9
latest-console-tag: v3.7.3
latest-operator-version: v26.1.4
# 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.93.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/main/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc
page-git-created-date: "2025-11-19"
page-git-modified-date: "2025-12-12"
support-status: supported
---

<!-- Source: https://docs.redpanda.com/streaming/current/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 customize for your environment.

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`](https://docs.redpanda.com/streaming/current/reference/rpk/rpk-shadow/rpk-shadow-create/) to create the shadow link.

## [](#usage)Usage

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

## [](#examples)Examples

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 |
| --- | --- | --- |
| -o, --output | string | File path identifying where to save the generated configuration file. If not specified, prints to standard output. |
| --print-template | - | Generate a configuration template with field documentation instead of a sample configuration. |
| -h, --help | - | Help for generate. |
| --config | string | Redpanda or rpk config file; default search paths are /var/lib/redpanda/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml. |
| -X, --config-opt | stringArray | Override rpk configuration settings. See rpk -X or execute rpk -X help for inline detail or rpk -X list for terser detail. |
| --profile | string | Profile to use. See rpk profile for more details. |
| -v, --verbose | - | Enable verbose logging. |