Download your Atomic project via CLI

This is for:


A generated Atomic search page is a great starting point, whether you created it using the Simple builder in the Coveo Administration Console or locally using the Coveo CLI. In many cases, however, your search page will need to be further customized by developers.

You can work locally with a page that was created in the Administration Console by downloading it using the CLI. There are two ways to do this.

Option 1: Copy the command from the Administration Console

  1. On the Search Pages (platform-ca | platform-eu | platform-au) page of the Administration Console, select the project that you want to download.

  2. On the Action bar, click Download.

  3. You will be prompted to make sure that the Coveo CLI is installed on your machine. Click Continue.

  4. In the modal that appears, click copy, and then click Finish.

  5. Paste the command in your terminal and run it to download your project.

Get the download command from the Administration Console

Option 2: Use the CLI command prompt

  1. Run coveo auth:login to connect to your organization.


    If you have more than one Coveo organization, you can add -o=<YOUR_ORG_ID> to connect to a specific one.

  2. Run coveo ui:create:atomic <YOUR_PROJECT_NAME> without specifying a page ID. You’ll need to choose one of the following options:

    • Start from scratch

    • Select one of the Atomic search pages that exist in your organization

  3. Choose the one you want and select Enter. The CLI will then download your project.

Download your project in the CLI