Install Tailer SDK

This page contains instructions for installing and configuring Tailer SDK, and logging in to Tailer Platform.

📦 Install the Tailer SDK package

To install the Tailer SDK package:

  1. Run the following command in Command Prompt (Windows) or in a terminal (macOS/Linux):

    pip3 install tailer-sdk
  2. When the installation is done, make sure it was successful by checking Tailer SDK version:

    tailer version

The Tailer SDK version and help should display.

At any time, you can now display the Tailer SDK help with the following command:

tailer help

⚙️ Configure Tailer SDK

When the installation is complete, you can proceed with the configuration of Tailer SDK:

  1. To launch the configuration, run the following command:

    tailer config
  2. You'll be prompted to answer a series of questions. Use the values listed in the table below. Directly press Enter if the suggested value is right.


    Email address

    Provide the email address you want to use to connect to Tailer SDK.

    Tailer Firebase API key


    Tailer Firebase authentication domain

    Tailer API Endpoint

    For Europe: For the USA:

    SSL verification

    Specify if you want to enable SSL verification (y) or not (n). Default is y.

    Custom client SSL verification

    Specify if you want to use custom client SSL verification (y) or not (n). Default is n.

    Full path to the SSL certificate

    This question only displays if you answered y at the previous question. Provide your custom SSL certificate in PEM format (e.g. "C:\My Certificates\cert_XYZ.pem").

    Automatic deployment of STS and STT associated Cloud Functions

    If you want to deploy Cloud Functions (CF) by default when you deploy a configuration, answer yes (y). You can choose to skip the CF deployment when you deploy a configuration using the --no-gcp-cd-deploy flag: tailer --no-gcp-cf-deploy deploy configuration my_conf.json.

    CF are a key componant for storage-to-storage (STS) and storage-to-tables (STT) operations. They listen Google Cloud Storage events and trigger runs. An operation can't be operative without it. But if the Cloud Function for a STS or STT is already deployed, then it's not mandatory to deploy it again. As this deployment can take a few minutes, you can skip this step if needed.

  3. Once you've answered all the questions, close and restart your terminal for changes to be implemented.

  4. Optionally, you can set the Tailer Public key for data encryption.

👤 Log in to Tailer Platform

Once the installation and the configuration are done, you need to log in to Tailer Platform to be able to access the Tailer API.

  1. To log in, run the following command:

    tailer auth login
  2. Provide the same email address as before as suggested, and the password of your Tailer Platform account. If you don't have an account yet, you can enter a new password and press Enter. You can reset your password later if needed (see below). If you already have a Tailer Platform account, your login is successful and you can stop here. If not, follow the steps below to sign in.

  3. Confirm that you want to create a Tailer Platform account by entering y.

  4. Provide again the same email address and the password of your choice.

  5. Confirm your email address by clicking on the link sent to your email address.

⚠️ If this is your first connection with command line, please inform your Valiuz contact so that he accepts the connection. Otherwise, the first time you deploy, you'll get an expired token error. Then, run the command a second time to validate your account. For mor informations, send an email to .

The account is successfully created and you're now logged in to Tailer Platform! 🎉

You can now proceed with the configuration of Google Cloud Platform.

🔓Reset password

If you forgot your password, you can reset it with the Tailer SDK.

  1. To reset your password, run the following command:

    tailer auth reset-password
  2. An email is sent to the email address you have configured. Don't forget to check your spam folder.

  3. Follow the link in the email to rest your password. Please note that this link will expire after a reasonable amount of time. You can get a new link by running again the command above.

  4. After you have reseted your password, please run 'tailer auth login' to log in again to Tailer Platform and provide the new password.

Last updated