From b102d1d76a8c5276923b521b24dc949876c6dce8 Mon Sep 17 00:00:00 2001 From: Gemma Shay <75328174+gemma-shay@users.noreply.github.com> Date: Fri, 20 Oct 2023 13:59:11 -0400 Subject: [PATCH] [DOC-9058] Add --vanity-name flag to ccloud docs (#17990) * Add --vanity-name flag to ccloud docs Co-authored-by: Matt Linville (he/him) Co-authored-by: Ryan Kuo <8740013+taroface@users.noreply.github.com> --- src/current/cockroachcloud/ccloud-get-started.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/current/cockroachcloud/ccloud-get-started.md b/src/current/cockroachcloud/ccloud-get-started.md index 75a629e19bf..1d7b860df41 100644 --- a/src/current/cockroachcloud/ccloud-get-started.md +++ b/src/current/cockroachcloud/ccloud-get-started.md @@ -45,11 +45,20 @@ If you are a member of more than one [CockroachDB Cloud organization](https://ww {% include_cached copy-clipboard.html %} ~~~ shell -ccloud auth login --org +ccloud auth login --org {organization-label} ~~~ The organization label is found on the **Settings** page of the CockroachDB Cloud Console. +If your organization has a custom URL, use the `--vanity-name` flag to log in: + +{% include_cached copy-clipboard.html %} +~~~ shell +ccloud auth login --vanity-name {custom-organization-name} +~~~ + +Replace `{custom-organization-name}` with the portion of the custom sign-in URL that follows `/login/`. Do not pass the full custom sign-in URL. + ### Log in to CockroachDB Cloud on a headless server If you are using `ccloud` on a headless machine, use the `--no-redirect` flag to log in. This allows you to log in to CockroachDB Cloud on a different machine, retrieve an authorization code, and enter the code on the headless machine so `ccloud` can complete authentication.