Get started with
Collibra CLI

The Collibra Command Line Interface is a set of tools aimed at Collibra developers. It helps you get started with and manage your workflow and REST API projects. It also helps you develop more efficiently on a daily basis, by showcasing best practices, allowing you to upload a complete workflow to your development environment.

Install Collibra CLI

Prerequisites

• Java 8
• Collibra version 5.7

Windows installation

1. Ensure you have set the java_home variable.
2. Download the Collibra CLI ZIP file.
3. Extract the content in a folder of your choosing, for example C:\Users\<username>\My Applications\CLI.

4. Add the path to the Collibra CLI bin folder to the system environment Path variable.

   C:\Users\<username>\My Applications\CLI\collibra-cli-boot-<version>\bin

   

macOS installation

1. Download the Collibra CLI ZIP file.
2. Extract the content in a folder of your choosing, for example in the Applications folder.
3. Open the Terminal application.
4. Run the following command: sudo nano /etc/paths.
5. Add the path to the Collibra CLI bin folder.

   /Users/<username>/Applications/collibra-cli-boot-<version>/bin

Linux installation

1. Download the Collibra CLI ZIP file.
2. Extract the content in a folder of your choosing, for example in the Applications folder.

3. Open a terminal:

   • For Bash shell:

     1. Edit ~/.bashrc using vi for example.

     2. Add

        PATH=<your_folder>/collibra-cli-boot-<version>/bin:$PATH
        export PATH

        Where <your_folder> is the path the to the folder you extracted the content in.

     3. Save the file.
     4. Restart your terminal application.

   • For C shell:

     1. Edit ~/.bashrc using vi for example.

     2. Add

        PATH=<your_folder>/collibra-cli-boot-<version>/bin:$PATH
        export PATH

        Where is the path the to the folder you extracted the content in.

     3. Save the file.
     4. Restart your terminal application.

Update Collibra CLI

To update Collibra Command Line Interface to a new version, replace the collibra-cli folder with the updated one.

Start the application

Open your terminal application, for example Command Prompt on Windows or Terminal on macOs.

Type collibra-cli and press the enter key.

Basic commands

See all available commands

The most basic command is help. It displays all the available commands.

Connect to a Collibra environment

1. Press the tab key repeatedly until you have collibra-set selected such as in the following image:
2. Press enter to confirm your selection.
3. Press tab to see the available parameters: -url and --url.

   A one dash prefix indicates a shortened version of the parameter while a double dash prefix indicates the long version.

4. Enter the base URL of your Collibra environment and confirm by pressing the enter key.
5. Follow the instructions to sign-in.