# rpk profile prompt

> 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 profile prompt
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: rpk/rpk-profile/rpk-profile-prompt
page-component-name: streaming
page-version: "24.1"
page-component-version: "24.1"
page-component-title: Streaming
page-relative-src-path: rpk/rpk-profile/rpk-profile-prompt.adoc
page-edit-url: https://github.com/redpanda-data/docs/edit/v/24.1/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc
page-git-created-date: "2023-08-04"
page-git-modified-date: "2024-07-24"
support-status: past end-of-life
---

<!-- Source: https://docs.redpanda.com/streaming/24.1/reference/rpk/rpk-profile/rpk-profile-prompt.md -->

Print a profile name formatted for a PS1 prompt.

This command prints ANSI-escaped text per your current profile’s `prompt` field. If the current profile does not have a prompt, this prints nothing. If the prompt is invalid, this exits `0` with no message. To validate the current prompt, use the `--validate` flag.

This command may introduce other `%` variables in the future. If you want to print a `%` directly, use `%%` to escape it.

> 📝 **NOTE**
>
> -   To use this in `zsh`, be sure to add `setopt PROMPT_SUBST` to your `.zshrc`.
>
> -   To edit your `PS1`, use something like `PS1='$(rpk profile prompt)'` in your shell rc file.

## [](#format)Format

The `prompt` field supports space or comma separated modifiers and a quoted string that is be modified. Inside the string, the variable `%p` or `%n` refers to the profile name. As a few examples:

```text
prompt: hi-white, bg-red, bold, "[%p]"
prompt: hi-red  "PROD"
prompt: white, "dev-%n
```

If you want to have multiple formats, you can wrap each formatted section in parentheses.

```text
prompt: ("--") (hi-white bg-red bold "[%p]")
```

## [](#colors)Colors

All ANSI colors are supported, with names matching the color name: `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`.

The `hi-` prefix indicates a high-intensity color: `hi-black`, `hi-red`, for example. The `bg-` prefix modifies the background color: `bg-black`, `bg-hi-red`, for example.

## [](#modifiers)Modifiers

Four modifiers are supported: "bold", "faint", "underline", and "invert".

## [](#usage)Usage

```bash
rpk profile prompt [flags]
```

## [](#flags)Flags

| Value | Type | Description |
| --- | --- | --- |
| -h, --help | - | Help for prompt. |
| --validate | - | Exit with an error message if the prompt is invalid. |
| --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. |