Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Orbita Command Line Interface is a standalone package that can export your whole project from one environment and import the project in another environment.

Table of Contents
excludeRelated Articles

Steps for Mac OS / Linux

Please follow the below document for the steps to follow in Mac Operating System.

  1. Download the zip file orbita-cli-macos (attached).

  2. Unzip the file to a folder (the name will be orbita-cli-macos by default).

  3. Go to the Terminal.

  4. Navigate to the unzipped orbita-cli-macos folder in the terminal. (using cd <filepath>).

  5. Run the below command to save the configuration.

    Code Block
    ./orbita-cli-macos config -sE https://source.orbita.cloud:8443 -dE https://destination.orbita.cloud:8443 -sP 5dbbe3267cb6da5c2ff1278b -dP 5f923dd546a487006fc6867b -sU sourceuser@example.com -dU destinationuser@example.com
  6. To review the configuration data, use this command.

    Code Block
    ./orbita-cli-macos config -l
  7. Use the below code to initiate the export and import of the project.

    Code Block
    ./orbita-cli-macos deploy
  8. You will be prompted for the source password and then the destination password. You dont don't have to input the passwords if you use APIKeys of the source and destination users.

  9. You will again be prompted to continue. Type y and press Enter.

  10. The project will be exported from the source environment and imported to the destination environment.

Help command ./orbita-cli-macos config -h

Image Added

You have to use the commands in the below order. The below example is with APIKeys.

Code Block
./orbita-cli-macos config -sE https://source.orbita.cloud:8443 -dE https://destination.orbita.cloud:8443 -sP 5a158f6422d2ab0f0036df81 -dP 5f71ff12422d1e006e301d11 -sAPIKEY Nzc1MTI4MDAtMDE5ZS0xMWViLThmY2YtNTMzNDBjMzBkM2Fk -dAPIKEY ZDU0ZjU5ZTAtMDE5ZS0xMWViLWI2YTQtMTcxZjg1NjAyM2I3
Code Block
./orbita-cli-macos config -l
Code Block
./orbita-cli-macos deploy

type y and press Enter

Deployment completed.

Generate API Key

URL: /api/users/:id/apikey/key

Method: PUT

Response: User details with API Key

Only Admin users can get the API keys.

Appendix

Argument

Argument type

Description

-u

<username>

The specified username will be used for both source/destination

-sU

<username>

Specify source username

-dU

<username>

Specify destination username

-sE

<baseURL>

Specify source base URL

-dE

<baseURL>

Specify destination base URL

-sP

<projectID>

Specify source project ID

-dP

<projectID>

Specify destination project ID

-sAPIKEY

<APIKEY>

Specify source API Key

-dAPIKEY

<APIKEY>

Specify destination API Key

-l

<information>

Display the Configuration Data

-pWD

<password>

The specified password will be used for both source/destination

-sPWD

<password>

Specify source username

-dPWD

<password>

Specify destination username

Attachments

CLI file for Mac OS

View file
nameorbita-cli-macos.zip

CLI file for Linux OS

View file
nameorbita-cli-linux.zip

Related Articles

Filter by label (Content by label)
showLabelsfalse
max5
showSpacefalse
cqllabel = "experience-manager"