Skip to main content

Install TARE CLI

This guide covers installation of the three TARS CLI tools: admin (administrative operations), tars (TARS operations), and migrator (database migration). All CLIs are distributed as standalone binaries for macOS (ARM64) and Linux (AMD64).


By the end of this guide:

  • The admin, tars, and migrator binaries are installed on the local machine.
  • Each binary is verified against its published SHA256 checksum.
  • Each CLI responds to --version from the shell PATH.

Plan for 5--10 minutes.

Quick install

The installer script detects the OS and architecture, downloads the latest version, and installs to ~/.tars/bin:

# Install all CLIs
curl -fsSL https://tools.tetrate.ai/latest/install.sh | bash

# Install to custom directory
curl -fsSL https://tools.tetrate.ai/latest/install.sh | bash -s -- --dir /usr/local/bin

# Install specific CLI only
curl -fsSL https://tools.tetrate.ai/latest/install.sh | bash -s -- --cli admin

Manual installation

For manual downloads, simplified names are available:

# macOS ARM64
curl -LO https://tools.tetrate.ai/latest/admin-darwin-arm64.tar.gz
tar -xzf admin-darwin-arm64.tar.gz
chmod +x admin-darwin-arm64
sudo mv admin-darwin-arm64 /usr/local/bin/admin

# Linux AMD64
curl -LO https://tools.tetrate.ai/latest/admin-linux-amd64.tar.gz
tar -xzf admin-linux-amd64.tar.gz
chmod +x admin-linux-amd64
sudo mv admin-linux-amd64 /usr/local/bin/admin
note

The simplified filenames (e.g., admin-darwin-arm64.tar.gz) always point to the latest version. For specific commit versions, check the manifest for URLs with commit SHAs.

Verification

The SHA256 checksum is downloaded and verified before installation:

# Get URLs from manifest
MANIFEST=$(curl -s https://tools.tetrate.ai/latest/manifest.json)

# Example: Verify admin CLI for macOS ARM64
ARTIFACT=$(echo "$MANIFEST" | jq -r '.artifacts[] | select(.name == "admin") | .platforms[] | select(.os == "darwin" and .arch == "arm64")')
URL=$(echo "$ARTIFACT" | jq -r '.url')
CHECKSUM_URL=$(echo "$ARTIFACT" | jq -r '.checksum_url')

# Download
curl -LO "$URL"
curl -LO "$CHECKSUM_URL"

# Verify (extract filename from URL)
FILENAME=$(basename "$URL")
shasum -a 256 -c "${FILENAME}.sha256"

If the output shows OK, the download is verified and safe to install.

Verify installation

After installation, each CLI is checked:

# Check admin CLI
admin --version

# Check tars CLI
tars --version

# Check migrator CLI
migrator --version

Download locations

Latest builds

The latest/ directory always contains the most recent build from the main branch:

  • Base URL: https://tools.tetrate.ai/latest/
  • Naming: {cli}-{version}-{os}-{arch}.tar.gz
  • Checksums: {cli}-{version}-{os}-{arch}.tar.gz.sha256
  • Manifest: https://tools.tetrate.ai/latest/manifest.json

Available files:

  • admin-{version}-darwin-arm64.tar.gz - Admin CLI for macOS ARM64
  • admin-{version}-linux-amd64.tar.gz - Admin CLI for Linux AMD64
  • tars-{version}-darwin-arm64.tar.gz - TARS CLI for macOS ARM64
  • tars-{version}-linux-amd64.tar.gz - TARS CLI for Linux AMD64
  • migrator-{version}-darwin-arm64.tar.gz - Migrator for macOS ARM64
  • migrator-{version}-linux-amd64.tar.gz - Migrator for Linux AMD64

Commit-specific builds

Builds are also archived by commit hash for stable URLs:

  • Base URL: https://tools.tetrate.ai/builds/{commit}/
  • Example: https://tools.tetrate.ai/builds/abc1234/admin-abc1234-darwin-arm64.tar.gz

Commit-hash URLs are stable, so any specific version remains downloadable.

Release manifest

A JSON manifest provides metadata about the latest release:

curl https://tools.tetrate.ai/latest/manifest.json

The manifest includes:

  • Build timestamp
  • Git commit and branch information
  • Download URLs for all CLIs and platforms
  • Checksum URLs

The manifest supports automation and scripting.

Platform support

CLImacOS ARM64Linux AMD64
admin
tars
migrator

Uninstallation

The binaries are removed from /usr/local/bin:

sudo rm /usr/local/bin/admin
sudo rm /usr/local/bin/tars
sudo rm /usr/local/bin/migrator

Troubleshooting

Permission denied on macOS

A "permission denied" error on macOS indicates the quarantine attribute must be removed:

xattr -d com.apple.quarantine /usr/local/bin/admin
xattr -d com.apple.quarantine /usr/local/bin/tars
xattr -d com.apple.quarantine /usr/local/bin/migrator

Binary not found

/usr/local/bin must be in the PATH:

echo $PATH | grep -q /usr/local/bin || echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

For Zsh, edit ~/.zshrc instead.

Checksum mismatch

If checksum verification fails:

  1. Delete the downloaded file
  2. Download again (the file may have been corrupted)
  3. If it still fails, check the release workflow logs

Getting help

For CLI-specific help:

admin --help
tars --help
migrator --help

For issues or questions, open an issue.