The CLI edge command

Current version: 10.3

The Sitecore Experience Edge plugin provides the edge command. The command has subcommands that help you authenticate within an organization, list, and switch tenants, and manage API keys for your Experience Edge GraphQL endpoint.

To install the plugin, run the following command:

RequestResponseshell
dotnet sitecore plugin add -n Sitecore.Edge.DevEx.Sitecore.Plugin

Usage

You can use the edge command as follows:

RequestResponseshell
dotnet sitecore edge [options] 

To use one of the cloud subcommands:

RequestResponseshell
dotnet sitecore edge [subcommand] [options]

Subcommands have subcommands (operations) and options of their own. For detailed usage information, refer to the documentation of each edge subcommand.

Options

The edge command has the following option:

Option

Description

-?, -h, --help

When provided, the CLI displays developer help and usage information about the command.

Subcommands

You can use the following edge subcommands:

  • login - authenticates you through the CLI with an organization, granting you the necessary access tokens and claims.

    • You can use the --aud, --audience option to specify the OAuth audience of the Edge tenant. This option is necessary for older Edge tenants that use an audience which includes the tenant name, such as https://delivery.sitecore.cloud/tenant-name.

  • tenant - provides subcommands that help you find out what the current selected Edge tenant is, list all available Edge tenants of the organization the user is logged in to, and change the Edge tenant used for upcoming operations.

  • apikey - provides subcommands for working with the Edge API keys.

Do you have some feedback for us?

If you have suggestions for improving this article,