Docs Cloud Reference rpk Commands rpk profile rpk profile prompt rpk profile prompt 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. 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 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: 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. prompt: ("--") (hi-white bg-red bold "[%p]") 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 Four modifiers are supported: "bold", "faint", "underline", and "invert". Usage rpk profile prompt [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. Back to top × Simple online edits For simple changes, such as fixing a typo, you can edit the content directly on GitHub. Edit on GitHub Or, open an issue to let us know about something that you want us to change. Open an issue Contribution guide For extensive content updates, or if you prefer to work locally, read our contribution guide . Was this helpful? thumb_up thumb_down group Ask in the community mail Share your feedback group_add Make a contribution rpk profile print-globals rpk profile rename-to