Introduction to rpk
Redpanda Keeper (rpk) is a single binary application that provides a way to interact with your Redpanda clusters from the command line. You can install the rpk binary as a standalone tool. For example, you can use rpk to do the following:
-
Interact with a Redpanda cluster.
-
Run the autotuner tool to optimize the Linux kernel to give you the best performance.
| Redpanda includes rpk as part of the installation. Follow this guide only if you want to install rpk as a standalone tool. |
To install the rpk binary as a standalone application, follow the instructions for your operating system.
Install rpk on Linux
-
Download the
rpkarchive for Linux:curl -LO https://github.com/redpanda-data/redpanda/releases/latest/download/rpk-linux-amd64.zip -
Ensure that you have the folder
~/.local/bin:mkdir -p ~/.local/bin -
Add it to your
$PATH:export PATH="~/.local/bin:$PATH" -
Unzip the
rpkfiles to your~/.local/bin/directory:unzip rpk-linux-amd64.zip -d ~/.local/bin/ -
Run
rpk versionto display the version of the rpk binary:rpk version22.3.11 (rev 9eefb907c)
Install rpk on macOS
-
Homebrew
-
Manual Download
-
If you don’t have Homebrew installed, install it.
-
Install rpk:
brew install redpanda-data/tap/redpanda -
Run
rpk versionto display the version of the rpk binary:rpk version22.3.11 (rev 9eefb907c)
To install rpk through a manual download, choose an option that corresponds to your system architecture. For example, if you have an M1 or M2 chip, use the Apple Silicon instructions.
-
Intel macOS
-
Apple Silicon
-
Download the
rpkarchive for macOS:curl -LO https://github.com/redpanda-data/redpanda/releases/latest/download/rpk-darwin-amd64.zip -
Ensure that you have the folder
~/.local/bin:mkdir -p ~/.local/bin -
Add it to your
$PATH:export PATH=$PATH:~/.local/bin -
Unzip the
rpkfiles to your~/.local/bin/directory:unzip rpk-darwin-amd64.zip -d ~/.local/bin/ -
Run
rpk versionto display the version of the rpk binary:rpk version22.3.11 (rev 9eefb907c)
-
Download the
rpkarchive for macOS:curl -LO https://github.com/redpanda-data/redpanda/releases/latest/download/rpk-darwin-arm64.zip -
Ensure that you have the folder
~/.local/bin:mkdir -p ~/.local/bin -
Add it to your
$PATH:export PATH=$PATH:~/.local/bin -
Unzip the
rpkfiles to your~/.local/bin/directory:unzip rpk-darwin-arm64.zip -d ~/.local/bin/ -
Run
rpk versionto display the version of the rpk binary:rpk version22.3.11 (rev 9eefb907c)
Next steps
For a list of all rpk commands and their syntax, see the rpk documentation.