Install the CLI

openetl is OpenETL's command-line tool. You use it to apply pipelines, start syncs, and manage secrets, connectors and users. The CLI calls the API of an OpenETL installation. That installation can run on your computer or on a server in another place.

The CLI runs on macOS and Linux, on amd64 (x86-64) and arm64 processors. There is no build for Windows.

Install with one commandCopy Anchor Link

Run this command in a terminal:

curl -fsSL https://raw.githubusercontent.com/openetl-io/openetl/main/install.sh | sh

Downloading openetl 0.1.0-alpha for darwin/arm64 from https://github.com/openetl-io/openetl/releases/download/v0.1.0-alpha
Installed openetl 0.1.0-alpha at /Users/alex/.local/bin/openetl

The script does these steps:

1. It finds your operating system and processor.
2. It downloads the CLI and checksums.txt from the OpenETL 0.1.0-alpha release on GitHub.
3. It compares the SHA-256 of the download with checksums.txt. If they are different, it stops and installs nothing.
4. It puts openetl in ~/.local/bin, and replaces an earlier openetl there.

If ~/.local/bin is not on your PATH, the script shows a line to add to your shell's profile. Add the line, then open a new terminal.

Check the installation:

openetl version

0.1.0-alpha

To read the script before you run it, download it first:

curl -fsSLO https://raw.githubusercontent.com/openetl-io/openetl/main/install.sh
less install.sh
sh install.sh

Script settingsCopy Anchor Link

The script reads these environment variables:

Put a variable before sh. For example, this command installs into ~/bin:

curl -fsSL https://raw.githubusercontent.com/openetl-io/openetl/main/install.sh | OPENETL_INSTALL_DIR="$HOME/bin" sh

Install by handCopy Anchor Link

Use this procedure if you cannot run a script from the internet. Replace OS with darwin or linux, and ARCH with amd64 or arm64.

1. Download the archive and checksums.txt from the release:

   Copy Text

   curl -fsSLO https://github.com/openetl-io/openetl/releases/download/v0.1.0-alpha/openetl-cli_0.1.0-alpha_OS_ARCH.tar.gz
   curl -fsSLO https://github.com/openetl-io/openetl/releases/download/v0.1.0-alpha/checksums.txt

2. Check the archive's SHA-256:

   Copy Text

   grep ' openetl-cli_0.1.0-alpha_OS_ARCH.tar.gz$' checksums.txt | shasum -a 256 -c

   Copy Text

   openetl-cli_0.1.0-alpha_OS_ARCH.tar.gz: OK

   If the output does not show OK, delete the archive and do not use it. On Linux, sha256sum -c does the same check.

3. Extract the archive, and move openetl to a directory on your PATH:

   Copy Text

   tar -xzf openetl-cli_0.1.0-alpha_OS_ARCH.tar.gz
   mv openetl-cli_0.1.0-alpha_OS_ARCH/openetl ~/.local/bin/

The archive also holds LICENSE, NOTICE and THIRD-PARTY-NOTICES.txt.

Check the signatureCopy Anchor Link

The release workflow signs checksums.txt with Sigstore keyless signing. The signature shows that the file comes from this repository's release workflow. To check it, install cosign 3 or later. Then, in the directory that holds checksums.txt, run:

curl -fsSLO https://github.com/openetl-io/openetl/releases/download/v0.1.0-alpha/checksums.txt.sigstore.json
cosign verify-blob checksums.txt --bundle checksums.txt.sigstore.json \
  --certificate-identity-regexp '^https://github\.com/openetl-io/openetl/\.github/workflows/release\.yml@' \
  --certificate-oidc-issuer https://token.actions.githubusercontent.com

Verified OK

A file whose signature you checked gives the correct SHA-256 for each archive in the release.

Connect to an installationCopy Anchor Link

By default, the CLI calls the API at http://localhost:8080. It reads its API key from .openetl/admin.key in the current directory. To use another installation, set its URL and an API key:

export OPENETL_API_URL=https://openetl.example.com
export OPENETL_API_KEY="$(cat ~/openetl.key)"
openetl whoami

openetl whoami shows the principal that the key belongs to, and its roles. If you do not have an API key, ask an administrator of the installation. Manage access and credentials shows how an administrator makes one.

Each command also takes --api-url and --api-key-file. The openetl CLI lists the commands and these settings.

UpgradeCopy Anchor Link

Use a CLI of the same version as the installation that it calls. The pipeline format and the API can change between alpha releases.

To change the version, run the install command again with OPENETL_VERSION:

curl -fsSL https://raw.githubusercontent.com/openetl-io/openetl/main/install.sh | OPENETL_VERSION=0.1.0-alpha sh

The releases page lists each version and its changes.

RemoveCopy Anchor Link

Delete the program:

rm ~/.local/bin/openetl

The CLI does not keep settings. openetl connector commands that run a package can download connector executables to a cache: ~/Library/Caches/openetl on macOS, or ~/.cache/openetl on Linux. Delete that directory too if it exists.