Skip to content

spo hubsite register

Registers the specified site collection as a hub site

Attention

This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.

Usage

spo hubsite register [options]

Options

Option Description
--help output usage information
-u, --url <url> URL of the site collection to register as a hub site
-o, --output [output] Output type. json|text. Default text
--verbose Runs command with verbose logging
--debug Runs command with debug logging

Important

Before using this command, log in to a SharePoint Online site, using the spo login command.

Remarks

To register a site collection as a hub site, you have to first log in to a SharePoint site using the spo login command, eg. spo login https://contoso.sharepoint.com.

If the specified site collection is already registered as a hub site, you will get a This site is already a HubSite. error.

Examples

Register the site collection with URL https://contoso.sharepoint.com/sites/sales as a hub site

spo hubsite register --url https://contoso.sharepoint.com/sites/sales

More information