Tailwind Logo

Using Content Hub ONE CLI

Content Hub ONECLI

Published: 2023-09-19

Although Content Hub ONE is a SaaS service, importing and exporting are required for development. In this article, we will introduce a command line tool that can be used for this part of the development process.

Install CLI

Content Hub ONE CLI is available for Windows, macOS and Linux, and is also available for Dokcer. NET 6 must be installed, as this tool is built using .

In order to use the tool on macOS this time, install as follows

PowerShell
brew tap sitecore/content-hub
brew install ch-one-cli

After the installation was completed, I checked the version and found that at the time of writing this blog, I had installed 1.2.0.

chonecli01.png

Log in to Content Hub ONE

The procedure for logging in from the command line is described in the following page.

We will align the values required for logging in with the tool. Open System Settings from the Account menu in the upper right corner of the administration page, and you will see the following screen. This screen shows mostly keys and other information, so we have cut that section out.

chonecli02.png

From this screen, organization-id and tenant-id can be obtained.

Next, click on Integration > OAuth client on the menu screen to open the page to browse client credentials.

chonecli03.png

From this page, you can check client-id and client-secret.

All that remains is to run it on the command line, which is actually the part at the bottom of this page that explains the comadon line.

chonecli04.png

Clicking on the copy icon here will save all the values to the clipboard in a set form, so you can run it by simply pasting it into a terminal or similar. The result of the execution will show you whether or not you were able to connect to the tenant and whether or not the login was successful.

chonecli05.png

More details can be found in the following pages.

Serialize

We would like to actually serialize the content types, content, and media that we have created in Content Hub ONE and create the data at hand.

The first step is to create the folder where the serialization will take place. This step can be skipped, but in that case, it will work with the folder where you are executing the command. We want to keep the data we are serializing together in a folder, so we executed the following in this case.

PowerShell
ch-one-cli serialization initialize -f serialization

This will create a folder as shown below.

chonecli06.png

Go to the folder you created and pull to get the Blog content type.

PowerShell
cd serialization
ch-one-cli serialization pull content-type --id "Blog"

This is all we have in this case because we only created one, but you can also use wildcards to get them.

Next, content is retrieved. In this case, since we are creating two contents, we specify the content type and retrieve all data.

powershell ch-one-cli serialization pull content-item --content-type "Blog" --id "*"

Finally, retrieve the media file.

powershell ch-one-cli serialization pull media --id "*"

Everything is now on file.

chonecli07.png

Return serialized data

Since the amount of data we are creating is still small, we will delete all the data in Content Hub ONE and send data to it by push. First, when deleting, we will unpublish content that has already been published and make it private, then delete the content, media, and content type.

The first step is to return the media to the empty Content Hub ONE.

PowerShell
ch-one-cli serialization push media --id "*"

You can see that the files have been restored from the empty state of the media.

chonecli08.gif

In a similar procedure, data is sent by push in the order of content type, then content.

powershell ch-one-cli serialization push content-type --id "Blog" ch-one-cli serialization push content-item --content-type "Blog" --id "*"

The content was successfully restored. In this case, since everything is uploaded as a Draft, it is necessary to publish it separately.

chonecli09.png

For more detailed instructions, please refer to the following pages for use.

Summary

A convenient command line makes it possible to export and import the data you have created. The ability to manage the data as code makes it possible to manage the data in conjunction with Next.js and other projects.

Tags