diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud-auth-token.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-auth-token.adoc new file mode 100644 index 0000000000..4736d7944b --- /dev/null +++ b/modules/reference/partials/rpk-cloud/rpk-cloud-auth-token.adoc @@ -0,0 +1,30 @@ += rpk cloud auth token +// tag::single-source[] + +The `rpk cloud auth token` command prints the auth token for the currently selected cloud authentication to stdout. This is useful for piping the token into other commands or scripts that need to authenticate with Redpanda Cloud. For an example, see xref:sql:connect-to-sql/authenticate.adoc[Authenticate to Redpanda SQL]. + +== Usage + +[,bash] +---- +rpk cloud auth token [flags] +---- + +== Flags + +[cols="1m,1a,2a"] +|=== +|*Value* |*Type* |*Description* + +|-h, --help |- |Help for token. + +|--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 xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail. + +|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. + +|-v, --verbose |- |Enable verbose logging. +|=== + +// end::single-source[]