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 haveset thejava_homevariable.
2. Download the Collibra CLI ZIP file.
3. 在你选择的一个文件夹中提取内容,for exampleC:\Users\\My Applications\CLI.

4. Add the path to the Collibra CLIbinfolder to the system environmentPathvariable.

   C:\Users\\My Applications\CLI\collibra-cli-boot-\bin

   

macOS installation

1. Download the Collibra CLI ZIP file.
2. 在你选择的一个文件夹中提取内容,for example in theApplicationsfolder.
3. Open theTerminalapplication.
4. Run the following command:sudo nano /etc/paths.
5. Add the path to the Collibra CLIbinfolder.

   /Users//Applications/collibra-cli-boot-/bin

Linux installation

1. Download the Collibra CLI ZIP file.
2. 在你选择的一个文件夹中提取内容,for example in theApplicationsfolder.

3. Open a terminal:

   • ForBashshell:

     1. Edit~/.bashrcusingvifor example.

     2. Add

        PATH=/collibra-cli-boot-/bin:$PATH export PATH

        Whereis the path the to the folder you extracted the content in.

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

   • ForCshell:

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

     2. Add

        PATH=/collibra-cli-boot-/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 thecollibra-clifolder with the updated one.

Start the application

Open your terminal application, for exampleCommand Prompton Windows orTerminalon macOs.

Typecollibra-cliand press theenterkey.

Basic commands

See all available commands

The most basic command ishelp. It displays all the available commands.

Connect to a Collibra environment

1. Press thetabkey repeatedly until you havecollibra-setselected such as in the following image:
2. Pressenterto confirm your selection.
3. Presstabto see the available parameters:-urland--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 theenterkey.
5. Follow the instructions to sign-in.