Skip to main content Link Search Menu Expand Document (external link)

Installation

Installing the CLI

Using Homebrew

To install the Raito CLI on macOS or Linux, the easiest way is using Homebrew.

Simply execute the following in a terminal window:

$> brew install raito-io/tap/cli

Manual installation

Alternatively, go to the Github releases, find the version you want and go from there. E.g.

$> wget https://github.com/raito-io/cli/releases/download/v0.19.0/raito-0.19.0-darwin_arm64.tar.gz
$> tar -xzvf raito-0.19.0-darwin_arm64.tar.gz
$> ./raito --help

Currently we release for Linux and macOS.

Check installation

To get the version you have installed:

$> raito --version

or an overview of the possibilities of the CLI, execute:

$> raito --help

Find out more about the different actions you can perform with the CLI here. <!– TODO: implement and re-enable documentation For the rest of this installation guide we’ll make sure that everything is working properly.

Connect Raito CLI …

The Raito CLI uses a yaml configuration; an example here. By default it will look for a file called raito.yml in the working directory, or in the ~/.raito directory. See here for more details.

…. to Raito Cloud [optional]

In your raito.yaml file, make sure that the domain, api-user and api-secret are correctly set.

TODO: implement!

To test your connections with Raito Cloud, run the following command:

$> raito connect cloud

If a connection could be established, you should see a message like

Successfully connected to Raito Cloud

… to a data source

We will try to connect to a Snowflake data warehouse in this section. To do this, you’ll need to use the Snowflake connector. It can be automatically downloaded from Github by adding the following configuration to raito.yml

repositories:
  - name: raito-io
    token: "<github_personal_access_token>"

To get more information on how to create a Personal Access Token, consult the Github documentation. When you run the CLI, it will download the Snowflake plugin for the version you’ve specified in connector-version (or latest???) to the ~/.raito/plugins/raito-io folder. Subsequentially the CLI will always first check if the plugin is available in that folder before connecting to Github.

To actually test the connection, make sure the following parameters are specified in your target’s configuration in raito.yml:

sf-account: <e.g. xy123456.eu-central-1>
sf-user: <youruser>
sf-password: <yourpassword>

and then test the connection with

$> raito connect --only-targets snowflake1

If a connection could be established, you should see a message like

Successfully connected to target snowflake1

If that didn’t work, try making a connection through a tool like curl, e.g. from the Snowflake community. –>

Further reading

If you want to know more, go to the CLI section or read about general Raito concepts.