rpk

rpk is the Redpanda CLI and toolbox for managing Redpanda clusters, topics, consumer groups, and streaming pipelines.

Usage

rpk [flags]

Subcommands

Command Description

rpk cloud

Interact with Redpanda Cloud.

rpk cluster

Manage and inspect Redpanda cluster configuration, health, and maintenance operations.

rpk connect

Run and manage Redpanda Connect streaming pipelines. Redpanda Connect is a high-performance stream processor for mundane data engineering tasks.

rpk container

Manage a local Redpanda container cluster for development and testing. Creates containers using Docker or Podman.

rpk debug

Debug the local Redpanda process.

rpk generate

Generate a configuration template for related services.

rpk group

Manage Kafka consumer groups, including listing groups, viewing lag, and resetting offsets.

rpk help

Help provides help for any command in the application. Simply type rpk help [path to command] for full details.

rpk iotune

Measure filesystem performance and create IO configuration file.

rpk plugin

List, download, update, and remove rpk plugins. Plugins augment rpk with new commands.

rpk profile

Manage rpk configuration profiles. Profiles store connection settings for different clusters, making it easy to switch between environments.

rpk redpanda

Interact with a local Redpanda process.

rpk registry

Commands to interact with the schema registry.

rpk security

Manage Redpanda security.

rpk shadow

Manage Redpanda Shadow Links. Shadowing is Redpanda’s enterprise-grade disaster recovery solution that establishes asynchronous, offset-preserving replication between two distinct Redpanda clusters.

rpk topic

Manage Kafka topics, including creating, deleting, and configuring topics. Also includes commands for producing and consuming messages.

rpk transform

Develop, build, deploy, and manage WebAssembly (Wasm) data transforms for Redpanda.

rpk version

Prints the current rpk and Redpanda version. This command prints the current rpk version and allows you to list the Redpanda version running on each node in your cluster.

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.