# rpk shadow describe

> 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 describe
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-describe
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-describe.adoc
page-edit-url: https://github.com/redpanda-data/docs/edit/main/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.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-describe.md -->

Describes a Redpanda shadow link.

This command shows the shadow link configuration, including connection settings, synchronization options, and filters. Use the flags to display specific sections or all sections of the configuration.

By default, the command displays the overview and client configuration sections. Use the flags to display additional sections such as topic synchronization, consumer offset synchronization, and security synchronization settings.

## [](#usage)Usage

```bash
rpk shadow describe [LINK_NAME] [flags]
```

## [](#examples)Examples

Describe a shadow link with default sections (overview and client):

```bash
rpk shadow describe my-shadow-link
```

Display all configuration sections:

```bash
rpk shadow describe my-shadow-link --print-all
```

Display specific sections:

```bash
rpk shadow describe my-shadow-link --print-overview --print-topic
```

Display only the client configuration:

```bash
rpk shadow describe my-shadow-link -c
```

## [](#flags)Flags

| Value | Type | Description |
| --- | --- | --- |
| -a, --print-all | - | Print all sections. |
| -c, --print-client | - | Print the client configuration section. |
| -r, --print-consumer | - | Print the detailed consumer offset configuration section. |
| -o, --print-overview | - | Print the overview section. |
| -s, --print-security | - | Print the detailed security configuration section. |
| -t, --print-topic | - | Print the detailed topic configuration section. |
| -h, --help | - | Help for describe. |
| --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. |