rpk profile

Clear the current profile. This command clears the current profile, which can be useful to unset a production cluster profile.

Create a new rpk profile with connection settings for a Redpanda cluster.

Print the current profile name. This is a tiny command that simply prints the current profile name, which may be useful in scripts, or a PS1, or to confirm what you have selected.

Delete an rpk profile. Deleting a profile removes it from the rpk.yaml file.

Edit an rpk profile. This command opens your default editor to edit the specified profile, or the current profile if no profile is specified.

Edit rpk globals. This command opens your default editor to edit the rpk global configurations.

List rpk profiles.

Print rpk profile configuration. If no name is specified, this command prints the current profile as it exists in the rpk.yaml file.

Print rpk global configuration.

Prompt a profile name formatted for a PS1 prompt. This command prints ANSI-escaped text per your current profile’s prompt field.

Rename the current rpk profile. This command renames the currently active profile to the specified name.

Set a configuration field in the current rpk profile.

Set rpk globals fields. This command takes a list of key=value pairs to write to the global config section of rpk.yaml.

Switch to a different rpk profile, making it the active profile for subsequent rpk commands.

Validate profile configuration and detect common issues.

string

Redpanda or rpk config file; default search paths are ~/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml.

stringArray

Override rpk configuration settings; -X help for detail or -X list for terser detail.

bool

Ignore rpk.yaml and redpanda.yaml; use default settings.

string

rpk profile to use.

bool

Enable verbose logging.