# Introduction to rpk

> 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: Introduction to rpk
latest-operator-version: v26.1.4
# EOL = End-of-Life (support lifecycle status)
page-is-nearing-eol: "false"
page-is-past-eol: "true"
page-eol-date: April 30, 2025
latest-console-tag: v3.7.3
latest-connect-version: 4.93.0
docname: intro-to-rpk
page-component-name: streaming
page-version: "24.1"
page-component-version: "24.1"
page-component-title: Streaming
page-relative-src-path: intro-to-rpk.adoc
page-edit-url: https://github.com/redpanda-data/docs/edit/v/24.1/modules/get-started/pages/intro-to-rpk.adoc
description: Learn about <code>rpk</code> and how to use it to interact with your Redpanda cluster.
page-git-created-date: "2023-07-24"
page-git-modified-date: "2024-07-24"
support-status: past end-of-life
---

<!-- Source: https://docs.redpanda.com/streaming/24.1/get-started/intro-to-rpk.md -->

The `rpk` command line interface tool is designed to manage your entire Redpanda cluster, without the need to run a separate script for each function, as with Apache Kafka. The `rpk` commands handle everything from configuring brokers to high-level general Redpanda tasks. For example, you can use `rpk` to monitor your cluster’s health, perform tuning, and implement access control lists (ACLs) and other security features. You can also use `rpk` to perform basic streaming tasks, such as creating topics, producing to topics, and consuming from topics.

After you install `rpk`, you can use it to:

-   Manage Redpanda

-   Set up access control lists (ACLs) and other security features

-   Create topics, produce to topics, and consume from topics


See also: [Install rpk](https://docs.redpanda.com/streaming/24.1/get-started/rpk-install/)

## [](#specify-command-properties)Specify command properties

You can specify `rpk` command properties in the following ways:

-   Specify the appropriate flag on the command line.

-   Define the corresponding environment variables.

    Environment variable settings only last for the duration of a shell session.

-   Edit the configuration file settings in the `rpk` section of the `redpanda.yaml` file.

    Configuration file property settings stay the same for each shell session.

-   Edit the configuration file settings in the `rpk.yaml` file.

    Configuration file property settings stay the same for each shell session.


Command line flag settings take precedence over the corresponding environment variables, and environment variables take precedence over configuration file settings. If a required flag is not specified on the command line, Redpanda searches the environment variable. If the environment variable is not set, the value in the `rpk.yaml` configuration file is used, if that file is available, otherwise the value in the `redpanda.yaml` configuration file is used.

> 💡 **TIP**
>
> If you specify `rpk` command properties in the configuration files or as environment variables, you don’t need to specify them again on the command line.

## [](#common-configuration-properties)Common configuration properties

Every `rpk` command supports a set of common configuration properties. You can set one or more options in an `rpk` command by using the `-X` flag:

```bash
rpk -X <config-option-1> -X <config-option-2>
```

Get a list of available options with `-X list`:

```bash
rpk -X list
```

Or, get a detailed description about each option with `-X help`:

```bash
rpk -X help
```

Some of the common configuration properties apply across all `rpk` commands as defaults. These default properties have keys with names starting with `defaults`, and they’re viewable in `rpk -X list` and `rpk -X help`. For more details, see [`rpk -X options`](https://docs.redpanda.com/streaming/24.1/reference/rpk/rpk-x-options/).

## [](#next-steps)Next steps

-   [Install rpk](https://docs.redpanda.com/streaming/24.1/get-started/rpk-install/)

-   [rpk Command reference](https://docs.redpanda.com/streaming/24.1/reference/rpk/)