Satori-CLI

The Satori CLI enables you to access all of your available datasets from the command line, including both your personal datasets as well as datasets that are made available to you because they are open to groups and teams of which you are already a member. You can request access to read, write or administer datasets.

Overview

• Satori-CLI
  • Overview
  • Installation
    • Install script (Recommended)
    • Other install methods
      • Windows
        • Manual install
        • SCOOP
      • Mac
        • Homebrew
  • first time use
  • Supported datastores
  • Usage
    • Run
      • Supported Tools
      • Arguments
      • psql
      • mongosh
      • s3
      • DBT
        • Invoking DBT
    • PgPass
    • DataGrip
    • AWS
      • Arguments
    • Login
      • Arguments:
  • Contributing

Installation

Install script (Recommended)

curl -s https://raw.githubusercontent.com/SatoriCyber/satori-cli/main/scripts/install_script.sh | bash

For windows to work WSL must be installed.

Other install methods

Windows

Manual install

You can download the latest version from the releases page Download the windows zip file. Unzip the files:

Expand-Archive <ZIP FILE> -DestinationPath <DESTINATION PATH>

Move the satori exe to a permanent location (e.g., C:\Program Files\Satori) Add the exe to your path, in your $profile add the following line:

$env:Path += ";C:\Program Files\Satori"

Add the auto-complete file to your scripts directory (e.g., ~\Documents\WindowsPowerShell\Scripts)

Add to your profile to enable auto-complete:

. ~\Documents\WindowsPowerShell\Scripts\satori_auto_complete.ps1
Import-Module ~\Documents\WindowsPowerShell\Scripts\satori_auto_complete.ps1

SCOOP

To install using scoop, run the following command:

scoop bucket add satori  https://www.github.com/satoricyber/satori-cli
scoop install satori/satori_cli

Enable auto-complete Add the following line to you powershell profile (e.g., ~\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1):

. <SCOOP-APP-DIR>\satori_cli\current\satori_auto_complete.ps1
Import-Module <SCOOP-APP-DIR>\satori_cli\current\satori_auto_complete.ps1

Mac

Homebrew

Mac only

brew tap satoricyber/satori
brew install satori_cli
source "$(brew --prefix)/etc/bash_completion.d/satori_auto_complete.zsh"

first time use

To enable auto-complete, run the login command.

Supported datastores

• Athena
• MongoDB
• PostgreSQL
• S3
• Redshift
• CockroachDB
• Greenplum

Usage

Run

Invokes a CLI tool using Satori authentication. If the credentials already exist, the CLI tool loads them from the cache. If the credentials do not already exist then they are invoked and authenticated.

Supported Tools

The Satori CLI supports psql, dbt, mongosh

Arguments

• --no-persist - Does not persist the credentials to the cache.
• --no-launch-browser - Do not launch the browser to authenticate, instead print the URL to the terminal.
• --refresh - obtain new credentials and datastores information from the server, even if they already exist in the cache.
• <datastore name> - The datastore name.
• -- - Pass the rest of the arguments to the tool.

psql

Triggers a psql session with the given datastore and database.

Example

  satori run psql <datastore name> <database>

Passing additional args to the tool

satori run psql <datastore name> <database> -- -c 'select 1'

mongosh

Triggers a mongosh session with the given datastore.

satori run mongosh <datastore name>

s3

Execute s3 command.

satori run s3 <datastore name> -- <s3 command>

Example

  satori run s3 <datastore name> -- ls

DBT

The Satori CLI invokes the the DBT tool with the Satori credentials for a specific Satori dataset. This is a requires process for running the analytics models via Satori.

Invoking DBT

Just like DBT, the Satori CLI reads the dbt_project.yml file and then looks up the target profile. It then searches for the profiles.yml file in the following order:

1. The --profiles-dir command line argument.
2. The DBT_PROFILES_DIR environment variable.
3. Current working directory
4. The ~/.dbt/profiles.yml file.

Same as DBT selection

If the --target option is used, the Satori CLI then uses the target provided. If it does not use the target provided, it will use the default target.

The Satori CLI then changes the username and password to an environment variable that is passed to DBT (SATORI_USERNAME, SATORI_PASSWORD). The Satori CLI then creates a backup of the file before modification.

Arguments

• --target - The target to use. If not provided, the default target will be used.
• --profiles-dir - The directory looks for the profiles.yml file. If not provided, the default yml will be used.
• -- - Pass the rest of the arguments to the tool.

Examples

satori run dbt debug

Specify the target

satori run dbt debug --target dev

Example

  satori run psql <datastore name> <database>

PgPass

Generates a pgpass file from all datastore information.

satori pgpass

DataGrip

DataGrip can call the Satori CLI before opening a connection to a database to retrieve credentials and make them available to DataGrip automatically.

To automate the process of obtaining credentials when using DataGrip follow these steps:

1. Select the Options tab of the database connection properties.
2. In the Before connection`` section, select the +`` button and choose Run external tool.
3. Select the + button to add a new external tool.
4. In the Name field enter Satori CLI.
5. In the Program field enter satori.
6. In the Arguments field enter the arguments for Satori CLI, depending on the type of database connection you are configuring. For example, for PostgreSQL or Redshift use pgpass.
7. Click OK to save your settings

AWS

Generates aws profiles.

Each datastore will have its own profile. The list of datastores to profile mapping will be printed at the end.

satori aws
The following profiles have been generated:
    athea-prod: profile satori_athena_939918
    s3-stage: profile satori_s3_438177

then you can use aws cli with the profile

aws s3 ls --profile satori_s3_438177

Arguments

• --refresh - obtain new credentials and datastores information from the server, even if they already exist in the cache.
• --no-launch-browser - Do not launch the browser to authenticate, instead print the URL to the terminal.

Login

Obtain credentials from the Satori data portal without the need to use a browser.

Example: Display the credentials in the terminal (this can be used to integrate with other tools):

satori login --display

Arguments:

• --display - Print the credentials to the terminal, with no persistence.
• --refresh - obtain new credentials and datastores information from the server, even if they already exist in the cache.
• --format - Format of the output,
  • csv (default).
  • json,
  • yaml,
• --no-launch-browser - Do not launch the browser to authenticate, instead print the URL to the terminal.

Contributing

See CONTRIBUTING.md for contribution guidelines.