Installing SDF

Our install script will first check your operating system and architecture, then install the latest version of SDF and its dependencies for your system. The sdf command will also be added to your path.

curl -LSfs https://cdn.sdf.com/releases/download/install.sh | sh -s

Verify Installation

To verify that SDF is installed correctly, run the following command:

  sdf --help

SDF: A fast SQL compiler, local development framework, and in-memory analytical database

Usage: sdf [OPTIONS] <COMMAND>

Commands:   new      Create a new sdf workspace   clean    Remove artifacts that sdf has generated in the past   compile  Compile models   run      Run models   test     Test your models   stats    Statistics for your data   report   Report code quality   check    Check code quality   lineage  Display lineage for a given table and/or column   push     Push a local workspace to the SDF Service   system   System maintenance, install and update   auth     Authenticate CLI to services like SDF, AWS, OpenAI, etc   man      Display reference material, like the CLI, dialect specific functions, schemas for authoring and interchange   dbt      Initialize an sdf workspace from an existing dbt project   exec     Execute custom scripts   help     Print this message or the help of the given subcommand(s)

Options:       —log-level <LOG_LEVEL>           Set log level                      [possible values: trace, debug, info, warn, error]

      —log-file <LOG_FILE>           Creates or replaces the log file

      —log-form <LOG_FORM>           Set the log format; default flat

          Possible values:           - flat:   Writes nd-json, compact, no nested objects           - nested: Writes nd-json, compact, nested objects           - pretty: Writes nd-json, pretty, nested objects

  -h, —help           Print help (see a summary with ‘-h’)

  -V, —version           Print version

Use an editor like Visual Studio Code for better auto-complete and development hints.

YML Extension For VSCode

If you’re using VSCode, please download the official Red Hat YML extension which can provide intelisesnse support for SDF”s YML schema. This extension will show configuration errors, options, and more.

yml-extension-support

The JSON schemas for SDF’s .sdf.yml extension are published on the schema store and in the sdf-cli repository.

SDF Versions and Updating

From time to time, it may be necessary to update the CLI to get the latest and greatest features, or to connect to SDF Cloud Services.

If you’ve already installed SDF, you can update to the latest version by running the command below. By default, this will update to the latest version of the CLI.

sudo sdf system update

You can check the currently installed version of your CLI with

sdf --version

Uninstalling SDF

If you ever need to uninstall SDF, simply run

sudo sdf system uninstall

Info

SDF is currently supported on the following platforms. The executable is small (<75mb), but heavily parallelized. As such, SDF’s resource consumption is dependent entirely on your data processing requirements.

PlatformsSupported
Linux Intel X86-64✔️
Linux Arm AARCH-64✔️
Apple Intel X86-64✔️
Apple Arm AARCh-64✔️
Windows Intel X86-64
Web-Assembly

For a complete list of releases, please see the official github releases page.

SDF is hardware optimized. For best performance, download the version that matches your chipset.