From 6331247471061dc952533a4a7f5149ae1b254d8d Mon Sep 17 00:00:00 2001 From: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com> Date: Tue, 18 Oct 2022 15:01:47 -0700 Subject: [PATCH] fix: edit messages for "sf alias set" --- messages/alias.set.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/messages/alias.set.md b/messages/alias.set.md index e7fe335e..507899ff 100644 --- a/messages/alias.set.md +++ b/messages/alias.set.md @@ -1,30 +1,36 @@ # summary -Set one or more aliases. +Set one or more aliases on your local computer. # description -You can associate an alias with only one value at a time. If you’ve set an alias multiple times, the alias points to the most recent value. +Aliases are user-defined short names that make it easier to use the CLI. For example, users often set an alias for a scratch org usernames because they're long and unintuitive. Check the --help of a CLI command to determine where you can use an alias. -# examples +You can associate an alias with only one value at a time. If you set an alias multiple times, the alias points to the most recent value. Aliases are global; after you set an alias, you can use it in any Salesforce DX project on your computer. + +Use quotes to specify an alias value that contains spaces. You typically use an equal sign to set your alias, although you don't need it if you're setting a single alias in a command. -- <%= config.bin %> <%= command.id %> +# examples - Set an alias for a scratch org username: - <%= config.bin %> <%= command.id %> my-alias=username@example.com + + <%= config.bin %> <%= command.id %> my-scratch-org=test-sadbiytjsupn@example.com - Set multiple aliases with a single command: - <%= config.bin %> <%= command.id %> my-alias=username@example.com my-other-alias=devhub@example.com + + <%= config.bin %> <%= command.id %> my-scratch-org=test-sadbiytjsupn@example.com my-other-scratch-org=test-ss0xut7txzxf@example.com - Set an alias that contains spaces: + <%= config.bin %> <%= command.id %> my-alias='alias with spaces' -- Single aliases can be set without an equal sign - <%= config.bin %> <%= command.id %> my-alias username@example.com +- Set a single alias without using an equal sign: + + <%= config.bin %> <%= command.id %> my-scratch-org test-ss0xut7txzxf@example.com # error.ArgumentsRequired -You must provide one or more aliases to set. Use the --help flag to see more examples. +You must provide one or more aliases to set. Use the --help flag to see examples. # error.ValueRequired