alias Commands

Description for alias list

Aliases are global, which means that you can use all the listed aliases in any Salesforce DX project on your computer.

Examples for alias list

List all the aliases you've set:

1sf alias list

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

Aliases for alias list

1force:alias:list

Description for alias set

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.

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.

Examples for alias set

Set an alias for a scratch org username:

1sf alias set my-scratch-org=test-sadbiytjsupn@example.com

Set multiple aliases with a single command:

1sf alias set my-scratch-org=test-sadbiytjsupn@example.com my-other-scratch-org=test-ss0xut7txzxf@example.com

Set an alias that contains spaces:

1sf alias set my-alias='alias with spaces'

Set a single alias without using an equal sign:

1sf alias set my-scratch-org test-ss0xut7txzxf@example.com

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

Aliases for alias set

1force:alias:set

Description for alias unset

Aliases are global, so when you unset one it's no longer available in any Salesforce DX project.

Examples for alias unset

Unset an alias:

1sf alias unset my-alias

Unset multiple aliases with a single command:

1sf alias unset my-alias my-other-alias

Unset all aliases:

1sf alias unset --all [--no-prompt]

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-a | --all

Optional

Unset all currently set aliases.

Type: boolean

-p | --no-prompt

Optional

Don't prompt the user for confirmation when unsetting all aliases.

Type: boolean

Aliases for alias unset

1force:alias:unset