Skip to main content
/ Docs
Quickstart API SDKs

Installation & Setup

Install and configure the Trix CLI on macOS, Linux, and Windows.

Updated

Installation

The Trix CLI is available for macOS, Linux, and Windows. Choose your platform below:

macOS

# Using Homebrew (current)
brew install devghost/taps/trix

# Planned rename (ADR-144): brew install trixdb/taps/trix

# Or download directly
curl -sSL https://install.trixdb.com | sh

# Verify installation
trix version

Linux

# Download and install (recommended)
curl -sSL https://install.trixdb.com | sh

# Or download the binary manually
wget https://github.com/trix/trix-cli/releases/latest/download/trix-linux-amd64
chmod +x trix-linux-amd64
sudo mv trix-linux-amd64 /usr/local/bin/trix

# Verify installation
trix version

Windows

# Using Scoop (current)
scoop bucket add trix https://github.com/devghost/scoop-bucket
scoop install trix

# Planned rename (ADR-144): scoop bucket add trix https://github.com/trixdb/scoop-bucket

# Verify installation
trix version

The installation script automatically adds Trix to your PATH. You may need to restart your terminal for changes to take effect.

First Run Setup

After installation, run the interactive setup wizard:

# Interactive setup wizard
trix init

# The wizard will:
# 1. Check for updates
# 2. Prompt for authentication
# 3. Configure default settings
# 4. Set up shell completion (optional)
# 5. Test the connection

The init command guides you through the entire setup process. Highly recommended for first-time users!

Shell Completion

Enable tab completion for your shell to make the CLI easier to use:

Bash 
# Add to ~/.bashrc
source <(trix completion bash)

# Or install permanently
trix completion bash > /etc/bash_completion.d/trix
Zsh 
# Add to ~/.zshrc
source <(trix completion zsh)

# Or add to fpath
trix completion zsh > "${fpath[1]}/_trix"
Fish 
# Add to Fish completions
trix completion fish > ~/.config/fish/completions/trix.fish
PowerShell 
# Add to $PROFILE
trix completion powershell | Out-String | Invoke-Expression

Shell completion provides dynamic suggestions for commands, spaces, memory IDs, and tags. Restart your shell after enabling completion.

Updating the CLI

# Check for updates
trix version --check

# Update to latest version
trix update

# View changelog
trix open changelog

Uninstalling

# Uninstall CLI (keeps config and data)
trix uninstall

# Or remove everything including config
trix uninstall --purge

# Manual removal
# macOS/Linux: rm /usr/local/bin/trix
# Windows: scoop uninstall trix

Uninstalling the CLI does not delete your memories or account. It only removes the CLI tool itself and optionally your local configuration.

Troubleshooting

Permission denied

If you get permission errors during installation:

# Linux/macOS: Use sudo for system-wide install
sudo curl -sSL https://install.trixdb.com | sh

# Or install to user directory
curl -sSL https://install.trixdb.com | sh -s -- --prefix ~/.local

Command not found

If trix is not found after installation:

# Check if trix is in PATH
which trix

# Add to PATH (Linux/macOS)
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# Windows: Add to PATH via System Properties

Diagnostic tool

# Run diagnostics
trix doctor

# Shows:
# - CLI version
# - API connectivity
# - Authentication status
# - Configuration issues
# - Network connectivity

Next Steps